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.json(HTML outputs only)
Whether to consider the description as Markdown and render it accordingly.
(HTML outputs only)
(Only used with description_is_markdown)
How are HTML tags in descriptions handled. Correspond to the safe_mode option of the markdown2 library.
[HTML_REMOVED]If a description is considered big, show only the beginning and add a Read more button.
If an example is considered big, collapse it, it can be displayed with a Show option.
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 name of the built-in template to use to render the documentation.
js is the default and uses javascript for anchor links, collapsible sections and tabs.
js_offline is identical to js except that all CSS, fonts and JavaScript are bundled for offline use.
flat uses no javascript, but has no interactivity.
md is the markdown template.
md_nested is the markdown template with collapsible nested sections.
Path to a custom Jinja2 template file.
There can be multiple files to split the template, but this path should be the entry point.
If no output file is specified, the extension of the template file will be used to determine the output documentation extension. i.e. if the template is in ./custom_template/content.html, the resulting documentation will have the html extension.
Whether to render table of contents.
Whether to display examples as YAML instead of JSON
Generate HTML ids for anchor links without special characters (keep only letters, digits, _, and -).
This is the old behaviour and is only needed for browsers that do not support HTML 5.
(Only used with description_is_markdown)
Markdown 2 options for the descriptions.
{
"fenced-code-blocks": {
"cssclass": "highlight jumbotron"
},
"tables": null,
"break-on-newline": true,
"cuddled-lists": true
}
specific options to md template
if true generate badges(eg: optional, required) using embedded image (https://img.shields.io).
if false, use text instead
if true generate heading numbers to correspond to table of contents.
if false, do not generate heading numbers
if true generate array restrictions section.
if false, do not generate
array of column names to display in the properties table.
if empty, the default is ['Property','Pattern','Type','Deprecated','Definition','Title/Description']
No Additional Items[Deprecated]
[Deprecated]
[Deprecated]