Choose how to generate JSON Schema for Humans documentation file.
Configuration parameters can be provided in several ways:
--config parameter_name=value (example: --config template_name=flat)--config-file config.jsonMinify the output HTML document.
Whether to consider the description as markdown and render it accordingly
If several $ref points to the same definition, only render the documentation for this definition the first time. All other occurrences are replaced by an anchor link to the first occurrence. The first occurrence is the one that is the least nested from the top of the schema and appears first in that nesting level.
Note: If this option is off and the schema contains recursive definitions, the generation will crash!
Advanced option If link_to_reused_ref is false and a $ref in the schema refers to a parent of itself, we would get a RecursionError trying to render the documentation. To avoid this, each reference is checked for circular references.
This option determines the number of times to recursively follow definitions looking for a circular reference.
In other words, if a schema has a deeply nested element that refers to itself, this option may need to be increased.
Mark a property as deprecated (with a big red badge) if the description contains the string [Deprecated
Extract the default value of a property from the description like this: [Default `the_default_value`].
The default value from the "default" attribute will be used in priority
Copy schema_doc.css to the same directory as RESULT_FILE after generation
Copy schema_doc.min.js to the same directory as RESULT_FILE after generation.
This file contains the logic for the anchor links
The HTML templates to use to render the documentation.
js is the default one, it uses javascript for anchor links, collapsible sections and tabs. flat uses no javascript, but has no interactivity.