{
- "fenced-code-blocks": {
- "cssclass": "highlight jumbotron"
+Example:
+
{
+ "fenced-code-blocks": {
+ "cssclass": "highlight jumbotron"
},
- "tables": null,
- "break-on-newline": true,
- "cuddled-lists": true
+ "tables": null,
+ "break-on-newline": true,
+ "cuddled-lists": true
}
@@ -795,7 +795,7 @@
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
- template_md_options
[
- 1600,
+ 1600,
"Pennsylvania",
"Avenue",
"NW",
@@ -266,7 +266,7 @@
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
- addressLines
Must contain a minimum of 5 items
Must contain a maximum of 8 items
All items must be unique
No Additional ItemsMust contain a minimum of 5 items
Must contain a maximum of 8 items
All items must be unique
No Additional Items"apple"
[
"apple",
"banana"
diff --git a/docs/examples/examples_flat_default/array_items_draft_2020_12.html b/docs/examples/examples_flat_default/array_items_draft_2020_12.html
index 73a5d7b3..a4f6d934 100644
--- a/docs/examples/examples_flat_default/array_items_draft_2020_12.html
+++ b/docs/examples/examples_flat_default/array_items_draft_2020_12.html
@@ -4,14 +4,14 @@
-
+
Schema Docs
- Type: array
+ Type: array
@@ -29,7 +29,7 @@
- No Additional ItemsTuple Validation
+ No Additional ItemsTuple Validation
Item at 1 must be:
@@ -43,7 +43,7 @@ Item at 1 must be:
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
- root item 0Type: number
+ root item 0Value must be greater or equal to 0
Value must be greater or equal to 0
Must be at least 1 characters long
Must be at least 1 characters long
Value must be greater or equal to -90 and lesser or equal to 90
Value must be greater or equal to -90 and lesser or equal to 90
Value must be greater or equal to -180 and lesser or equal to 180
Value must be greater or equal to -180 and lesser or equal to 180
[
- 1600,
+ 1600,
"Pennsylvania",
"Avenue",
"NW",
diff --git a/docs/examples/examples_flat_default/recursive.html b/docs/examples/examples_flat_default/recursive.html
index 4c4ccca8..569e4566 100644
--- a/docs/examples/examples_flat_default/recursive.html
+++ b/docs/examples/examples_flat_default/recursive.html
@@ -4,7 +4,7 @@
-
+
@@ -13,7 +13,7 @@
Person
- Type: object
+ Type: object
@@ -48,7 +48,7 @@
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
- person
Must be at least 5 characters long
Must be at most 250 characters long
Must be at least 5 characters long
Must be at most 250 characters long
"29292929292929292929292"
Must be at least 10 characters long
Must be at most 250 characters long
Must be at least 10 characters long
Must be at most 250 characters long
"John"
Must be at least 5 characters long
Must be at most 10 characters long
Must be at least 5 characters long
Must be at most 10 characters long
"Doe"
Must be at least 1 characters long
Must be at least 1 characters long
"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec ornare mauris ac neque malesuada sagittis. Curabitur vel blandit tortor, at pharetra lorem. Curabitur rhoncus posuere purus ut fringilla. Aenean ac rhoncus enim. Nullam ac consectetur est. Etiam vel congue tellus, ac fermentum lectus. Sed accumsan diam libero, a tincidunt mauris feugiat vitae. Nulla eu bibendum sem, quis finibus libero. Cras metus augue, aliquam at finibus elementum, mollis sed dui. Nulla quis facilisis tortor, ut sollicitudin nunc. Mauris diam nisi, ullamcorper at dignissim in, mollis ut felis. Fusce in libero facilisis, venenatis quam nec, ultrices leo. Cras tempus tristique leo ultrices pulvinar. Duis et leo quis dolor lacinia sagittis. Etiam rhoncus, nisl nec elementum auctor, enim lectus dignissim ipsum, sed consectetur mi magna eget mauris. Donec nunc augue, lacinia id nunc sit amet, accumsan posuere lorem. Sed orci neque, commodo ac nibh sit amet, euismod lacinia purus. Quisque non suscipit nibh, at auctor odio. Quisque facilisis tellus nunc. Integer interdum augue ut elit dictum eleifend. Integer bibendum convallis nisl, ut iaculis ligula vehicula et. Nunc ac diam vel arcu fringilla ullamcorper. "
+Example:
+
"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec ornare mauris ac neque malesuada sagittis. Curabitur vel blandit tortor, at pharetra lorem. Curabitur rhoncus posuere purus ut fringilla. Aenean ac rhoncus enim. Nullam ac consectetur est. Etiam vel congue tellus, ac fermentum lectus. Sed accumsan diam libero, a tincidunt mauris feugiat vitae. Nulla eu bibendum sem, quis finibus libero. Cras metus augue, aliquam at finibus elementum, mollis sed dui. Nulla quis facilisis tortor, ut sollicitudin nunc. Mauris diam nisi, ullamcorper at dignissim in, mollis ut felis. Fusce in libero facilisis, venenatis quam nec, ultrices leo. Cras tempus tristique leo ultrices pulvinar. Duis et leo quis dolor lacinia sagittis. Etiam rhoncus, nisl nec elementum auctor, enim lectus dignissim ipsum, sed consectetur mi magna eget mauris. Donec nunc augue, lacinia id nunc sit amet, accumsan posuere lorem. Sed orci neque, commodo ac nibh sit amet, euismod lacinia purus. Quisque non suscipit nibh, at auctor odio. Quisque facilisis tellus nunc. Integer interdum augue ut elit dictum eleifend. Integer bibendum convallis nisl, ut iaculis ligula vehicula et. Nunc ac diam vel arcu fringilla ullamcorper. "
Value must be greater or equal to 0 and lesser or equal to 2
Value must be greater or equal to 0 and lesser or equal to 2
"Guido"
"BDFL"
@@ -92,7 +92,7 @@
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
- lastName
"Van Rossum"
Value must be greater or equal to 0
Value must be greater or equal to 0
64
+Example:
+
64
{
- "birthplace": "Haarlem, Netherlands",
- "favorite_emoji": "🐍",
- "motto": "Beautiful is better than ugly.\\nExplicit is better than implicit.\\nSimple is better than complex.\\nComplex is better than complicated.\\nFlat is better than nested.\\nSparse is better than dense.\\nReadability counts.\\nSpecial cases aren't special enough to break the rules.\\nAlthough practicality beats purity.\\nErrors should never pass silently.\\nUnless explicitly silenced.\\nIn the face of ambiguity, refuse the temptation to guess.\\nThere should be one-- and preferably only one --obvious way to do it.\\nAlthough that way may not be obvious at first unless you're Dutch.\\nNow is better than never.\\nAlthough never is often better than *right* now.\\nIf the implementation is hard to explain, it's a bad idea.\\nIf the implementation is easy to explain, it may be a good idea.\\nNamespaces are one honking great idea -- let's do more of those!"
+Example:
+
{
+ "birthplace": "Haarlem, Netherlands",
+ "favorite_emoji": "🐍",
+ "motto": "Beautiful is better than ugly.\\nExplicit is better than implicit.\\nSimple is better than complex.\\nComplex is better than complicated.\\nFlat is better than nested.\\nSparse is better than dense.\\nReadability counts.\\nSpecial cases aren't special enough to break the rules.\\nAlthough practicality beats purity.\\nErrors should never pass silently.\\nUnless explicitly silenced.\\nIn the face of ambiguity, refuse the temptation to guess.\\nThere should be one-- and preferably only one --obvious way to do it.\\nAlthough that way may not be obvious at first unless you're Dutch.\\nNow is better than never.\\nAlthough never is often better than *right* now.\\nIf the implementation is hard to explain, it's a bad idea.\\nIf the implementation is easy to explain, it may be a good idea.\\nNamespaces are one honking great idea -- let's do more of those!"
}
diff --git a/docs/examples/examples_flat_default/with_keywords.html b/docs/examples/examples_flat_default/with_keywords.html
index 21f3e2c1..642fc7e5 100644
--- a/docs/examples/examples_flat_default/with_keywords.html
+++ b/docs/examples/examples_flat_default/with_keywords.html
@@ -4,7 +4,7 @@
-
+
@@ -13,7 +13,7 @@
Person
- Type: object
+ Type: object
@@ -36,7 +36,7 @@
@@ -48,7 +48,7 @@
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
- default
Type: string
+ defaultType: string
@@ -74,7 +74,7 @@
@@ -86,7 +86,7 @@
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
- examples
Type: string
+ examplesType: string
@@ -124,7 +124,7 @@
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
- if
Value must be greater or equal to 0
Value must be greater or equal to 0
"🖖"
"صباح الخير"
@@ -207,7 +207,7 @@
d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"
/>
- 名前
Choose how to generate JSON Schema for Humans documentation file.
@@ -34,7 +34,7 @@(HTML outputs only)
Whether to consider the description as Markdown and render it accordingly.
(HTML outputs only)
(Only used with description_is_markdown)
@@ -114,7 +110,7 @@
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.
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.
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.
@@ -427,18 +407,16 @@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.
@@ -497,18 +473,16 @@The name of the built-in template to use to render the documentation.
@@ -533,7 +507,7 @@Path to a custom Jinja2 template file.
@@ -581,7 +553,7 @@Whether to render table of contents.
@@ -630,18 +600,16 @@Whether to display examples as YAML instead of JSON
@@ -664,18 +632,16 @@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.
@@ -700,18 +666,16 @@(Only used with description_is_markdown)
Markdown 2 options for the descriptions.
{
- "fenced-code-blocks": {
- "cssclass": "highlight jumbotron"
+Example:
+
{
+ "fenced-code-blocks": {
+ "cssclass": "highlight jumbotron"
},
- "tables": null,
- "break-on-newline": true,
- "cuddled-lists": true
+ "tables": null,
+ "break-on-newline": true,
+ "cuddled-lists": true
}
@@ -746,18 +710,16 @@
specific options to md template
@@ -776,18 +738,16 @@if true generate badges(eg: optional, required) using embedded image (https://img.shields.io).
if false, use text instead
@@ -819,18 +779,16 @@if true generate heading numbers to correspond to table of contents.
if false, do not generate heading numbers
@@ -862,18 +820,16 @@if true generate array restrictions section.
if false, do not generate
@@ -905,18 +861,16 @@array of column names to display in the properties table.
if empty, the default is ['Property','Pattern','Type','Deprecated','Definition','Title/Description']
@@ -942,7 +896,7 @@