meta data for this page
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
| documentation:redfish_api [2017/03/24 13:12] – [API Mapping] bil | documentation:redfish_api [2017/04/25 09:26] – [Schema Definition] bil | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Redfish API Specification ====== | ====== Redfish API Specification ====== | ||
| - | ===== Used Versions ===== | + | ===== Referenced |
| - | * Redfish Scalable Platforms Management API Specification | + | |
| - | * JSON Schema, Core Definitions and Terminology, | + | * DMTF Redfish Scalable Platforms Management API Specification [[http:// |
| - | * JSON Schema, Interactive and Non-Interactive Validation ([[https:// | + | * DMTF Redfish |
| - | * OData Version | + | * SINA Swordfish |
| - | * OData Version 4.0. Part 2: URL Conventions, | + | |
| - | * OData Version 4.0. Part 3: Common | + | All other referred versions, such as JSON, ODATA and SSDP, are corresponding to the [[http://redfish.dmtf.org/schemas/DSP0266_1.1.html#normative-references|normative references]] of the Redfish Scalable Platforms Management API Specification of the version noted above. |
| - | * OData Version 4.0: Core Vocabulary, Plus Errata 02 ([[http://docs.oasis-open.org/ | + | |
| - | * OData Version 4.0: Measures Vocabulary, Plus Errata 02 ([[http://docs.oasis-open.org/odata/odata/v4.0/errata02/os/complete/ | + | |
| - | * OData JSON Format Version 4.0 Plus Errata 03 (http://docs.oasis-open.org/odata/odata-json-format/ | + | |
| - | * Simple Service Discovery Protocol/1.0, Draft 3 ([[https:// | + | |
| - | * Hypertext Transfer Protocol (HTTP/1.1) | + | |
| ===== API Mapping (main components) ===== | ===== API Mapping (main components) ===== | ||
| ^ RECS%%|%%Box Component ^ Redfish API Resource ^ Redfish Schema ^ Notes ^ | ^ RECS%%|%%Box Component ^ Redfish API Resource ^ Redfish Schema ^ Notes ^ | ||
| + | | Root | ServiceRoot | [[http:// | ||
| | Enclosure | Chassis (ChassisType = Enclosure) | [[http:// | | Enclosure | Chassis (ChassisType = Enclosure) | [[http:// | ||
| | Baseboard-Blade | Chassis (ChassisType = Blade) | [[http:// | | Baseboard-Blade | Chassis (ChassisType = Blade) | [[http:// | ||
| Line 21: | Line 17: | ||
| | PCIe Card | PCIeDevice | [[http:// | | PCIe Card | PCIeDevice | [[http:// | ||
| | Compute Node | ComputerSystem (SystemType = Physical) | [[http:// | | Compute Node | ComputerSystem (SystemType = Physical) | [[http:// | ||
| - | | Local Storage | SimpleStorage | [[http:// | + | | Local Storage | SimpleStorage | [[http:// |
| | Storage Extension | Storage | [[http:// | | Storage Extension | Storage | [[http:// | ||
| | Ethernet Switch | EthernetSwitch from Intel PSME REST API (Apache 2.0 License) | [[http:// | | Ethernet Switch | EthernetSwitch from Intel PSME REST API (Apache 2.0 License) | [[http:// | ||
| - | | PCIe Switch | PCIeSwitch v0.9.0 (work in progress) | [[http:// | + | | PCIe Switch | PCIeSwitch v0.9.0 (work in progress) | [[http:// |
| | Crosspoint Switch | | | maybe treated transparently | | | Crosspoint Switch | | | maybe treated transparently | | ||
| | Composed Node | ComposedNode from Intel PSME REST API (Apache 2.0 License) | [[http:// | | Composed Node | ComposedNode from Intel PSME REST API (Apache 2.0 License) | [[http:// | ||
| + | ===== Endpoint Definition ===== | ||
| + | |||
| + | ^ URI ^ Resource ^ Description ^ | ||
| + | | [[documentation: | ||
| + | | [[documentation: | ||
| + | | [[documentation: | ||
| + | | [[documentation: | ||
| + | | [[documentation: | ||
| + | | [[documentation: | ||
| + | | [[documentation: | ||
| + | | [[documentation: | ||
| + | | [[documentation: | ||
| + | | [[documentation: | ||
| + | |||
| + | ===== Schema Definition ===== | ||
| + | |||
| + | <WRAP group>< | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | </ | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | </ | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | </ | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | * [[documentation: | ||
| + | </ | ||