openbmc/bmcweb/OEM_SCHEMAS.md

1 # Redfish OEM Schemas
3 The Redfish specification allows for OEM resources and properties to be
4 implemented by OEMs. bmcweb does not expose a stable API for adding OEM
8 ## OEM Compatibility and authority
11 organization is responsible for maintaining that company's OEM namespace. They
17 Because of that, OEM properties in an open-source project pose many problems
28 In the experience of the project, OEM resources trend toward a lower level of
35 If a given feature eventually becomes standardized, OpenBMC OEM endpoints now
38 be completed before merging the OEM code to master.
47 In the current implementation, OEM schemas for all namespaces are shipped on all
52 ## How do I write an OEM schema?
54 If you've read the above, and still think an OEM property is warranted, please
57 1. Read all the relevant documentation on OEM schema technical implementation
68    accommodate active development; OEM schemas are no different. If the DMTF
71    feature you intend to implement as OEM, under the OpenBMC (generic to all
72    platforms) OEM namespace.
73 4. If OpenBMC feedback is that this feature is specific to a single OEM or ODM,
76    an OEM/ODM specific namespace.
78 Regardless of the OEM namespace being used, implementations should plan to
79 implement all appropriate CSDL and OpenAPI schemas for their given OEM
81 validator and should follow redfish API design practices. We require OEM to have
82 the same level of quality as non-OEM.
84 bmcweb maintainers retain the final approval on OEM schemas.
86 The OpenBMC project maintains OEM schemas within the OpenBMC namespace, which,
90 registered their OEM namespace directly in the specification to allow extensions
91 of the ICANN domain name requirements above. The following organization OEM