Add Sphinx json-schema extension

[MaciejKaszynski]

Feature Request / Modification Description

There has been a lot of repos that include a json-schema file that has some docs on what each field is
e.g :
communication
lifecycle
log

In the user facing docs it's nice to also explain these fields and so there is duplication of information (lifecycle config docs)

There exists an extension that given the json schema generates a table https://sphinx-jsonschema.readthedocs.io/en/latest/directive.html#an-example

Example with lifecycle docs:

Expected Changes ot work products

• Requirements
• Architecture
• Safety Analysis
• Security Analysis
• Detailed Design
• Implementation and Testing
• all

Impact analysis

Docs are not required to use this extension so no impact

Safety or Security relevance

• none
• Safety relevant
• Security relevant

Expected required ASIL classification

QM

Expected Implementation Version (Release)

1.0

[MaximilianSoerenPollak]

If i understand correctly, you would like to have a way that Docs-As-Code can render these JSONSchemas right?

The extension does what you say and looks good & up to date, though we can not use it as it is GPL3 licensed.

So we can take this request and see if there is a way we can integrate this natively.

[MaciejKaszynski]

If i understand correctly, you would like to have a way that Docs-As-Code can render these JSONSchemas right?

The extension does what you say and looks good & up to date, though we can not use it as it is GPL3 licensed.

So we can take this request and see if there is a way we can integrate this natively.

Yep, I just want to remove the duplication between writing the JSONSchemas description for each field and then in the user docs.

I see, if we can create one from scratch that would be great. I think this is all we need for now:
Output table should have:

• Field name
• Description
• Default value
• Pattern / possible values for enums (enum example)

Would also be nice to to select the particular component in the schema to make the table for e.g. for the lcm schema being able to select the "component_properties" object and generate the table only for that.

[MaximilianSoerenPollak]

If i understand correctly, you would like to have a way that Docs-As-Code can render these JSONSchemas right?
The extension does what you say and looks good & up to date, though we can not use it as it is GPL3 licensed.
So we can take this request and see if there is a way we can integrate this natively.

Yep, I just want to remove the duplication between writing the JSONSchemas description for each field and then in the user docs.

I see, if we can create one from scratch that would be great. I think this is all we need for now: Output table should have:

• Field name
• Description
• Default value
• Pattern / possible values for enums (enum example)

Would also be nice to to select the particular component in the schema to make the table for e.g. for the lcm schema being able to select the "component_properties" object and generate the table only for that.

We can put that on the backlog for sure. Most likely this would need to be a sphinx extension that can handle a json input and then create some sphinx-needs directives etc.

[a-zw]

Why is it a problem that sphinx-jsonschema is GPL-licensed?