【待评审】资源协作接口OpticalModule新增Item属性和相应redfish,Rest资源

Interface SIG Interface评审
1

背景

提供北向接口查询光模块的BOM编码信息

关联ISSUE

整体方案

  1. 资源协作接口bmc.kepler.Systems.OpticalModule从BMA获取光模块BOM编码，新增Item属性

  2. redfish资源Transceivers由此新增Item属性

  3. BMCWeb界面由此展示网口光模块BOM编码

评审点

  1. 资源协作接口OpticalModule新增Item属性

  2. redfish资源Transceivers新增Item属性 （GET接口）

  3. web_backend对应URI下新增Item字段

详细描述

评审点1：资源协作接口OpticalModule新增Item属性

资源协作接口: bmc.kepler.Systems.OpticalModule下新增Item属性

资源path：/bmc/kepler/Systems/:SystemID/NetworkAdapters/:ID/Ports/:ID/OpticalModule

资源interface: bmc.kepler.Systems.OpticalModule

新增属性

属性名称 签名 只读 变化通知 属性描述 访问权限 属性来源 持久化类型 易变属性
Item v true false 光模块BOM编码 R：ReadOnly BMA获取 无需持久化 false

评审点2：redfish资源Transceivers新增Item属性 （GET接口）

资源Uri: /redfish/v1/Chassis/:chassisid/Transceivers/OpticalModule_{opticalid}

属性评审点：

属性名 类型 示例/取值约束 readonly 易变属性 实现 PATCH 操作权限 描述
Item string “34061089” true 否 否 ReadOnly 光模块BOM编码

Get响应示例

{
    "@odata.context": "/redfish/v1/$metadata#HwTransceiver.HwTransceiver",
    "@odata.id": "/redfish/v1/Chassis/1/Transceivers/OpticalModule_PCIeCard6(SP235)Port1",
    "@odata.type": "#HwTransceiver.v1_0_0.HwTransceiver",
    "Name": "OpticalModule",
    "Id": "OpticalModule_PCIeCard6(SP235)Port1",
    ...
    "Item": "34061089",
    ...
}

评审点3：web_backend对应URI下新增Item字段
接口: /UI/Rest/System/NetworkAdapter/:adapterid/NetworkPorts/:portnum

接口类型: GET

新增字段

属性名称 属性说明 属性类型
Item 光模块BOM编码 string

RspBody响应体示例：

{
    OpticalModule : {
        "Item" : "34061089"  
        ...
    }
}

web示例：

BOM web前端_2
BOM web前端_21198×435 73.4 KB

是否准备好AI预审

是

评审结论

遗留问题粗体文本

2

预审答案内容由AI生成，仅供参考：

帖子评审结论：【待评审】资源协作接口OpticalModule新增Item属性和相应redfish,Rest资源

帖子相关性：相关（MDB 相关: 标题含强特征: 资源协作）

  • 总评审点数：3
  • MDB 资源协作接口评审点：3
  • 其他评审点：0

总体结果：不通过（2/3 个评审点通过）

评审点 1：资源协作接口OpticalModule新增Item属性【MDB】

结果：不通过

  • 规则合规性检查：不通过（1/28 项失败）

    • 规则合规性失败项（必须项）：
      规则ID：MDB-PROPERTY-014
      级别：必须项
      问题描述：评审点3的属性类型声明为 String，但 RspBody 响应体示例中 Item 的值 34061089 未加引号，表现为数字类型，与 String 类型不一致。
      处理建议：请在评审点3的 RspBody 响应体示例中为 34061089 添加双引号使其符合 String 类型，或根据实际业务语义确认并修改属性类型。

    • 警告项（建议性）：
      规则ID：MDB-REVIEW-003
      级别：建议性
      问题描述：评审点未提供新增 Item 属性的业务背景、消费方或变更原因等补充信息。
      处理建议：severity=‘should’ 建议性规则，建议修改以提升规范符合性

      规则ID：MDB-NAMING-028
      级别：建议性
      问题描述：属性描述为光模块 BOM 编码，语义命中标识符/部件编号场景，未复用 Redfish 社区惯例字段 PartNumber 或 Id 后缀
      处理建议：severity=‘should’ 建议性规则，建议修改以提升规范符合性

评审点 2：redfish资源Transceivers新增Item属性 （GET接口）【MDB】

结果：通过

  • 规则合规性检查：通过（28 项检查全部通过）

评审点 3：rackmount的web_backend对应URI下新增Item字段【MDB】

结果：通过

  • 规则合规性检查：通过（28 项检查全部通过）
3

重新预审