Document Json OEM schema creation
This commit documents how to create json schemas for OEM parameters. It
adds a config file for running the Redfish-Tools
Tested: Documentation only.
Change-Id: I84493b58bf81320259f41856eb932d4b4e9e82f8
Signed-off-by: Ed Tanous <ed@tanous.net>
diff --git a/scripts/csdl-to-json-converter/README.md b/scripts/csdl-to-json-converter/README.md
new file mode 100644
index 0000000..94e9e40
--- /dev/null
+++ b/scripts/csdl-to-json-converter/README.md
@@ -0,0 +1,14 @@
+# Generating Json schema for OEM schemas
+
+The config in this directory is for utilizing the DMTF json generation script
+located at [1]
+
+To update the config files, run the following command, updating the paths to be
+correct on your machine.
+
+```
+python3 ~/Redfish-Tools/csdl-to-json-convertor/csdl-to-json.py --input ~/bmcweb/redfish-core/schema/oem/openbmc/csdl --output ~/bmcweb/redfish-core/schema/oem/openbmc/json-schema --config ~/bmcweb/scripts/csdl-to-json-converter/csdl-to-json-convertor/openbmc-config.json
+```
+
+[1]
+https://github.com/DMTF/Redfish-Tools/blob/main/csdl-to-json-convertor/csdl-to-json.py
diff --git a/scripts/csdl-to-json-converter/openbmc-config.json b/scripts/csdl-to-json-converter/openbmc-config.json
new file mode 100644
index 0000000..13bbf7c
--- /dev/null
+++ b/scripts/csdl-to-json-converter/openbmc-config.json
@@ -0,0 +1,14 @@
+{
+ "Copyright": "Copyright 2024 OpenBMC.",
+ "RedfishSchema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
+ "ODataSchema": "http://redfish.dmtf.org/schemas/v1/odata-v4.json",
+ "Location": "https://github.com/openbmc/bmcweb/tree/master/redfish-core/schema/oem/openbmc/json-schema/",
+ "ResourceLocation": "https://github.com/openbmc/bmcweb/tree/master/redfish-core/schema/oem/openbmc/json-schema/",
+ "DoNotWrite": [
+ "Volume.",
+ "VolumeCollection.",
+ "RedfishError.",
+ "RedfishExtensions.",
+ "Validation."
+ ]
+}