背景
Redfish是由 DMTF（分布式管理任务组）制定的一套现代化、开放标准的服务器 / 硬件远程管理 API，用于替代传统的IPMI，面向云与软件定义数据中心，向客户展示系统的内部可查询信息。当前openubmc社区无对外的redfish接口说明，导致开发者对redfish接口的整体框架信息及属性信息等只能通过代码层面获取，效率太低，为了提高开发者对openubmc的redfish接口的进一步了解及辅助开发，本次需要将redfish接口进行整理并合并到社区。
关联ISSUE
https://gitcode.com/org/openUBMC/kanban/14/views/2029040519540449281?filterBy=value:2029040519502700550:lilexuan;&pathname=/openUBMC/docs/issues/290
整体方案
md文件开发对应的格式如下：
---
resource_type: NetworkAdapter
resource_definition : std/oem
version: v1_1_2
date: [YYYY-MM-DD]
---
# ResourceDefinition
## uris
- `/api/v1/network-adapters`
- `/api/v1/network-adapters/{id}`
## properties
| 属性 | 类型 | 必填 | 描述 |
|------|------|------|------|
| id | string | 是 | 资源唯一标识 |
| name | string | 是 | 网卡名称 |
| type | string | 否 | 类型: std/oem |
| status | enum | 是 | 状态: active/inactive |
## supported_methods
- GET
- POST
- PATCH
- DELETE
# HTTP methods
## GET
**命令功能**
*[xx描述]*
**命令格式**
URL: https://device_ip/redfish/v1/Systems
请求头:
X-Auth-Token: auth_value
请求消息体: 无
**参数说明**
**使用指南**
**使用实例**
## PATCH
## POST
## DELETE
## Actions
评审点
社区新增redfish资料模板
详细描述
格式中的各个信息描述如下：
| md文件关键信息 | 说明 | 备注 |
|---|---|---|
| resource_type | 资源类型 | |
| resource_definition | 资源定义类型 | std：标准资源接口 oem：oem资源接口 |
| version | sechema资源版本 | “@odata.type” 取版本号 |
| date | 开发日期 | |
| ResourceDefinition | 资源整体描述 | |
| uris | URL链接 | |
| properties | 响应体信息 | |
| supported_methods | 接口支持的操作类型整体信息 | GET/POST/PATCH/DELETE |
| HTTP methods | 具体操作类型描述 |
评审结论
（必选）针对决策点，详细描述最终结论，不能是简单的同意或不同意，通过或不通过。（提交议题时删除此引导说明）
正面示例：
同意redfish接口/redfish/v1/XXXXX的GET操作响应体增加如下属性
(详细描述属性名称、属性取值类型、取值范围、约束等)
或
不同意新增资源协作接口XXXXX
或
不同意资源协作接口XXX新增XX属性/方法
反面示例：
通过，同意新增接口
遗留问题
Redfish API 文档开发疑问汇总-待评审的问题
1、需要确认建文件夹么
`
结论：`
2、DELETE 接口输出说明格式统一性
`
结论：`
3、接口方法层级
`
结论：`
4、公共输出说明文件
`
结论：`
5、文档与代码/实际环境对比，以代码为准。当前情况各个字段的获取方式，都是redfish文档。
`
1.文档内容与代码或实际环境对比（url和响应体等），记录汇总。
以代码为准。
2.枚举属性字段：整理为 Excel 表格，与华为方对齐
对齐（枚举的具体含义）完成后修改对应 md 文件。
结论：`