What are the required properties of a OEM JsonSchemas file?

new

« Prev
1
Next »

AMI_ivywang
Minnow

Posts: 21

What are the required properties of a OEM JsonSchemas file? Apr 27, 2023 16:06:07 GMT

Quote

Post by AMI_ivywang on Apr 27, 2023 16:06:07 GMT

Shall a JsonSchema file contains all those properties mentioned in the document "DSP0266(1.15.1) Table 29 — JSON Schema format"?

For example:

GET https://{{ip}}/redfish/v1/JsonSchemas/OEMJsonSchema.v1_0_0.json

>> the response body shall return properties:
$id
$ref
$schema <- Can the value of this one be "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_X_0.json"? Or it shall be "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json"?
copyright
definitions
title <- Can the value of this one be "#OEMJsonSchema.v1_0_0"? Or it shall be "#OEMJsonSchema.v1_0_0.OEMJsonSchema"?

Attachments:

Last Edit: Apr 27, 2023 16:06:52 GMT by AMI_ivywang

jautor
Administrator

Posts: 504

What are the required properties of a OEM JsonSchemas file? Apr 27, 2023 18:11:15 GMT

Quote

Post by jautor on Apr 27, 2023 18:11:15 GMT

Note that you can also create your OEM schemas in CSDL (XML) format and use the DMTF-provided open source tools on GitHub to convert the CSDL to JSON schema and OpenAPI YAML files - which gets you all three supported schema formats...

But yes, an OEM JSON schema file should contain those properties as defined so that any client or tools that attempt to operate on Redfish schemas will also function with your OEM schemas.

Using the "redfish-schema-v1.json" $schema reference is preferred as we update that "v1" file to match the latest, backwards-compatible version of the file. And the "title" should follow the format shown in the specification, which you show in your example as "#OEMJsonSchema.v1_0_0.OEMJsonSchema"

Jeff