背景
原有webrest BMA相关接口相关属性和URL名称需要去掉厂商差异化名称信息,社区采用统一且泛化的名称,同时降低前端webui适配复杂度。
关联ISSUE
整体方案
webrest接口厂商相关BMA属性名称、URL名称(xxBMA)统一采用BMA字样。
评审点
1)/UI/Rest/System/ProductInfo接口下,xxBMARunningStatus、xxBMAVersion、xxBMADriver属性名称统一修改为BMARunningStatus、BMAVersion、BMADriver
2)/UI/Rest/BMCSettings/BMA 接口下xxBMAPacketStatus属性名称修改为BMAPacketStatus,该属性的取值也修改为: BMAPacketIsAvailable、BMAPartitionTableNotExist、BMAPacketNotExist
3)其他BMA相关URL中的名称统一使用BMA字样
说明:xx为厂商差异化名称前缀
涉及的改动会同时适配openUBMC rackmount和webui仓库,不存在配套兼容问题
详细描述
1)/UI/Rest/System/ProductInfo接口下,xxBMARunningStatus、xxBMAVersion、xxBMADriver属性名称统一修改为BMARunningStatus、BMAVersion、BMADriver
URL:/UI/Rest/System/ProductInfo
属性名称调整:
针对该接口响应体OS对象下的属性名称调整如下:
| 调整前 | 调整后 |
|---|---|
| xxBMARunningStatus | BMARunningStatus |
| xxBMAVersion | BMAVersion |
| xxBMADriver | BMADriver |
调整后响应体示例
{
"DigitalWarranty": {
"StartPoint": "2024-10-23",
"Lifespan": 24,
"UnitType": "Device",
"ProductName": "",
"SerialNumber": "",
"ManufactureDate": "2024-07-15 Mon 10:44:00",
"UUID": ""
},
"OS": {
"HostName": "",
"KernalVersion": "",
"BMARunningStatus": "",
"OSVersion": "",
"BMAVersion": "",
"BMADriver": "",
"Domain": ""
},
...
}
2)/UI/Rest/BMCSettings/BMA 接口下xxBMAPacketStatus属性名称修改为BMAPacketStatus,该属性的取值也修改为: BMAPacketIsAvailable、BMAPartitionTableNotExist、BMAPacketNotExist
URL:/UI/Rest/BMCSettings/BMA
属性名称调整:xxBMAPacketStatus调整为 BMAPacketStatus
属性取值名称调整:
BMAPacketStatus属性会返回如下三种取值,对取值进行如下调整:
| 调整前 | 调整后 |
|---|---|
| xxBMAPacketIsAvailable | BMAPacketIsAvailable |
| xxBMAPartitionTableNotExist | BMAPartitionTableNotExist |
| xxBMAPacketNotExist | BMAPacketNotExist |
调整后响应体示例
{
"InstalledPackage": {
"Version": "",
"RunningStatus": "",
"DriverVersion": ""
},
"BMAPacketStatus": "BMAPacketNotExist",
"Inserted": null,
"AvailiableInstallationPackages": []
}
3)其他BMA相关URL中的名称统一使用BMA字样
| 调整前 | 调整后 |
|---|---|
| /UI/Rest/BMCSettings/xxBMA | /UI/Rest/BMCSettings/BMA |
| /UI/Rest/BMCSettings/xxBMA/USBStickControl | /UI/Rest/BMCSettings/BMA/USBStickControl |
| /UI/Rest/BMCSettings/xxBMA/Logs | /UI/Rest/BMCSettings/BMA/Logs |
| /UI/Rest/BMCSettings/xxBMA/Monitor | /UI/Rest/BMCSettings/BMA/Monitor |
| /UI/Rest/BMCSettings/xxBMA/Base | /UI/Rest/BMCSettings/BMA/Base |
评审结论
同意如下调整:
1)/UI/Rest/System/ProductInfo接口下,xxBMARunningStatus、xxBMAVersion、xxBMADriver属性名称统一修改为BMARunningStatus、BMAVersion、BMADriver。
2)/UI/Rest/BMCSettings/BMA 接口下xxBMAPacketStatus属性名称修改为BMAPacketStatus,该属性的取值也修改为: BMAPacketIsAvailable、BMAPartitionTableNotExist、BMAPacketNotExist。
3)BMA相关URL(详见评审点3)中的名称统一使用BMA字样。
遗留问题
无