|
Post by phanindrabec on Dec 10, 2018 4:20:49 GMT
Hello,
quick question on oem schema file format. Can we define oem schema's in json format stright?
i understand that we can do in define oem schema's in csdl language and convert to json format using redfish opensource tool but i am trying to understand, why can we define straight in json format ? Thanks
|
|
|
Post by malbolge on Jan 26, 2020 21:41:30 GMT
If you only touch Redfish you can, possibly, get away with just JSON schemas. Someone else will have to clear that up. Even if you can get away with just JSONs though, there's no guarantee someone might not have their tooling setup for CSDLs and complain about the lack thereof.
If you plan on ever touching RDE though, CSDLs are required.
|
|
|
Post by jautor on Jan 27, 2020 20:20:11 GMT
Hello, quick question on oem schema file format. Can we define oem schema's in json format stright? i understand that we can do in define oem schema's in csdl language and convert to json format using redfish opensource tool but i am trying to understand, why can we define straight in json format ? Thanks
Yes, you can define them in any of the (currently three) supported schema languages (CSDL, JSON schema, or OpenAPI YAML). But I would recommend creating them in CSDL because you can use our open source tools to generate the JSON Schema and YAML files automatically. Other tools like the documentation generator are also expecting the JSON Schemas to "look like Redfish ones converted from CSDL" as well. Your results may not be as good because of various conventions or assumptions the tools make...
While CSDL is a complex language, if you cut/paste from an existing Redfish schema file I think you'll find its not too difficult to generate one. We also have a new white paper to help called the "Quick Start for Authoring Redfish Schema" (DSP2055), which can be downloaded here:
Hope that helps!
Jeff
|
|