JSON Schema for Humans configuration file

Type: object

Choose how to generate JSON Schema for Humans documentation file

Type: boolean Default: true

Minify the output HTML document.

Type: boolean Default: true

Whether to consider the description as markdown and render it accordingly

Type: boolean Default: false

Add an Expand all and a Collapse all button at the top of the generated documentation

Type: integer Default: 25

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.

Type: boolean Default: false

Mark a property as deprecated (with a big red badge) if the description contains the string [Deprecated

Type: boolean Default: false

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

Type: boolean Default: true

Copy schema_doc.css to the same directory as RESULT_FILE after generation

Type: boolean Default: true

Copy schema_doc.min.js to the same directory as RESULT_FILE after generation.

This file contains the logic for the anchor links