From c020cb4c4e21d8fd058a44419cecd898448880cd Mon Sep 17 00:00:00 2001 From: Denis Blanchette Date: Mon, 18 Dec 2023 14:50:19 -0500 Subject: [PATCH] Fix MDX compatibility + missing tests + missing doc (#225) --- .../examples_flat_default/Configuration.html | 96 ++++++++++++++ .../examples_js_default/Configuration.html | 81 ++++++++++++ .../Configuration.html | 81 ++++++++++++ .../examples_md_default/Configuration.md | 51 +++++++- .../Configuration.md | 123 ++++++++++++++---- .../additional_properties.md | 21 ++- .../anyOf_option_names.md | 3 +- .../examples_md_nested_default/array.md | 12 +- .../array_additionalItems.md | 9 +- .../array_advanced.md | 6 +- .../array_example.md | 3 +- .../examples_md_nested_default/basic.md | 12 +- .../break_on_newline.md | 3 +- .../examples_md_nested_default/broken_ref.md | 6 +- .../examples_md_nested_default/circular.md | 6 +- .../combining_not.md | 3 +- .../combining_oneOf.md | 3 +- .../conditional_subschema.md | 12 +- .../conditional_subschema_no_else.md | 15 ++- .../examples_md_nested_default/defaults.md | 6 +- .../examples_md_nested_default/deprecated.md | 15 ++- .../description_from_ref.md | 6 +- .../description_with_ref.md | 9 +- .../empty_property_name.md | 3 +- .../examples_md_nested_default/enumofnone.md | 3 +- .../examples_md_nested_default/geo.md | 6 +- .../long_description.md | 3 +- .../multiple_types.md | 12 +- .../pattern_properties.md | 15 ++- .../pattern_properties_html_id.md | 15 ++- .../examples_md_nested_default/prefixItems.md | 3 +- .../examples_md_nested_default/recursive.md | 6 +- .../recursive_array.md | 6 +- .../recursive_full_schema.md | 15 ++- .../recursive_full_schema_simple.md | 3 +- .../recursive_parent_in_definition.md | 12 +- .../recursive_two_files.md | 9 +- .../examples_md_nested_default/ref_merge.md | 12 +- .../ref_with_tabs.md | 69 ++++++---- .../reference_int.md | 6 +- .../examples_md_nested_default/references.md | 51 +++++--- .../references_url.md | 3 +- .../references_url_two_levels.md | 9 +- .../references_url_yaml.md | 12 +- .../required_properties_order.md | 6 +- .../single_element_allOf.md | 6 +- .../type_object_null.md | 6 +- .../with_default.md | 9 +- .../with_definitions.md | 18 ++- .../with_descriptions.md | 24 ++-- .../with_examples.md | 12 +- .../with_keywords.md | 33 +++-- .../with_special_chars.md | 18 ++- .../with_urlencoded_anchor.md | 15 ++- .../Configuration.md | 121 +++++++++++++---- .../additional_properties.md | 21 ++- .../anyOf_option_names.md | 3 +- .../examples_md_nested_with_badges/array.md | 12 +- .../array_additionalItems.md | 9 +- .../array_advanced.md | 6 +- .../array_example.md | 3 +- .../examples_md_nested_with_badges/basic.md | 12 +- .../break_on_newline.md | 3 +- .../broken_ref.md | 6 +- .../circular.md | 6 +- .../combining_not.md | 3 +- .../combining_oneOf.md | 3 +- .../conditional_subschema.md | 12 +- .../conditional_subschema_no_else.md | 15 ++- .../defaults.md | 6 +- .../deprecated.md | 15 ++- .../description_from_ref.md | 6 +- .../description_with_ref.md | 9 +- .../empty_property_name.md | 3 +- .../enumofnone.md | 3 +- .../examples_md_nested_with_badges/geo.md | 6 +- .../long_description.md | 3 +- .../multiple_types.md | 12 +- .../pattern_properties.md | 15 ++- .../pattern_properties_html_id.md | 15 ++- .../prefixItems.md | 3 +- .../recursive.md | 6 +- .../recursive_array.md | 6 +- .../recursive_full_schema.md | 15 ++- .../recursive_full_schema_simple.md | 3 +- .../recursive_parent_in_definition.md | 12 +- .../recursive_two_files.md | 9 +- .../ref_merge.md | 12 +- .../ref_with_tabs.md | 69 ++++++---- .../reference_int.md | 6 +- .../references.md | 51 +++++--- .../references_url.md | 3 +- .../references_url_two_levels.md | 9 +- .../references_url_yaml.md | 12 +- .../required_properties_order.md | 6 +- .../single_element_allOf.md | 6 +- .../type_object_null.md | 6 +- .../with_default.md | 9 +- .../with_definitions.md | 18 ++- .../with_descriptions.md | 24 ++-- .../with_examples.md | 12 +- .../with_keywords.md | 33 +++-- .../with_special_chars.md | 18 ++- .../with_urlencoded_anchor.md | 15 ++- .../examples_md_with_badges/Configuration.md | 49 ++++++- .../md_nested/section_properties_details.md | 3 +- tests/test_md_generate.py | 33 ++--- 107 files changed, 1321 insertions(+), 457 deletions(-) diff --git a/docs/examples/examples_flat_default/Configuration.html b/docs/examples/examples_flat_default/Configuration.html index c1a2aac6..3fd2c669 100644 --- a/docs/examples/examples_flat_default/Configuration.html +++ b/docs/examples/examples_flat_default/Configuration.html @@ -982,6 +982,102 @@

+ + + +
+ + +
+ +
root + + + + template_md_options + + + + properties_table_columns
Type: array of enum (of string)
+ + + + + + + +

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

Each item of this array must be:

+
+
+ + +
root + + + + template_md_options + + + + properties_table_columns + + + + properties_table_columns items
Type: enum (of string)
+ + + + + + + + + + + +
+

Must be one of:

+
  • "Property"
  • "Pattern"
  • "Type"
  • "Deprecated"
  • "Definition"
  • "Title/Description"
+
+ + + + + + +
+
diff --git a/docs/examples/examples_js_default/Configuration.html b/docs/examples/examples_js_default/Configuration.html index 20a5b22a..53b0741c 100644 --- a/docs/examples/examples_js_default/Configuration.html +++ b/docs/examples/examples_js_default/Configuration.html @@ -924,6 +924,87 @@

+ + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + template_md_options + + + + properties_table_columns
Type: array of enum (of string)
+

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

Each item of this array must be:

+
+
+ + +
root + + + + template_md_options + + + + properties_table_columns + + + + properties_table_columns items
Type: enum (of string)
+
+

Must be one of:

+
  • "Property"
  • "Pattern"
  • "Type"
  • "Deprecated"
  • "Definition"
  • "Title/Description"
+
+ + + + + + +
+
diff --git a/docs/examples/examples_js_offline_default/Configuration.html b/docs/examples/examples_js_offline_default/Configuration.html index 67d1e059..f2a683f8 100644 --- a/docs/examples/examples_js_offline_default/Configuration.html +++ b/docs/examples/examples_js_offline_default/Configuration.html @@ -924,6 +924,87 @@

+

+ + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + template_md_options + + + + properties_table_columns
Type: array of enum (of string)
+

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

Each item of this array must be:

+
+
+ + +
root + + + + template_md_options + + + + properties_table_columns + + + + properties_table_columns items
Type: enum (of string)
+
+

Must be one of:

+
  • "Property"
  • "Pattern"
  • "Type"
  • "Deprecated"
  • "Definition"
  • "Title/Description"
+
+ + + + + + +
+
diff --git a/docs/examples/examples_md_default/Configuration.md b/docs/examples/examples_md_default/Configuration.md index 34e6c06e..7e2769c4 100644 --- a/docs/examples/examples_md_default/Configuration.md +++ b/docs/examples/examples_md_default/Configuration.md @@ -23,6 +23,8 @@ - [20.1. Property `JSON Schema for Humans configuration file > template_md_options > badge_as_image`](#template_md_options_badge_as_image) - [20.2. Property `JSON Schema for Humans configuration file > template_md_options > show_heading_numbers`](#template_md_options_show_heading_numbers) - [20.3. Property `JSON Schema for Humans configuration file > template_md_options > show_array_restrictions`](#template_md_options_show_array_restrictions) + - [20.4. Property `JSON Schema for Humans configuration file > template_md_options > properties_table_columns`](#template_md_options_properties_table_columns) + - [20.4.1. JSON Schema for Humans configuration file > template_md_options > properties_table_columns > properties_table_columns items](#autogenerated_heading_2) - [21. Property `JSON Schema for Humans configuration file > with_footer`](#with_footer) - [22. Property `JSON Schema for Humans configuration file > footer_show_time`](#footer_show_time) @@ -319,11 +321,12 @@ Adding an extra, even if the value is false, will activate it. For example `{"br **Description:** specific options to md template -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| - [badge_as_image](#template_md_options_badge_as_image ) | No | boolean | No | - | if true generate badges(eg: optional, required) using embedded image (https://img.shields.io).

if false, use text instead | -| - [show_heading_numbers](#template_md_options_show_heading_numbers ) | No | boolean | No | - | if true generate heading numbers to correspond to table of contents.

if false, do not generate heading numbers | -| - [show_array_restrictions](#template_md_options_show_array_restrictions ) | No | boolean | No | - | if true generate array restrictions section.

if false, do not generate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------------------------------------------- | ------- | ------------------------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [badge_as_image](#template_md_options_badge_as_image ) | No | boolean | No | - | if true generate badges(eg: optional, required) using embedded image (https://img.shields.io).

if false, use text instead | +| - [show_heading_numbers](#template_md_options_show_heading_numbers ) | No | boolean | No | - | if true generate heading numbers to correspond to table of contents.

if false, do not generate heading numbers | +| - [show_array_restrictions](#template_md_options_show_array_restrictions ) | No | boolean | No | - | if true generate array restrictions section.

if false, do not generate | +| - [properties_table_columns](#template_md_options_properties_table_columns ) | No | array of enum (of string) | No | - | array of column names to display in the properties table.

if empty, the default is ['Property','Pattern','Type','Deprecated','Definition','Title/Description'] | ### 20.1. Property `JSON Schema for Humans configuration file > template_md_options > badge_as_image` @@ -361,6 +364,44 @@ Adding an extra, even if the value is false, will activate it. For example `{"br if false, do not generate +### 20.4. Property `JSON Schema for Humans configuration file > template_md_options > properties_table_columns` + +| | | +| ------------ | --------------------------- | +| **Type** | `array of enum (of string)` | +| **Required** | No | + +**Description:** array of column names to display in the properties table. + + if empty, the default is ['Property','Pattern','Type','Deprecated','Definition','Title/Description'] + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| ------------------------------------------------------------------------------------- | ----------- | +| [properties_table_columns items](#template_md_options_properties_table_columns_items) | - | + +#### 20.4.1. JSON Schema for Humans configuration file > template_md_options > properties_table_columns > properties_table_columns items + +| | | +| ------------ | ------------------ | +| **Type** | `enum (of string)` | +| **Required** | No | + +Must be one of: +* "Property" +* "Pattern" +* "Type" +* "Deprecated" +* "Definition" +* "Title/Description" + ## 21. Property `JSON Schema for Humans configuration file > with_footer` | | | diff --git a/docs/examples/examples_md_nested_default/Configuration.md b/docs/examples/examples_md_nested_default/Configuration.md index dc430e73..35fc0e59 100644 --- a/docs/examples/examples_md_nested_default/Configuration.md +++ b/docs/examples/examples_md_nested_default/Configuration.md @@ -23,6 +23,8 @@ - [20.1. [Optional] Property JSON Schema for Humans configuration file > template_md_options > badge_as_image](#template_md_options_badge_as_image) - [20.2. [Optional] Property JSON Schema for Humans configuration file > template_md_options > show_heading_numbers](#template_md_options_show_heading_numbers) - [20.3. [Optional] Property JSON Schema for Humans configuration file > template_md_options > show_array_restrictions](#template_md_options_show_array_restrictions) + - [20.4. [Optional] Property JSON Schema for Humans configuration file > template_md_options > properties_table_columns](#template_md_options_properties_table_columns) + - [20.4.1. JSON Schema for Humans configuration file > template_md_options > properties_table_columns > properties_table_columns items](#autogenerated_heading_2) - [21. [Optional] Property JSON Schema for Humans configuration file > with_footer](#with_footer) - [22. [Optional] Property JSON Schema for Humans configuration file > footer_show_time](#footer_show_time) @@ -43,7 +45,8 @@ Configuration parameters can be provided in several ways: - From code, by providing a GenerationConfiguration object to the called generation method.
- 1. [Optional] Property JSON Schema for Humans configuration file > minify + + 1. [Optional] Property JSON Schema for Humans configuration file > minify
@@ -60,7 +63,8 @@ Configuration parameters can be provided in several ways:
- 2. [Optional] Property JSON Schema for Humans configuration file > description_is_markdown + + 2. [Optional] Property JSON Schema for Humans configuration file > description_is_markdown
@@ -77,7 +81,8 @@ Configuration parameters can be provided in several ways:
- 3. [Optional] Property JSON Schema for Humans configuration file > expand_buttons + + 3. [Optional] Property JSON Schema for Humans configuration file > expand_buttons
@@ -94,7 +99,8 @@ Configuration parameters can be provided in several ways:
- 4. [Optional] Property JSON Schema for Humans configuration file > show_breadcrumbs + + 4. [Optional] Property JSON Schema for Humans configuration file > show_breadcrumbs
@@ -111,7 +117,8 @@ Configuration parameters can be provided in several ways:
- 5. [Optional] Property JSON Schema for Humans configuration file > collapse_long_descriptions + + 5. [Optional] Property JSON Schema for Humans configuration file > collapse_long_descriptions
@@ -128,7 +135,8 @@ Configuration parameters can be provided in several ways:
- 6. [Optional] Property JSON Schema for Humans configuration file > collapse_long_examples + + 6. [Optional] Property JSON Schema for Humans configuration file > collapse_long_examples
@@ -145,7 +153,8 @@ Configuration parameters can be provided in several ways:
- 7. [Optional] Property JSON Schema for Humans configuration file > link_to_reused_ref + + 7. [Optional] Property JSON Schema for Humans configuration file > link_to_reused_ref
@@ -164,7 +173,8 @@ Configuration parameters can be provided in several ways:
- 8. [Optional] Property JSON Schema for Humans configuration file > recursive_detection_depth + + 8. [Optional] Property JSON Schema for Humans configuration file > recursive_detection_depth
@@ -186,7 +196,8 @@ In other words, if a schema has a deeply nested element that refers to itself, t
- 9. [Optional]~~ Property JSON Schema for Humans configuration file > deprecated_from_description~~ + + 9. [Optional]~~ Property JSON Schema for Humans configuration file > deprecated_from_description~~
@@ -204,7 +215,8 @@ In other words, if a schema has a deeply nested element that refers to itself, t
- 10. [Optional] Property JSON Schema for Humans configuration file > default_from_description + + 10. [Optional] Property JSON Schema for Humans configuration file > default_from_description
@@ -223,7 +235,8 @@ The default value from the "default" attribute will be used in priority.
- 11. [Optional] Property JSON Schema for Humans configuration file > copy_css + + 11. [Optional] Property JSON Schema for Humans configuration file > copy_css
@@ -240,7 +253,8 @@ The default value from the "default" attribute will be used in priority.
- 12. [Optional] Property JSON Schema for Humans configuration file > copy_js + + 12. [Optional] Property JSON Schema for Humans configuration file > copy_js
@@ -259,7 +273,8 @@ This file contains the logic for the anchor links.
- 13. [Optional]~~ Property JSON Schema for Humans configuration file > templates_directory~~ + + 13. [Optional]~~ Property JSON Schema for Humans configuration file > templates_directory~~
@@ -276,7 +291,8 @@ This file contains the logic for the anchor links.
- 14. [Optional] Property JSON Schema for Humans configuration file > template_name + + 14. [Optional] Property JSON Schema for Humans configuration file > template_name
@@ -310,7 +326,8 @@ Must be one of:
- 15. [Optional] Property JSON Schema for Humans configuration file > custom_template_path + + 15. [Optional] Property JSON Schema for Humans configuration file > custom_template_path
@@ -331,7 +348,8 @@ If no output file is specified, the extension of the template file will be used
- 16. [Optional] Property JSON Schema for Humans configuration file > show_toc + + 16. [Optional] Property JSON Schema for Humans configuration file > show_toc
@@ -348,7 +366,8 @@ If no output file is specified, the extension of the template file will be used
- 17. [Optional] Property JSON Schema for Humans configuration file > examples_as_yaml + + 17. [Optional] Property JSON Schema for Humans configuration file > examples_as_yaml
@@ -365,7 +384,8 @@ If no output file is specified, the extension of the template file will be used
- 18. [Optional] Property JSON Schema for Humans configuration file > old_anchor_links + + 18. [Optional] Property JSON Schema for Humans configuration file > old_anchor_links
@@ -384,7 +404,8 @@ This is the old behaviour and is only needed for browsers that do not support HT
- 19. [Optional] Property JSON Schema for Humans configuration file > markdown_options + + 19. [Optional] Property JSON Schema for Humans configuration file > markdown_options
@@ -418,7 +439,8 @@ Adding an extra, even if the value is false, will activate it. For example `{"br
- 20. [Optional] Property JSON Schema for Humans configuration file > template_md_options + + 20. [Optional] Property JSON Schema for Humans configuration file > template_md_options
@@ -432,7 +454,8 @@ Adding an extra, even if the value is false, will activate it. For example `{"br **Description:** specific options to md template
- 20.1. [Optional] Property JSON Schema for Humans configuration file > template_md_options > badge_as_image + + 20.1. [Optional] Property JSON Schema for Humans configuration file > template_md_options > badge_as_image
@@ -451,7 +474,8 @@ Adding an extra, even if the value is false, will activate it. For example `{"br
- 20.2. [Optional] Property JSON Schema for Humans configuration file > template_md_options > show_heading_numbers + + 20.2. [Optional] Property JSON Schema for Humans configuration file > template_md_options > show_heading_numbers
@@ -470,7 +494,8 @@ Adding an extra, even if the value is false, will activate it. For example `{"br
- 20.3. [Optional] Property JSON Schema for Humans configuration file > template_md_options > show_array_restrictions + + 20.3. [Optional] Property JSON Schema for Humans configuration file > template_md_options > show_array_restrictions
@@ -488,11 +513,58 @@ Adding an extra, even if the value is false, will activate it. For example `{"br
+
+ + 20.4. [Optional] Property JSON Schema for Humans configuration file > template_md_options > properties_table_columns + + +
+ +| | | +| ------------ | --------------------------- | +| **Type** | `array of enum (of string)` | +| **Required** | No | + +**Description:** array of column names to display in the properties table. + + if empty, the default is ['Property','Pattern','Type','Deprecated','Definition','Title/Description'] + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| ------------------------------------------------------------------------------------- | ----------- | +| [properties_table_columns items](#template_md_options_properties_table_columns_items) | - | + +#### 20.4.1. JSON Schema for Humans configuration file > template_md_options > properties_table_columns > properties_table_columns items + +| | | +| ------------ | ------------------ | +| **Type** | `enum (of string)` | +| **Required** | No | + +Must be one of: +* "Property" +* "Pattern" +* "Type" +* "Deprecated" +* "Definition" +* "Title/Description" + +
+
+
- 21. [Optional] Property JSON Schema for Humans configuration file > with_footer + + 21. [Optional] Property JSON Schema for Humans configuration file > with_footer
@@ -509,7 +581,8 @@ Adding an extra, even if the value is false, will activate it. For example `{"br
- 22. [Optional] Property JSON Schema for Humans configuration file > footer_show_time + + 22. [Optional] Property JSON Schema for Humans configuration file > footer_show_time
diff --git a/docs/examples/examples_md_nested_default/additional_properties.md b/docs/examples/examples_md_nested_default/additional_properties.md index 8a60aaf1..e3a13628 100644 --- a/docs/examples/examples_md_nested_default/additional_properties.md +++ b/docs/examples/examples_md_nested_default/additional_properties.md @@ -17,7 +17,8 @@ | **Additional properties** | [[Should-conform]](#additionalProperties "Each additional property must conform to the following schema") |
- 1. [Optional] Property Person > subType1 + + 1. [Optional] Property Person > subType1
@@ -31,7 +32,8 @@ **Description:** A sub type with additionalProperties false.
- 1.1. [Optional] Property Person > subType1 > subProp1 + + 1.1. [Optional] Property Person > subType1 > subProp1
@@ -48,7 +50,8 @@
- 2. [Optional] Property Person > subType2 + + 2. [Optional] Property Person > subType2
@@ -62,7 +65,8 @@ **Description:** A sub type with additionalProperties true.
- 2.1. [Optional] Property Person > subType2 > subProp2 + + 2.1. [Optional] Property Person > subType2 > subProp2
@@ -79,7 +83,8 @@
- 3. [Optional] Property Person > anInt + + 3. [Optional] Property Person > anInt
@@ -95,7 +100,8 @@
- 4. Property Person > additionalProperties + + 4. Property Person > additionalProperties
@@ -109,7 +115,8 @@ **Description:** additionalProperties schema.
- 4.1. [Optional] Property Person > additionalProperties > propA + + 4.1. [Optional] Property Person > additionalProperties > propA
diff --git a/docs/examples/examples_md_nested_default/anyOf_option_names.md b/docs/examples/examples_md_nested_default/anyOf_option_names.md index 11f6f819..53c3fbb7 100644 --- a/docs/examples/examples_md_nested_default/anyOf_option_names.md +++ b/docs/examples/examples_md_nested_default/anyOf_option_names.md @@ -15,7 +15,8 @@ **Description:** JSON Schema for an fstab entry
- 1. [Required] Property root > storage + + 1. [Required] Property root > storage
diff --git a/docs/examples/examples_md_nested_default/array.md b/docs/examples/examples_md_nested_default/array.md index 0a55c107..597f8695 100644 --- a/docs/examples/examples_md_nested_default/array.md +++ b/docs/examples/examples_md_nested_default/array.md @@ -16,7 +16,8 @@ **Description:** A schema with an array
- 1. [Optional] Property root > fruits + + 1. [Optional] Property root > fruits
@@ -49,7 +50,8 @@
- 2. [Optional] Property root > vegetables + + 2. [Optional] Property root > vegetables
@@ -81,7 +83,8 @@ | **Defined in** | #/definitions/veggie |
- 2.1.1. [Required] Property root > vegetables > vegetables items > veggieName + + 2.1.1. [Required] Property root > vegetables > vegetables items > veggieName
@@ -97,7 +100,8 @@
- 2.1.2. [Required] Property root > vegetables > vegetables items > veggieLike + + 2.1.2. [Required] Property root > vegetables > vegetables items > veggieLike
diff --git a/docs/examples/examples_md_nested_default/array_additionalItems.md b/docs/examples/examples_md_nested_default/array_additionalItems.md index 639c8d6f..1ffe2893 100644 --- a/docs/examples/examples_md_nested_default/array_additionalItems.md +++ b/docs/examples/examples_md_nested_default/array_additionalItems.md @@ -18,7 +18,8 @@ **Description:** A little food fun
- 1. [Optional] Property root > address + + 1. [Optional] Property root > address
@@ -106,7 +107,8 @@ Must be one of:
- 2. [Optional] Property root > addressLines + + 2. [Optional] Property root > addressLines
@@ -141,7 +143,8 @@ Must be one of:
- 3. [Optional] Property root > arrayEmpty + + 3. [Optional] Property root > arrayEmpty
diff --git a/docs/examples/examples_md_nested_default/array_advanced.md b/docs/examples/examples_md_nested_default/array_advanced.md index ef5434fc..a04ccff9 100644 --- a/docs/examples/examples_md_nested_default/array_advanced.md +++ b/docs/examples/examples_md_nested_default/array_advanced.md @@ -15,7 +15,8 @@ **Description:** A little food fun
- 1. [Optional] Property root > fruits + + 1. [Optional] Property root > fruits
@@ -50,7 +51,8 @@
- 2. [Optional] Property root > vegetables + + 2. [Optional] Property root > vegetables
diff --git a/docs/examples/examples_md_nested_default/array_example.md b/docs/examples/examples_md_nested_default/array_example.md index a757d052..239b165f 100644 --- a/docs/examples/examples_md_nested_default/array_example.md +++ b/docs/examples/examples_md_nested_default/array_example.md @@ -12,7 +12,8 @@ **Description:** A schema with an array
- 1. [Optional] Property root > fruits + + 1. [Optional] Property root > fruits
diff --git a/docs/examples/examples_md_nested_default/basic.md b/docs/examples/examples_md_nested_default/basic.md index 11d324e9..ca119a12 100644 --- a/docs/examples/examples_md_nested_default/basic.md +++ b/docs/examples/examples_md_nested_default/basic.md @@ -16,7 +16,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > firstName + + 1. [Optional] Property Person > firstName
@@ -34,7 +35,8 @@
- 2. [Optional] Property Person > lastName + + 2. [Optional] Property Person > lastName
@@ -52,7 +54,8 @@
- 3. [Optional] Property Person > age + + 3. [Optional] Property Person > age
@@ -74,7 +77,8 @@
- 4. [Optional] Property Person > driverLicenseId + + 4. [Optional] Property Person > driverLicenseId
diff --git a/docs/examples/examples_md_nested_default/break_on_newline.md b/docs/examples/examples_md_nested_default/break_on_newline.md index 5e3838ec..ca762fdc 100644 --- a/docs/examples/examples_md_nested_default/break_on_newline.md +++ b/docs/examples/examples_md_nested_default/break_on_newline.md @@ -11,7 +11,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Hello > property1 + + 1. [Optional] Property Hello > property1
diff --git a/docs/examples/examples_md_nested_default/broken_ref.md b/docs/examples/examples_md_nested_default/broken_ref.md index e07dd0b0..fa0c7a42 100644 --- a/docs/examples/examples_md_nested_default/broken_ref.md +++ b/docs/examples/examples_md_nested_default/broken_ref.md @@ -12,7 +12,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > firstName + + 1. [Optional] Property Person > firstName
@@ -30,7 +31,8 @@
- 2. [Optional] Property Person > lastName + + 2. [Optional] Property Person > lastName
diff --git a/docs/examples/examples_md_nested_default/circular.md b/docs/examples/examples_md_nested_default/circular.md index 04879d8e..8484421c 100644 --- a/docs/examples/examples_md_nested_default/circular.md +++ b/docs/examples/examples_md_nested_default/circular.md @@ -12,7 +12,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Circular reference Schema > person + + 1. [Optional] Property Circular reference Schema > person
@@ -25,7 +26,8 @@ | **Defined in** | #/definitions/a |
- 1.1. [Optional] Property Circular reference Schema > person > a1 + + 1.1. [Optional] Property Circular reference Schema > person > a1
diff --git a/docs/examples/examples_md_nested_default/combining_not.md b/docs/examples/examples_md_nested_default/combining_not.md index 9f1b788c..f09d9a92 100644 --- a/docs/examples/examples_md_nested_default/combining_not.md +++ b/docs/examples/examples_md_nested_default/combining_not.md @@ -12,7 +12,8 @@ **Description:** Test schema with a not
- 1. [Required] Property root > not_a_string + + 1. [Required] Property root > not_a_string
diff --git a/docs/examples/examples_md_nested_default/combining_oneOf.md b/docs/examples/examples_md_nested_default/combining_oneOf.md index 2f8f90a4..1ee3cb6b 100644 --- a/docs/examples/examples_md_nested_default/combining_oneOf.md +++ b/docs/examples/examples_md_nested_default/combining_oneOf.md @@ -15,7 +15,8 @@ **Description:** JSON Schema for an fstab entry
- 1. [Required] Property root > storage + + 1. [Required] Property root > storage
diff --git a/docs/examples/examples_md_nested_default/conditional_subschema.md b/docs/examples/examples_md_nested_default/conditional_subschema.md index 1ef407de..c0ca0e85 100644 --- a/docs/examples/examples_md_nested_default/conditional_subschema.md +++ b/docs/examples/examples_md_nested_default/conditional_subschema.md @@ -22,7 +22,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1.1. [Optional] Property root > then > postal_code + + 1.1. [Optional] Property root > then > postal_code
@@ -49,7 +50,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 2.1. [Optional] Property root > else > postal_code + + 2.1. [Optional] Property root > else > postal_code
@@ -68,7 +70,8 @@
- 3. [Optional] Property root > street_address + + 3. [Optional] Property root > street_address
@@ -82,7 +85,8 @@
- 4. [Optional] Property root > country + + 4. [Optional] Property root > country
diff --git a/docs/examples/examples_md_nested_default/conditional_subschema_no_else.md b/docs/examples/examples_md_nested_default/conditional_subschema_no_else.md index dfb5beaa..cd4715bf 100644 --- a/docs/examples/examples_md_nested_default/conditional_subschema_no_else.md +++ b/docs/examples/examples_md_nested_default/conditional_subschema_no_else.md @@ -45,7 +45,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1.1.1. [Optional] Property root > allOf > item 0 > then > postal_code + + 1.1.1. [Optional] Property root > allOf > item 0 > then > postal_code
@@ -83,7 +84,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 2.1.1. [Optional] Property root > allOf > item 1 > then > postal_code + + 2.1.1. [Optional] Property root > allOf > item 1 > then > postal_code
@@ -121,7 +123,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 3.1.1. [Optional] Property root > allOf > item 2 > then > postal_code + + 3.1.1. [Optional] Property root > allOf > item 2 > then > postal_code
@@ -144,7 +147,8 @@
- 4. [Optional] Property root > street_address + + 4. [Optional] Property root > street_address
@@ -158,7 +162,8 @@
- 5. [Optional] Property root > country + + 5. [Optional] Property root > country
diff --git a/docs/examples/examples_md_nested_default/defaults.md b/docs/examples/examples_md_nested_default/defaults.md index dccc6018..2c9df505 100644 --- a/docs/examples/examples_md_nested_default/defaults.md +++ b/docs/examples/examples_md_nested_default/defaults.md @@ -10,7 +10,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property root > a + + 1. [Optional] Property root > a
@@ -29,7 +30,8 @@
- 2. [Optional] Property root > b + + 2. [Optional] Property root > b
diff --git a/docs/examples/examples_md_nested_default/deprecated.md b/docs/examples/examples_md_nested_default/deprecated.md index 4473ac2c..44cc1b32 100644 --- a/docs/examples/examples_md_nested_default/deprecated.md +++ b/docs/examples/examples_md_nested_default/deprecated.md @@ -15,7 +15,8 @@ **Description:** Test schema with deprecated in description
- 1. [Optional]~~ Property root > deprecated1~~ + + 1. [Optional]~~ Property root > deprecated1~~
@@ -33,7 +34,8 @@
- 2. [Optional]~~ Property root > deprecated2~~ + + 2. [Optional]~~ Property root > deprecated2~~
@@ -51,7 +53,8 @@
- 3. [Optional]~~ Property root > deprecated3~~ + + 3. [Optional]~~ Property root > deprecated3~~
@@ -69,7 +72,8 @@
- 4. [Optional]~~ Property root > deprecated4~~ + + 4. [Optional]~~ Property root > deprecated4~~
@@ -87,7 +91,8 @@
- 5. [Optional] Property root > not_deprecated + + 5. [Optional] Property root > not_deprecated
diff --git a/docs/examples/examples_md_nested_default/description_from_ref.md b/docs/examples/examples_md_nested_default/description_from_ref.md index 2b02626f..47478019 100644 --- a/docs/examples/examples_md_nested_default/description_from_ref.md +++ b/docs/examples/examples_md_nested_default/description_from_ref.md @@ -10,7 +10,8 @@ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
- 1. [Optional] Property root > name + + 1. [Optional] Property root > name
@@ -31,7 +32,8 @@
- 2. [Optional] Property root > alignment + + 2. [Optional] Property root > alignment
diff --git a/docs/examples/examples_md_nested_default/description_with_ref.md b/docs/examples/examples_md_nested_default/description_with_ref.md index 1bcfb4b6..05a19270 100644 --- a/docs/examples/examples_md_nested_default/description_with_ref.md +++ b/docs/examples/examples_md_nested_default/description_with_ref.md @@ -11,7 +11,8 @@ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
- 1. [Required] Property root > outer + + 1. [Required] Property root > outer
@@ -26,7 +27,8 @@ **Description:** We should see this
- 1.1. [Required] Property root > outer > inner + + 1.1. [Required] Property root > outer > inner
@@ -45,7 +47,8 @@
- 2. [Optional] Property root > outer2 + + 2. [Optional] Property root > outer2
diff --git a/docs/examples/examples_md_nested_default/empty_property_name.md b/docs/examples/examples_md_nested_default/empty_property_name.md index 31a620e3..4649fb97 100644 --- a/docs/examples/examples_md_nested_default/empty_property_name.md +++ b/docs/examples/examples_md_nested_default/empty_property_name.md @@ -11,7 +11,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. Property Empty property name > + + 1. Property Empty property name >
diff --git a/docs/examples/examples_md_nested_default/enumofnone.md b/docs/examples/examples_md_nested_default/enumofnone.md index 940beb19..9944763c 100644 --- a/docs/examples/examples_md_nested_default/enumofnone.md +++ b/docs/examples/examples_md_nested_default/enumofnone.md @@ -11,7 +11,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Enum of None > enumOfNone + + 1. [Optional] Property Enum of None > enumOfNone
diff --git a/docs/examples/examples_md_nested_default/geo.md b/docs/examples/examples_md_nested_default/geo.md index fca26dab..2404fa06 100644 --- a/docs/examples/examples_md_nested_default/geo.md +++ b/docs/examples/examples_md_nested_default/geo.md @@ -14,7 +14,8 @@ **Description:** A geographical coordinate.
- 1. [Required] Property Longitude and Latitude Values > latitude + + 1. [Required] Property Longitude and Latitude Values > latitude
@@ -33,7 +34,8 @@
- 2. [Required] Property Longitude and Latitude Values > longitude + + 2. [Required] Property Longitude and Latitude Values > longitude
diff --git a/docs/examples/examples_md_nested_default/long_description.md b/docs/examples/examples_md_nested_default/long_description.md index 7cd99464..532315bf 100644 --- a/docs/examples/examples_md_nested_default/long_description.md +++ b/docs/examples/examples_md_nested_default/long_description.md @@ -11,7 +11,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Long description > it_s_hard_to_explain + + 1. [Optional] Property Long description > it_s_hard_to_explain
diff --git a/docs/examples/examples_md_nested_default/multiple_types.md b/docs/examples/examples_md_nested_default/multiple_types.md index 5efea651..7c9924bb 100644 --- a/docs/examples/examples_md_nested_default/multiple_types.md +++ b/docs/examples/examples_md_nested_default/multiple_types.md @@ -14,7 +14,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > firstName + + 1. [Optional] Property Person > firstName
@@ -30,7 +31,8 @@
- 2. [Optional] Property Person > lastName + + 2. [Optional] Property Person > lastName
@@ -46,7 +48,8 @@
- 3. [Optional] Property Person > age + + 3. [Optional] Property Person > age
@@ -66,7 +69,8 @@
- 4. [Optional] Property Person > anything + + 4. [Optional] Property Person > anything
diff --git a/docs/examples/examples_md_nested_default/pattern_properties.md b/docs/examples/examples_md_nested_default/pattern_properties.md index 08973419..70838a2c 100644 --- a/docs/examples/examples_md_nested_default/pattern_properties.md +++ b/docs/examples/examples_md_nested_default/pattern_properties.md @@ -15,7 +15,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > firstName + + 1. [Optional] Property Person > firstName
@@ -33,7 +34,8 @@
- 2. [Optional] Property Person > lastName + + 2. [Optional] Property Person > lastName
@@ -51,7 +53,8 @@
- 3. [Optional]Pattern Property Person > paperSize + + 3. [Optional]Pattern Property Person > paperSize > All properties whose name matches the regular expression ```$[a-c][0-9]^``` ([Test](https://regex101.com/?regex=%24%5Ba-c%5D%5B0-9%5D%5E)) must respect the following conditions @@ -70,7 +73,8 @@ must respect the following conditions **Description:** Review of a paper size.
- 3.1. [Required] Property Person > paperSize > rating + + 3.1. [Required] Property Person > paperSize > rating
@@ -88,7 +92,8 @@ must respect the following conditions
- 3.2. [Required] Property Person > paperSize > review + + 3.2. [Required] Property Person > paperSize > review
diff --git a/docs/examples/examples_md_nested_default/pattern_properties_html_id.md b/docs/examples/examples_md_nested_default/pattern_properties_html_id.md index e3d34ab4..2244e9fb 100644 --- a/docs/examples/examples_md_nested_default/pattern_properties_html_id.md +++ b/docs/examples/examples_md_nested_default/pattern_properties_html_id.md @@ -15,7 +15,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > not_a_pattern + + 1. [Optional] Property Person > not_a_pattern
@@ -27,7 +28,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1.1. [Optional]Pattern Property Person > not_a_pattern > Title 4 + + 1.1. [Optional]Pattern Property Person > not_a_pattern > Title 4 > All properties whose name matches the regular expression ```.$``` ([Test](https://regex101.com/?regex=.%24)) must respect the following conditions @@ -52,7 +54,8 @@ must respect the following conditions
- 2. [Optional]Pattern Property Person > Title 1 + + 2. [Optional]Pattern Property Person > Title 1 > All properties whose name matches the regular expression ```.*``` ([Test](https://regex101.com/?regex=.%2A)) must respect the following conditions @@ -74,7 +77,8 @@ must respect the following conditions
- 3. [Optional]Pattern Property Person > Title 2 + + 3. [Optional]Pattern Property Person > Title 2 > All properties whose name matches the regular expression ```..``` ([Test](https://regex101.com/?regex=..)) must respect the following conditions @@ -96,7 +100,8 @@ must respect the following conditions
- 4. [Optional]Pattern Property Person > Title 3 + + 4. [Optional]Pattern Property Person > Title 3 > All properties whose name matches the regular expression ```^.``` ([Test](https://regex101.com/?regex=%5E.)) must respect the following conditions diff --git a/docs/examples/examples_md_nested_default/prefixItems.md b/docs/examples/examples_md_nested_default/prefixItems.md index 3c17f151..b7911120 100644 --- a/docs/examples/examples_md_nested_default/prefixItems.md +++ b/docs/examples/examples_md_nested_default/prefixItems.md @@ -15,7 +15,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Address > address + + 1. [Optional] Property Address > address
diff --git a/docs/examples/examples_md_nested_default/recursive.md b/docs/examples/examples_md_nested_default/recursive.md index 8922b9be..4d41f805 100644 --- a/docs/examples/examples_md_nested_default/recursive.md +++ b/docs/examples/examples_md_nested_default/recursive.md @@ -13,7 +13,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > person + + 1. [Optional] Property Person > person
@@ -28,7 +29,8 @@ **Description:** A human being
- 1.1. [Optional] Property Person > person > children + + 1.1. [Optional] Property Person > person > children
diff --git a/docs/examples/examples_md_nested_default/recursive_array.md b/docs/examples/examples_md_nested_default/recursive_array.md index 7e3c2766..19dd1fd4 100644 --- a/docs/examples/examples_md_nested_default/recursive_array.md +++ b/docs/examples/examples_md_nested_default/recursive_array.md @@ -14,7 +14,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > person + + 1. [Optional] Property Person > person
@@ -50,7 +51,8 @@ **Description:** A human being
- 1.1.1. [Optional] Property Person > person > person items > children + + 1.1.1. [Optional] Property Person > person > person items > children
diff --git a/docs/examples/examples_md_nested_default/recursive_full_schema.md b/docs/examples/examples_md_nested_default/recursive_full_schema.md index 7c30dc66..9ead5e84 100644 --- a/docs/examples/examples_md_nested_default/recursive_full_schema.md +++ b/docs/examples/examples_md_nested_default/recursive_full_schema.md @@ -19,7 +19,8 @@ **Description:** Display the issue.
- 1. [Optional] Property Bug > Code + + 1. [Optional] Property Bug > Code
@@ -35,7 +36,8 @@
- 2. [Optional] Property Bug > RecursiveArray + + 2. [Optional] Property Bug > RecursiveArray
@@ -74,7 +76,8 @@
- 3. [Optional] Property Bug > DecoratedRecursiveArray + + 3. [Optional] Property Bug > DecoratedRecursiveArray
@@ -107,7 +110,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 3.1.1. [Optional] Property Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > SomeName + + 3.1.1. [Optional] Property Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > SomeName
@@ -121,7 +125,8 @@
- 3.1.2. [Optional] Property Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > TheThing + + 3.1.2. [Optional] Property Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > TheThing
diff --git a/docs/examples/examples_md_nested_default/recursive_full_schema_simple.md b/docs/examples/examples_md_nested_default/recursive_full_schema_simple.md index af302042..d3131c2a 100644 --- a/docs/examples/examples_md_nested_default/recursive_full_schema_simple.md +++ b/docs/examples/examples_md_nested_default/recursive_full_schema_simple.md @@ -11,7 +11,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > itself + + 1. [Optional] Property Person > itself
diff --git a/docs/examples/examples_md_nested_default/recursive_parent_in_definition.md b/docs/examples/examples_md_nested_default/recursive_parent_in_definition.md index bc22feb5..4f05e51f 100644 --- a/docs/examples/examples_md_nested_default/recursive_parent_in_definition.md +++ b/docs/examples/examples_md_nested_default/recursive_parent_in_definition.md @@ -14,7 +14,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > relationships + + 1. [Optional] Property Person > relationships
@@ -29,7 +30,8 @@ **Description:** Relationships between this person and others
- 1.1. [Optional] Property Person > relationships > mother + + 1.1. [Optional] Property Person > relationships > mother
@@ -44,7 +46,8 @@ **Description:** A human being
- 1.1.1. [Optional] Property Person > relationships > mother > relationships + + 1.1.1. [Optional] Property Person > relationships > mother > relationships
@@ -58,7 +61,8 @@ **Description:** Relationships between this person and others
- 1.1.1.1. [Optional] Property Person > relationships > mother > relationships > mother + + 1.1.1.1. [Optional] Property Person > relationships > mother > relationships > mother
diff --git a/docs/examples/examples_md_nested_default/recursive_two_files.md b/docs/examples/examples_md_nested_default/recursive_two_files.md index 4e354b60..edbb3eed 100644 --- a/docs/examples/examples_md_nested_default/recursive_two_files.md +++ b/docs/examples/examples_md_nested_default/recursive_two_files.md @@ -14,7 +14,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > person + + 1. [Optional] Property Person > person
@@ -29,7 +30,8 @@ **Description:** A human being
- 1.1. [Optional] Property Person > person > children + + 1.1. [Optional] Property Person > person > children
@@ -68,7 +70,8 @@
- 1.2. [Optional] Property Person > person > siblings + + 1.2. [Optional] Property Person > person > siblings
diff --git a/docs/examples/examples_md_nested_default/ref_merge.md b/docs/examples/examples_md_nested_default/ref_merge.md index df215ed9..86981e08 100644 --- a/docs/examples/examples_md_nested_default/ref_merge.md +++ b/docs/examples/examples_md_nested_default/ref_merge.md @@ -14,7 +14,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Test > aProperty + + 1. [Optional] Property Test > aProperty
@@ -36,7 +37,8 @@ Must be one of:
- 2. [Optional] Property Test > aDictPropertyARequired + + 2. [Optional] Property Test > aDictPropertyARequired
@@ -50,7 +52,8 @@ Must be one of: | **Defined in** | #/definitions/aDictProperty |
- 2.1. [Required] Property Test > aDictPropertyARequired > a + + 2.1. [Required] Property Test > aDictPropertyARequired > a
@@ -64,7 +67,8 @@ Must be one of:
- 2.2. [Required] Property Test > aDictPropertyARequired > b + + 2.2. [Required] Property Test > aDictPropertyARequired > b
diff --git a/docs/examples/examples_md_nested_default/ref_with_tabs.md b/docs/examples/examples_md_nested_default/ref_with_tabs.md index 68bac5e0..6f2bce15 100644 --- a/docs/examples/examples_md_nested_default/ref_with_tabs.md +++ b/docs/examples/examples_md_nested_default/ref_with_tabs.md @@ -46,7 +46,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property root > objectA + + 1. [Optional] Property root > objectA
@@ -58,7 +59,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1.1. [Optional] Property root > objectA > signature + + 1.1. [Optional] Property root > objectA > signature
@@ -91,7 +93,8 @@ | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
- 1.1.1.1. [Optional] Property root > objectA > signature > oneOf > item 0 > signers + + 1.1.1.1. [Optional] Property root > objectA > signature > oneOf > item 0 > signers
@@ -127,7 +130,8 @@ | **Defined in** | #/definitions/signer |
- 1.1.1.1.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm + + 1.1.1.1.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm
@@ -197,7 +201,8 @@ Must be one of:
- 1.1.1.1.1.2. [Optional] Property root > objectA > signature > oneOf > item 0 > signers > Signature > keyId + + 1.1.1.1.1.2. [Optional] Property root > objectA > signature > oneOf > item 0 > signers > Signature > keyId
@@ -215,7 +220,8 @@ Must be one of:
- 1.1.1.1.1.3. [Optional] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey + + 1.1.1.1.1.3. [Optional] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey
@@ -258,7 +264,8 @@ Must be one of: | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
- 1.1.1.1.1.3.1.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty + + 1.1.1.1.1.3.1.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty
@@ -275,7 +282,8 @@ Must be one of:
- 1.1.1.1.1.3.1.1.2. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > crv + + 1.1.1.1.1.3.1.1.2. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > crv
@@ -298,7 +306,8 @@ Must be one of:
- 1.1.1.1.1.3.1.1.3. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > x + + 1.1.1.1.1.3.1.1.3. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > x
@@ -316,7 +325,8 @@ Must be one of:
- 1.1.1.1.1.3.1.1.4. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > y + + 1.1.1.1.1.3.1.1.4. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > y
@@ -353,7 +363,8 @@ Must be one of: | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
- 1.1.1.1.1.3.2.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty + + 1.1.1.1.1.3.2.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty
@@ -370,7 +381,8 @@ Must be one of:
- 1.1.1.1.1.3.2.1.2. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > crv + + 1.1.1.1.1.3.2.1.2. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > crv
@@ -392,7 +404,8 @@ Must be one of:
- 1.1.1.1.1.3.2.1.3. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > x + + 1.1.1.1.1.3.2.1.3. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > x
@@ -429,7 +442,8 @@ Must be one of: | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
- 1.1.1.1.1.3.3.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty + + 1.1.1.1.1.3.3.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty
@@ -446,7 +460,8 @@ Must be one of:
- 1.1.1.1.1.3.3.1.2. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > n + + 1.1.1.1.1.3.3.1.2. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > n
@@ -464,7 +479,8 @@ Must be one of:
- 1.1.1.1.1.3.3.1.3. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > e + + 1.1.1.1.1.3.3.1.3. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > e
@@ -486,7 +502,8 @@ Must be one of:
- 1.1.1.1.1.3.4. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > kty + + 1.1.1.1.1.3.4. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > kty
@@ -511,7 +528,8 @@ Must be one of:
- 1.1.1.1.1.4. [Optional] Property root > objectA > signature > oneOf > item 0 > signers > Signature > certificatePath + + 1.1.1.1.1.4. [Optional] Property root > objectA > signature > oneOf > item 0 > signers > Signature > certificatePath
@@ -548,7 +566,8 @@ Must be one of:
- 1.1.1.1.1.5. [Optional] Property root > objectA > signature > oneOf > item 0 > signers > Signature > excludes + + 1.1.1.1.1.5. [Optional] Property root > objectA > signature > oneOf > item 0 > signers > Signature > excludes
@@ -585,7 +604,8 @@ Must be one of:
- 1.1.1.1.1.6. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > value + + 1.1.1.1.1.6. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > value
@@ -617,7 +637,8 @@ Must be one of: | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
- 1.1.2.1. [Optional] Property root > objectA > signature > oneOf > item 1 > chain + + 1.1.2.1. [Optional] Property root > objectA > signature > oneOf > item 1 > chain
@@ -682,7 +703,8 @@ Must be one of:
- 2. [Optional] Property root > objectB + + 2. [Optional] Property root > objectB
@@ -694,7 +716,8 @@ Must be one of: | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 2.1. [Optional] Property root > objectB > signature + + 2.1. [Optional] Property root > objectB > signature
diff --git a/docs/examples/examples_md_nested_default/reference_int.md b/docs/examples/examples_md_nested_default/reference_int.md index f532e921..062d6e15 100644 --- a/docs/examples/examples_md_nested_default/reference_int.md +++ b/docs/examples/examples_md_nested_default/reference_int.md @@ -12,7 +12,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > extra_options_object + + 1. [Optional] Property Person > extra_options_object
@@ -30,7 +31,8 @@
- 2. [Optional] Property Person > name_looks_like_an_int + + 2. [Optional] Property Person > name_looks_like_an_int
diff --git a/docs/examples/examples_md_nested_default/references.md b/docs/examples/examples_md_nested_default/references.md index 542891c5..04681cb9 100644 --- a/docs/examples/examples_md_nested_default/references.md +++ b/docs/examples/examples_md_nested_default/references.md @@ -29,7 +29,8 @@ **Description:** Testing $ref
- 1. [Optional] Property root > a_gift + + 1. [Optional] Property root > a_gift
@@ -46,7 +47,8 @@
- 2. [Optional] Property root > file_prefix + + 2. [Optional] Property root > file_prefix
@@ -63,7 +65,8 @@
- 3. [Optional] Property root > anchor_with_slash + + 3. [Optional] Property root > anchor_with_slash
@@ -76,7 +79,8 @@ | **Defined in** | #/definitions/object_def |
- 3.1. [Optional] Property root > anchor_with_slash > propertyA + + 3.1. [Optional] Property root > anchor_with_slash > propertyA
@@ -95,7 +99,8 @@
- 4. [Optional] Property root > anchor_no_slash + + 4. [Optional] Property root > anchor_no_slash
@@ -131,7 +136,8 @@
- 5. [Optional] Property root > anchor_nested_reference + + 5. [Optional] Property root > anchor_nested_reference
@@ -146,7 +152,8 @@
- 6. [Optional] Property root > same_file_anchor_with_slash + + 6. [Optional] Property root > same_file_anchor_with_slash
@@ -163,7 +170,8 @@
- 7. [Optional] Property root > same_file_anchor_no_slash + + 7. [Optional] Property root > same_file_anchor_no_slash
@@ -179,7 +187,8 @@
- 8. [Optional] Property root > same_file_nested_reference + + 8. [Optional] Property root > same_file_nested_reference
@@ -194,7 +203,8 @@
- 9. [Optional] Property root > other_file_anchor + + 9. [Optional] Property root > other_file_anchor
@@ -209,7 +219,8 @@ **Description:** The delivery is a gift, no prices displayed
- 9.1. [Optional] Property root > other_file_anchor > with_wrap + + 9.1. [Optional] Property root > other_file_anchor > with_wrap
@@ -226,7 +237,8 @@
- 10. [Optional] Property root > other_file_dot_anchor + + 10. [Optional] Property root > other_file_dot_anchor
@@ -244,7 +256,8 @@
- 11. [Optional] Property root > other_file_dot_dot_anchor + + 11. [Optional] Property root > other_file_dot_dot_anchor
@@ -262,7 +275,8 @@
- 12. [Optional] Property root > other_file_only + + 12. [Optional] Property root > other_file_only
@@ -277,7 +291,8 @@ **Description:** Test schema with a not
- 12.1. [Required] Property root > other_file_only > not_a_string + + 12.1. [Required] Property root > other_file_only > not_a_string
@@ -302,7 +317,8 @@
- 13. [Optional] Property root > multi_hierarchy_reference + + 13. [Optional] Property root > multi_hierarchy_reference
@@ -315,7 +331,8 @@ | **Defined in** | reference_schemas/intermediate.json#/properties/cross_file_reference |
- 13.1. [Optional] Property root > multi_hierarchy_reference > propertyA + + 13.1. [Optional] Property root > multi_hierarchy_reference > propertyA
diff --git a/docs/examples/examples_md_nested_default/references_url.md b/docs/examples/examples_md_nested_default/references_url.md index 5ee05d64..4717d138 100644 --- a/docs/examples/examples_md_nested_default/references_url.md +++ b/docs/examples/examples_md_nested_default/references_url.md @@ -11,7 +11,8 @@ **Description:** Testing $ref with URL
- 1. [Optional] Property root > firstName + + 1. [Optional] Property root > firstName
diff --git a/docs/examples/examples_md_nested_default/references_url_two_levels.md b/docs/examples/examples_md_nested_default/references_url_two_levels.md index f4338f2a..3df4ac2f 100644 --- a/docs/examples/examples_md_nested_default/references_url_two_levels.md +++ b/docs/examples/examples_md_nested_default/references_url_two_levels.md @@ -13,7 +13,8 @@ **Description:** Testing $ref of a remote $ref
- 1. [Optional] Property root > described + + 1. [Optional] Property root > described
@@ -26,7 +27,8 @@ | **Defined in** | https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/description_from_ref.json |
- 1.1. [Optional] Property root > described > name + + 1.1. [Optional] Property root > described > name
@@ -47,7 +49,8 @@
- 1.2. [Optional] Property root > described > alignment + + 1.2. [Optional] Property root > described > alignment
diff --git a/docs/examples/examples_md_nested_default/references_url_yaml.md b/docs/examples/examples_md_nested_default/references_url_yaml.md index b609ba0e..131495d7 100644 --- a/docs/examples/examples_md_nested_default/references_url_yaml.md +++ b/docs/examples/examples_md_nested_default/references_url_yaml.md @@ -14,7 +14,8 @@ **Description:** Testing $ref with URL with YAML destination
- 1. [Optional] Property root > address + + 1. [Optional] Property root > address
@@ -27,7 +28,8 @@ | **Defined in** | https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/yaml.yaml#/definitions/address |
- 1.1. [Required] Property root > address > street_address + + 1.1. [Required] Property root > address > street_address
@@ -41,7 +43,8 @@
- 1.2. [Required] Property root > address > city + + 1.2. [Required] Property root > address > city
@@ -55,7 +58,8 @@
- 1.3. [Required] Property root > address > state + + 1.3. [Required] Property root > address > state
diff --git a/docs/examples/examples_md_nested_default/required_properties_order.md b/docs/examples/examples_md_nested_default/required_properties_order.md index 663f80d5..ee406fbf 100644 --- a/docs/examples/examples_md_nested_default/required_properties_order.md +++ b/docs/examples/examples_md_nested_default/required_properties_order.md @@ -14,7 +14,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Undocumented Required Properties order > group1 + + 1. [Optional] Property Undocumented Required Properties order > group1
@@ -33,7 +34,8 @@
- 2. [Optional] Property Undocumented Required Properties order > group2 + + 2. [Optional] Property Undocumented Required Properties order > group2
diff --git a/docs/examples/examples_md_nested_default/single_element_allOf.md b/docs/examples/examples_md_nested_default/single_element_allOf.md index 1fb572f2..1244bf32 100644 --- a/docs/examples/examples_md_nested_default/single_element_allOf.md +++ b/docs/examples/examples_md_nested_default/single_element_allOf.md @@ -14,7 +14,8 @@ **Description:** Schema containing a single-element allOf
- 1. [Optional] Property Schema containing a single-element allOf > prop1 + + 1. [Optional] Property Schema containing a single-element allOf > prop1
@@ -32,7 +33,8 @@
- 2. [Optional] Property Schema containing a single-element allOf > prop2 + + 2. [Optional] Property Schema containing a single-element allOf > prop2
diff --git a/docs/examples/examples_md_nested_default/type_object_null.md b/docs/examples/examples_md_nested_default/type_object_null.md index 721f6bfd..eb22a78c 100644 --- a/docs/examples/examples_md_nested_default/type_object_null.md +++ b/docs/examples/examples_md_nested_default/type_object_null.md @@ -12,7 +12,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > prop1 + + 1. [Optional] Property Person > prop1
@@ -23,7 +24,8 @@ | **Required** | No |
- 1.1. [Optional] Property Person > prop1 > lol + + 1.1. [Optional] Property Person > prop1 > lol
diff --git a/docs/examples/examples_md_nested_default/with_default.md b/docs/examples/examples_md_nested_default/with_default.md index f8455717..3495147f 100644 --- a/docs/examples/examples_md_nested_default/with_default.md +++ b/docs/examples/examples_md_nested_default/with_default.md @@ -14,7 +14,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property User Preference > favorite_os + + 1. [Optional] Property User Preference > favorite_os
@@ -34,7 +35,8 @@ Must be one of:
- 2. [Optional] Property User Preference > favorite_colors + + 2. [Optional] Property User Preference > favorite_colors
@@ -76,7 +78,8 @@ Must be one of:
- 3. [Optional] Property User Preference > desired_number_of_shoes + + 3. [Optional] Property User Preference > desired_number_of_shoes
diff --git a/docs/examples/examples_md_nested_default/with_definitions.md b/docs/examples/examples_md_nested_default/with_definitions.md index dc5144cc..42926780 100644 --- a/docs/examples/examples_md_nested_default/with_definitions.md +++ b/docs/examples/examples_md_nested_default/with_definitions.md @@ -14,7 +14,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property root > billing_address + + 1. [Optional] Property root > billing_address
@@ -27,7 +28,8 @@ | **Defined in** | #/definitions/address |
- 1.1. [Required] Property root > billing_address > street_address + + 1.1. [Required] Property root > billing_address > street_address
@@ -41,7 +43,8 @@
- 1.2. [Required] Property root > billing_address > city + + 1.2. [Required] Property root > billing_address > city
@@ -55,7 +58,8 @@
- 1.3. [Required] Property root > billing_address > state + + 1.3. [Required] Property root > billing_address > state
@@ -69,7 +73,8 @@
- 1.4. [Optional] Property root > billing_address > futureProperty + + 1.4. [Optional] Property root > billing_address > futureProperty
@@ -86,7 +91,8 @@
- 2. [Optional] Property root > shipping_address + + 2. [Optional] Property root > shipping_address
diff --git a/docs/examples/examples_md_nested_default/with_descriptions.md b/docs/examples/examples_md_nested_default/with_descriptions.md index 557a6ce4..649bde7b 100644 --- a/docs/examples/examples_md_nested_default/with_descriptions.md +++ b/docs/examples/examples_md_nested_default/with_descriptions.md @@ -20,7 +20,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Delivery Schema > shipping_address + + 1. [Optional] Property Delivery Schema > shipping_address
@@ -35,7 +36,8 @@ **Description:** Exact address
- 1.1. [Required] Property Delivery Schema > shipping_address > street_address + + 1.1. [Required] Property Delivery Schema > shipping_address > street_address
@@ -49,7 +51,8 @@
- 1.2. [Required] Property Delivery Schema > shipping_address > city + + 1.2. [Required] Property Delivery Schema > shipping_address > city
@@ -63,7 +66,8 @@
- 1.3. [Required] Property Delivery Schema > shipping_address > state + + 1.3. [Required] Property Delivery Schema > shipping_address > state
@@ -80,7 +84,8 @@
- 2. [Optional] Property Delivery Schema > billing_address + + 2. [Optional] Property Delivery Schema > billing_address
@@ -98,7 +103,8 @@
- 3. [Optional] Property Delivery Schema > delivery_info + + 3. [Optional] Property Delivery Schema > delivery_info
@@ -131,7 +137,8 @@ | **Defined in** | #/definitions/classic |
- 3.1.1. [Optional] Property Delivery Schema > delivery_info > oneOf > item 0 > price + + 3.1.1. [Optional] Property Delivery Schema > delivery_info > oneOf > item 0 > price
@@ -159,7 +166,8 @@ **Description:** The delivery is a gift, no prices displayed
- 3.2.1. [Optional] Property Delivery Schema > delivery_info > oneOf > item 1 > with_wrap + + 3.2.1. [Optional] Property Delivery Schema > delivery_info > oneOf > item 1 > with_wrap
diff --git a/docs/examples/examples_md_nested_default/with_examples.md b/docs/examples/examples_md_nested_default/with_examples.md index 706b18a3..85833ae4 100644 --- a/docs/examples/examples_md_nested_default/with_examples.md +++ b/docs/examples/examples_md_nested_default/with_examples.md @@ -14,7 +14,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > firstName + + 1. [Optional] Property Person > firstName
@@ -41,7 +42,8 @@
- 2. [Optional] Property Person > lastName + + 2. [Optional] Property Person > lastName
@@ -65,7 +67,8 @@
- 3. [Optional] Property Person > age + + 3. [Optional] Property Person > age
@@ -93,7 +96,8 @@
- 4. [Optional] Property Person > moreInfo + + 4. [Optional] Property Person > moreInfo
diff --git a/docs/examples/examples_md_nested_default/with_keywords.md b/docs/examples/examples_md_nested_default/with_keywords.md index b6a0cfc2..0f6779ae 100644 --- a/docs/examples/examples_md_nested_default/with_keywords.md +++ b/docs/examples/examples_md_nested_default/with_keywords.md @@ -21,7 +21,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Required] Property Person > default + + 1. [Required] Property Person > default
@@ -37,7 +38,8 @@
- 2. [Required] Property Person > examples + + 2. [Required] Property Person > examples
@@ -53,7 +55,8 @@
- 3. [Optional] Property Person > if + + 3. [Optional] Property Person > if
@@ -70,7 +73,8 @@
- 4. [Optional] Property Person > then + + 4. [Optional] Property Person > then
@@ -87,7 +91,8 @@
- 5. [Optional] Property Person > else + + 5. [Optional] Property Person > else
@@ -104,7 +109,8 @@
- 6. [Optional] Property Person > anyOf + + 6. [Optional] Property Person > anyOf
@@ -121,7 +127,8 @@
- 7. [Optional] Property Person > allOf + + 7. [Optional] Property Person > allOf
@@ -138,7 +145,8 @@
- 8. [Optional] Property Person > not + + 8. [Optional] Property Person > not
@@ -155,7 +163,8 @@
- 9. [Optional] Property Person > properties + + 9. [Optional] Property Person > properties
@@ -172,7 +181,8 @@
- 10. [Optional] Property Person > patternProperties + + 10. [Optional] Property Person > patternProperties
@@ -189,7 +199,8 @@
- 11. [Optional] Property Person > required + + 11. [Optional] Property Person > required
diff --git a/docs/examples/examples_md_nested_default/with_special_chars.md b/docs/examples/examples_md_nested_default/with_special_chars.md index fcd3744a..a7d0a6b9 100644 --- a/docs/examples/examples_md_nested_default/with_special_chars.md +++ b/docs/examples/examples_md_nested_default/with_special_chars.md @@ -16,7 +16,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Personne > prénom + + 1. [Optional] Property Personne > prénom
@@ -32,7 +33,8 @@
- 2. [Optional] Property Personne > nomDeFamille + + 2. [Optional] Property Personne > nomDeFamille
@@ -48,7 +50,8 @@
- 3. [Optional] Property Personne > âge + + 3. [Optional] Property Personne > âge
@@ -68,7 +71,8 @@
- 4. [Optional] Property Personne > 0 de quoi d'autre + + 4. [Optional] Property Personne > 0 de quoi d'autre
@@ -94,7 +98,8 @@
- 5. [Optional] Property Personne > 名前 + + 5. [Optional] Property Personne > 名前
@@ -110,7 +115,8 @@
- 6. [Optional] Property Personne > 年齢 + + 6. [Optional] Property Personne > 年齢
diff --git a/docs/examples/examples_md_nested_default/with_urlencoded_anchor.md b/docs/examples/examples_md_nested_default/with_urlencoded_anchor.md index 24dcb77d..273d047e 100644 --- a/docs/examples/examples_md_nested_default/with_urlencoded_anchor.md +++ b/docs/examples/examples_md_nested_default/with_urlencoded_anchor.md @@ -13,7 +13,8 @@ | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property root > signingTimeInfo + + 1. [Optional] Property root > signingTimeInfo
@@ -26,7 +27,8 @@ | **Defined in** | #/definitions/dss2-SigningTimeInfoType |
- 1.1. [Required] Property root > signingTimeInfo > signingTime + + 1.1. [Required] Property root > signingTimeInfo > signingTime
@@ -41,7 +43,8 @@
- 1.2. [Optional] Property root > signingTimeInfo > signingTimeBounds + + 1.2. [Optional] Property root > signingTimeInfo > signingTimeBounds
@@ -54,7 +57,8 @@ | **Defined in** | #/definitions/dss2-SigningTimeInfoType%3ASigningTimeBoundaries |
- 1.2.1. [Optional] Property root > signingTimeInfo > signingTimeBounds > lowerBound + + 1.2.1. [Optional] Property root > signingTimeInfo > signingTimeBounds > lowerBound
@@ -69,7 +73,8 @@
- 1.2.2. [Optional] Property root > signingTimeInfo > signingTimeBounds > upperBound + + 1.2.2. [Optional] Property root > signingTimeInfo > signingTimeBounds > upperBound
diff --git a/docs/examples/examples_md_nested_with_badges/Configuration.md b/docs/examples/examples_md_nested_with_badges/Configuration.md index fe03fa26..714bb560 100644 --- a/docs/examples/examples_md_nested_with_badges/Configuration.md +++ b/docs/examples/examples_md_nested_with_badges/Configuration.md @@ -23,6 +23,8 @@ - [20.1. [Optional] Property JSON Schema for Humans configuration file > template_md_options > badge_as_image](#template_md_options_badge_as_image) - [20.2. [Optional] Property JSON Schema for Humans configuration file > template_md_options > show_heading_numbers](#template_md_options_show_heading_numbers) - [20.3. [Optional] Property JSON Schema for Humans configuration file > template_md_options > show_array_restrictions](#template_md_options_show_array_restrictions) + - [20.4. [Optional] Property JSON Schema for Humans configuration file > template_md_options > properties_table_columns](#template_md_options_properties_table_columns) + - [20.4.1. JSON Schema for Humans configuration file > template_md_options > properties_table_columns > properties_table_columns items](#autogenerated_heading_2) - [21. [Optional] Property JSON Schema for Humans configuration file > with_footer](#with_footer) - [22. [Optional] Property JSON Schema for Humans configuration file > footer_show_time](#footer_show_time) @@ -42,7 +44,8 @@ Configuration parameters can be provided in several ways: - From code, by providing a GenerationConfiguration object to the called generation method.
- 1. [Optional] Property JSON Schema for Humans configuration file > minify + + 1. [Optional] Property JSON Schema for Humans configuration file > minify
@@ -58,7 +61,8 @@ Configuration parameters can be provided in several ways:
- 2. [Optional] Property JSON Schema for Humans configuration file > description_is_markdown + + 2. [Optional] Property JSON Schema for Humans configuration file > description_is_markdown
@@ -74,7 +78,8 @@ Configuration parameters can be provided in several ways:
- 3. [Optional] Property JSON Schema for Humans configuration file > expand_buttons + + 3. [Optional] Property JSON Schema for Humans configuration file > expand_buttons
@@ -90,7 +95,8 @@ Configuration parameters can be provided in several ways:
- 4. [Optional] Property JSON Schema for Humans configuration file > show_breadcrumbs + + 4. [Optional] Property JSON Schema for Humans configuration file > show_breadcrumbs
@@ -106,7 +112,8 @@ Configuration parameters can be provided in several ways:
- 5. [Optional] Property JSON Schema for Humans configuration file > collapse_long_descriptions + + 5. [Optional] Property JSON Schema for Humans configuration file > collapse_long_descriptions
@@ -122,7 +129,8 @@ Configuration parameters can be provided in several ways:
- 6. [Optional] Property JSON Schema for Humans configuration file > collapse_long_examples + + 6. [Optional] Property JSON Schema for Humans configuration file > collapse_long_examples
@@ -138,7 +146,8 @@ Configuration parameters can be provided in several ways:
- 7. [Optional] Property JSON Schema for Humans configuration file > link_to_reused_ref + + 7. [Optional] Property JSON Schema for Humans configuration file > link_to_reused_ref
@@ -156,7 +165,8 @@ Configuration parameters can be provided in several ways:
- 8. [Optional] Property JSON Schema for Humans configuration file > recursive_detection_depth + + 8. [Optional] Property JSON Schema for Humans configuration file > recursive_detection_depth
@@ -177,7 +187,8 @@ In other words, if a schema has a deeply nested element that refers to itself, t
- 9. [Optional]~~ Property JSON Schema for Humans configuration file > deprecated_from_description~~ + + 9. [Optional]~~ Property JSON Schema for Humans configuration file > deprecated_from_description~~
@@ -194,7 +205,8 @@ In other words, if a schema has a deeply nested element that refers to itself, t
- 10. [Optional] Property JSON Schema for Humans configuration file > default_from_description + + 10. [Optional] Property JSON Schema for Humans configuration file > default_from_description
@@ -212,7 +224,8 @@ The default value from the "default" attribute will be used in priority.
- 11. [Optional] Property JSON Schema for Humans configuration file > copy_css + + 11. [Optional] Property JSON Schema for Humans configuration file > copy_css
@@ -228,7 +241,8 @@ The default value from the "default" attribute will be used in priority.
- 12. [Optional] Property JSON Schema for Humans configuration file > copy_js + + 12. [Optional] Property JSON Schema for Humans configuration file > copy_js
@@ -246,7 +260,8 @@ This file contains the logic for the anchor links.
- 13. [Optional]~~ Property JSON Schema for Humans configuration file > templates_directory~~ + + 13. [Optional]~~ Property JSON Schema for Humans configuration file > templates_directory~~
@@ -262,7 +277,8 @@ This file contains the logic for the anchor links.
- 14. [Optional] Property JSON Schema for Humans configuration file > template_name + + 14. [Optional] Property JSON Schema for Humans configuration file > template_name
@@ -295,7 +311,8 @@ Must be one of:
- 15. [Optional] Property JSON Schema for Humans configuration file > custom_template_path + + 15. [Optional] Property JSON Schema for Humans configuration file > custom_template_path
@@ -315,7 +332,8 @@ If no output file is specified, the extension of the template file will be used
- 16. [Optional] Property JSON Schema for Humans configuration file > show_toc + + 16. [Optional] Property JSON Schema for Humans configuration file > show_toc
@@ -331,7 +349,8 @@ If no output file is specified, the extension of the template file will be used
- 17. [Optional] Property JSON Schema for Humans configuration file > examples_as_yaml + + 17. [Optional] Property JSON Schema for Humans configuration file > examples_as_yaml
@@ -347,7 +366,8 @@ If no output file is specified, the extension of the template file will be used
- 18. [Optional] Property JSON Schema for Humans configuration file > old_anchor_links + + 18. [Optional] Property JSON Schema for Humans configuration file > old_anchor_links
@@ -365,7 +385,8 @@ This is the old behaviour and is only needed for browsers that do not support HT
- 19. [Optional] Property JSON Schema for Humans configuration file > markdown_options + + 19. [Optional] Property JSON Schema for Humans configuration file > markdown_options
@@ -398,7 +419,8 @@ Adding an extra, even if the value is false, will activate it. For example `{"br
- 20. [Optional] Property JSON Schema for Humans configuration file > template_md_options + + 20. [Optional] Property JSON Schema for Humans configuration file > template_md_options
@@ -411,7 +433,8 @@ Adding an extra, even if the value is false, will activate it. For example `{"br **Description:** specific options to md template
- 20.1. [Optional] Property JSON Schema for Humans configuration file > template_md_options > badge_as_image + + 20.1. [Optional] Property JSON Schema for Humans configuration file > template_md_options > badge_as_image
@@ -429,7 +452,8 @@ Adding an extra, even if the value is false, will activate it. For example `{"br
- 20.2. [Optional] Property JSON Schema for Humans configuration file > template_md_options > show_heading_numbers + + 20.2. [Optional] Property JSON Schema for Humans configuration file > template_md_options > show_heading_numbers
@@ -447,7 +471,8 @@ Adding an extra, even if the value is false, will activate it. For example `{"br
- 20.3. [Optional] Property JSON Schema for Humans configuration file > template_md_options > show_array_restrictions + + 20.3. [Optional] Property JSON Schema for Humans configuration file > template_md_options > show_array_restrictions
@@ -464,11 +489,56 @@ Adding an extra, even if the value is false, will activate it. For example `{"br
+
+ + 20.4. [Optional] Property JSON Schema for Humans configuration file > template_md_options > properties_table_columns + + +
+ +| | | +| -------- | --------------------------- | +| **Type** | `array of enum (of string)` | + +**Description:** array of column names to display in the properties table. + + if empty, the default is ['Property','Pattern','Type','Deprecated','Definition','Title/Description'] + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| ------------------------------------------------------------------------------------- | ----------- | +| [properties_table_columns items](#template_md_options_properties_table_columns_items) | - | + +#### 20.4.1. JSON Schema for Humans configuration file > template_md_options > properties_table_columns > properties_table_columns items + +| | | +| -------- | ------------------ | +| **Type** | `enum (of string)` | + +Must be one of: +* "Property" +* "Pattern" +* "Type" +* "Deprecated" +* "Definition" +* "Title/Description" + +
+
+
- 21. [Optional] Property JSON Schema for Humans configuration file > with_footer + + 21. [Optional] Property JSON Schema for Humans configuration file > with_footer
@@ -484,7 +554,8 @@ Adding an extra, even if the value is false, will activate it. For example `{"br
- 22. [Optional] Property JSON Schema for Humans configuration file > footer_show_time + + 22. [Optional] Property JSON Schema for Humans configuration file > footer_show_time
diff --git a/docs/examples/examples_md_nested_with_badges/additional_properties.md b/docs/examples/examples_md_nested_with_badges/additional_properties.md index 3703a8d2..e1f49d3a 100644 --- a/docs/examples/examples_md_nested_with_badges/additional_properties.md +++ b/docs/examples/examples_md_nested_with_badges/additional_properties.md @@ -16,7 +16,8 @@ | **Additional properties** | [![Should-conform](https://img.shields.io/badge/Should-conform-blue)](#additionalProperties "Each additional property must conform to the following schema") |
- 1. [Optional] Property Person > subType1 + + 1. [Optional] Property Person > subType1
@@ -29,7 +30,8 @@ **Description:** A sub type with additionalProperties false.
- 1.1. [Optional] Property Person > subType1 > subProp1 + + 1.1. [Optional] Property Person > subType1 > subProp1
@@ -45,7 +47,8 @@
- 2. [Optional] Property Person > subType2 + + 2. [Optional] Property Person > subType2
@@ -58,7 +61,8 @@ **Description:** A sub type with additionalProperties true.
- 2.1. [Optional] Property Person > subType2 > subProp2 + + 2.1. [Optional] Property Person > subType2 > subProp2
@@ -74,7 +78,8 @@
- 3. [Optional] Property Person > anInt + + 3. [Optional] Property Person > anInt
@@ -89,7 +94,8 @@
- 4. Property Person > additionalProperties + + 4. Property Person > additionalProperties
@@ -102,7 +108,8 @@ **Description:** additionalProperties schema.
- 4.1. [Optional] Property Person > additionalProperties > propA + + 4.1. [Optional] Property Person > additionalProperties > propA
diff --git a/docs/examples/examples_md_nested_with_badges/anyOf_option_names.md b/docs/examples/examples_md_nested_with_badges/anyOf_option_names.md index c7e4a9fd..5b926ee5 100644 --- a/docs/examples/examples_md_nested_with_badges/anyOf_option_names.md +++ b/docs/examples/examples_md_nested_with_badges/anyOf_option_names.md @@ -14,7 +14,8 @@ **Description:** JSON Schema for an fstab entry
- 1. [Required] Property root > storage + + 1. [Required] Property root > storage
diff --git a/docs/examples/examples_md_nested_with_badges/array.md b/docs/examples/examples_md_nested_with_badges/array.md index be77b1fd..8d6d16a8 100644 --- a/docs/examples/examples_md_nested_with_badges/array.md +++ b/docs/examples/examples_md_nested_with_badges/array.md @@ -15,7 +15,8 @@ **Description:** A schema with an array
- 1. [Optional] Property root > fruits + + 1. [Optional] Property root > fruits
@@ -46,7 +47,8 @@
- 2. [Optional] Property root > vegetables + + 2. [Optional] Property root > vegetables
@@ -76,7 +78,8 @@ | **Defined in** | #/definitions/veggie |
- 2.1.1. [Required] Property root > vegetables > vegetables items > veggieName + + 2.1.1. [Required] Property root > vegetables > vegetables items > veggieName
@@ -91,7 +94,8 @@
- 2.1.2. [Required] Property root > vegetables > vegetables items > veggieLike + + 2.1.2. [Required] Property root > vegetables > vegetables items > veggieLike
diff --git a/docs/examples/examples_md_nested_with_badges/array_additionalItems.md b/docs/examples/examples_md_nested_with_badges/array_additionalItems.md index dd011ed1..f1ed454a 100644 --- a/docs/examples/examples_md_nested_with_badges/array_additionalItems.md +++ b/docs/examples/examples_md_nested_with_badges/array_additionalItems.md @@ -17,7 +17,8 @@ **Description:** A little food fun
- 1. [Optional] Property root > address + + 1. [Optional] Property root > address
@@ -100,7 +101,8 @@ Must be one of:
- 2. [Optional] Property root > addressLines + + 2. [Optional] Property root > addressLines
@@ -133,7 +135,8 @@ Must be one of:
- 3. [Optional] Property root > arrayEmpty + + 3. [Optional] Property root > arrayEmpty
diff --git a/docs/examples/examples_md_nested_with_badges/array_advanced.md b/docs/examples/examples_md_nested_with_badges/array_advanced.md index 00c3cbe7..dd384252 100644 --- a/docs/examples/examples_md_nested_with_badges/array_advanced.md +++ b/docs/examples/examples_md_nested_with_badges/array_advanced.md @@ -14,7 +14,8 @@ **Description:** A little food fun
- 1. [Optional] Property root > fruits + + 1. [Optional] Property root > fruits
@@ -47,7 +48,8 @@
- 2. [Optional] Property root > vegetables + + 2. [Optional] Property root > vegetables
diff --git a/docs/examples/examples_md_nested_with_badges/array_example.md b/docs/examples/examples_md_nested_with_badges/array_example.md index 2803d89f..15ad636b 100644 --- a/docs/examples/examples_md_nested_with_badges/array_example.md +++ b/docs/examples/examples_md_nested_with_badges/array_example.md @@ -11,7 +11,8 @@ **Description:** A schema with an array
- 1. [Optional] Property root > fruits + + 1. [Optional] Property root > fruits
diff --git a/docs/examples/examples_md_nested_with_badges/basic.md b/docs/examples/examples_md_nested_with_badges/basic.md index 0c3008f8..038bca45 100644 --- a/docs/examples/examples_md_nested_with_badges/basic.md +++ b/docs/examples/examples_md_nested_with_badges/basic.md @@ -15,7 +15,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > firstName + + 1. [Optional] Property Person > firstName
@@ -32,7 +33,8 @@
- 2. [Optional] Property Person > lastName + + 2. [Optional] Property Person > lastName
@@ -49,7 +51,8 @@
- 3. [Optional] Property Person > age + + 3. [Optional] Property Person > age
@@ -70,7 +73,8 @@
- 4. [Optional] Property Person > driverLicenseId + + 4. [Optional] Property Person > driverLicenseId
diff --git a/docs/examples/examples_md_nested_with_badges/break_on_newline.md b/docs/examples/examples_md_nested_with_badges/break_on_newline.md index 25f7a87f..c57b85d9 100644 --- a/docs/examples/examples_md_nested_with_badges/break_on_newline.md +++ b/docs/examples/examples_md_nested_with_badges/break_on_newline.md @@ -10,7 +10,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Hello > property1 + + 1. [Optional] Property Hello > property1
diff --git a/docs/examples/examples_md_nested_with_badges/broken_ref.md b/docs/examples/examples_md_nested_with_badges/broken_ref.md index 97b0c0e5..feeb50a8 100644 --- a/docs/examples/examples_md_nested_with_badges/broken_ref.md +++ b/docs/examples/examples_md_nested_with_badges/broken_ref.md @@ -11,7 +11,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > firstName + + 1. [Optional] Property Person > firstName
@@ -28,7 +29,8 @@
- 2. [Optional] Property Person > lastName + + 2. [Optional] Property Person > lastName
diff --git a/docs/examples/examples_md_nested_with_badges/circular.md b/docs/examples/examples_md_nested_with_badges/circular.md index 1fb1b985..3f13b668 100644 --- a/docs/examples/examples_md_nested_with_badges/circular.md +++ b/docs/examples/examples_md_nested_with_badges/circular.md @@ -11,7 +11,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Circular reference Schema > person + + 1. [Optional] Property Circular reference Schema > person
@@ -23,7 +24,8 @@ | **Defined in** | #/definitions/a |
- 1.1. [Optional] Property Circular reference Schema > person > a1 + + 1.1. [Optional] Property Circular reference Schema > person > a1
diff --git a/docs/examples/examples_md_nested_with_badges/combining_not.md b/docs/examples/examples_md_nested_with_badges/combining_not.md index 169db9c8..9b56f6b1 100644 --- a/docs/examples/examples_md_nested_with_badges/combining_not.md +++ b/docs/examples/examples_md_nested_with_badges/combining_not.md @@ -11,7 +11,8 @@ **Description:** Test schema with a not
- 1. [Required] Property root > not_a_string + + 1. [Required] Property root > not_a_string
diff --git a/docs/examples/examples_md_nested_with_badges/combining_oneOf.md b/docs/examples/examples_md_nested_with_badges/combining_oneOf.md index 2793e585..da1e1ac5 100644 --- a/docs/examples/examples_md_nested_with_badges/combining_oneOf.md +++ b/docs/examples/examples_md_nested_with_badges/combining_oneOf.md @@ -14,7 +14,8 @@ **Description:** JSON Schema for an fstab entry
- 1. [Required] Property root > storage + + 1. [Required] Property root > storage
diff --git a/docs/examples/examples_md_nested_with_badges/conditional_subschema.md b/docs/examples/examples_md_nested_with_badges/conditional_subschema.md index bba036e2..40008cc6 100644 --- a/docs/examples/examples_md_nested_with_badges/conditional_subschema.md +++ b/docs/examples/examples_md_nested_with_badges/conditional_subschema.md @@ -20,7 +20,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1.1. [Optional] Property root > then > postal_code + + 1.1. [Optional] Property root > then > postal_code
@@ -45,7 +46,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 2.1. [Optional] Property root > else > postal_code + + 2.1. [Optional] Property root > else > postal_code
@@ -63,7 +65,8 @@
- 3. [Optional] Property root > street_address + + 3. [Optional] Property root > street_address
@@ -76,7 +79,8 @@
- 4. [Optional] Property root > country + + 4. [Optional] Property root > country
diff --git a/docs/examples/examples_md_nested_with_badges/conditional_subschema_no_else.md b/docs/examples/examples_md_nested_with_badges/conditional_subschema_no_else.md index 8bb6e33a..e168051c 100644 --- a/docs/examples/examples_md_nested_with_badges/conditional_subschema_no_else.md +++ b/docs/examples/examples_md_nested_with_badges/conditional_subschema_no_else.md @@ -42,7 +42,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1.1.1. [Optional] Property root > allOf > item 0 > then > postal_code + + 1.1.1. [Optional] Property root > allOf > item 0 > then > postal_code
@@ -77,7 +78,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 2.1.1. [Optional] Property root > allOf > item 1 > then > postal_code + + 2.1.1. [Optional] Property root > allOf > item 1 > then > postal_code
@@ -112,7 +114,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 3.1.1. [Optional] Property root > allOf > item 2 > then > postal_code + + 3.1.1. [Optional] Property root > allOf > item 2 > then > postal_code
@@ -134,7 +137,8 @@
- 4. [Optional] Property root > street_address + + 4. [Optional] Property root > street_address
@@ -147,7 +151,8 @@
- 5. [Optional] Property root > country + + 5. [Optional] Property root > country
diff --git a/docs/examples/examples_md_nested_with_badges/defaults.md b/docs/examples/examples_md_nested_with_badges/defaults.md index be5ccd84..42ea9eb6 100644 --- a/docs/examples/examples_md_nested_with_badges/defaults.md +++ b/docs/examples/examples_md_nested_with_badges/defaults.md @@ -9,7 +9,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property root > a + + 1. [Optional] Property root > a
@@ -27,7 +28,8 @@
- 2. [Optional] Property root > b + + 2. [Optional] Property root > b
diff --git a/docs/examples/examples_md_nested_with_badges/deprecated.md b/docs/examples/examples_md_nested_with_badges/deprecated.md index 2ea37862..e1c6c92e 100644 --- a/docs/examples/examples_md_nested_with_badges/deprecated.md +++ b/docs/examples/examples_md_nested_with_badges/deprecated.md @@ -14,7 +14,8 @@ **Description:** Test schema with deprecated in description
- 1. [Optional]~~ Property root > deprecated1~~ + + 1. [Optional]~~ Property root > deprecated1~~
@@ -31,7 +32,8 @@
- 2. [Optional]~~ Property root > deprecated2~~ + + 2. [Optional]~~ Property root > deprecated2~~
@@ -48,7 +50,8 @@
- 3. [Optional]~~ Property root > deprecated3~~ + + 3. [Optional]~~ Property root > deprecated3~~
@@ -65,7 +68,8 @@
- 4. [Optional]~~ Property root > deprecated4~~ + + 4. [Optional]~~ Property root > deprecated4~~
@@ -82,7 +86,8 @@
- 5. [Optional] Property root > not_deprecated + + 5. [Optional] Property root > not_deprecated
diff --git a/docs/examples/examples_md_nested_with_badges/description_from_ref.md b/docs/examples/examples_md_nested_with_badges/description_from_ref.md index dfb3072c..aa26fde2 100644 --- a/docs/examples/examples_md_nested_with_badges/description_from_ref.md +++ b/docs/examples/examples_md_nested_with_badges/description_from_ref.md @@ -9,7 +9,8 @@ | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") |
- 1. [Optional] Property root > name + + 1. [Optional] Property root > name
@@ -29,7 +30,8 @@
- 2. [Optional] Property root > alignment + + 2. [Optional] Property root > alignment
diff --git a/docs/examples/examples_md_nested_with_badges/description_with_ref.md b/docs/examples/examples_md_nested_with_badges/description_with_ref.md index e0145054..bf6b6b49 100644 --- a/docs/examples/examples_md_nested_with_badges/description_with_ref.md +++ b/docs/examples/examples_md_nested_with_badges/description_with_ref.md @@ -10,7 +10,8 @@ | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") |
- 1. [Required] Property root > outer + + 1. [Required] Property root > outer
@@ -24,7 +25,8 @@ **Description:** We should see this
- 1.1. [Required] Property root > outer > inner + + 1.1. [Required] Property root > outer > inner
@@ -42,7 +44,8 @@
- 2. [Optional] Property root > outer2 + + 2. [Optional] Property root > outer2
diff --git a/docs/examples/examples_md_nested_with_badges/empty_property_name.md b/docs/examples/examples_md_nested_with_badges/empty_property_name.md index b9530d27..3223c6b7 100644 --- a/docs/examples/examples_md_nested_with_badges/empty_property_name.md +++ b/docs/examples/examples_md_nested_with_badges/empty_property_name.md @@ -10,7 +10,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. Property Empty property name > + + 1. Property Empty property name >
diff --git a/docs/examples/examples_md_nested_with_badges/enumofnone.md b/docs/examples/examples_md_nested_with_badges/enumofnone.md index 903a2993..82e18503 100644 --- a/docs/examples/examples_md_nested_with_badges/enumofnone.md +++ b/docs/examples/examples_md_nested_with_badges/enumofnone.md @@ -10,7 +10,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Enum of None > enumOfNone + + 1. [Optional] Property Enum of None > enumOfNone
diff --git a/docs/examples/examples_md_nested_with_badges/geo.md b/docs/examples/examples_md_nested_with_badges/geo.md index 12e1fb30..1f41f4f3 100644 --- a/docs/examples/examples_md_nested_with_badges/geo.md +++ b/docs/examples/examples_md_nested_with_badges/geo.md @@ -13,7 +13,8 @@ **Description:** A geographical coordinate.
- 1. [Required] Property Longitude and Latitude Values > latitude + + 1. [Required] Property Longitude and Latitude Values > latitude
@@ -31,7 +32,8 @@
- 2. [Required] Property Longitude and Latitude Values > longitude + + 2. [Required] Property Longitude and Latitude Values > longitude
diff --git a/docs/examples/examples_md_nested_with_badges/long_description.md b/docs/examples/examples_md_nested_with_badges/long_description.md index fbbe8ff7..f11529f3 100644 --- a/docs/examples/examples_md_nested_with_badges/long_description.md +++ b/docs/examples/examples_md_nested_with_badges/long_description.md @@ -10,7 +10,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Long description > it_s_hard_to_explain + + 1. [Optional] Property Long description > it_s_hard_to_explain
diff --git a/docs/examples/examples_md_nested_with_badges/multiple_types.md b/docs/examples/examples_md_nested_with_badges/multiple_types.md index d2df72fb..6b284f06 100644 --- a/docs/examples/examples_md_nested_with_badges/multiple_types.md +++ b/docs/examples/examples_md_nested_with_badges/multiple_types.md @@ -13,7 +13,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > firstName + + 1. [Optional] Property Person > firstName
@@ -28,7 +29,8 @@
- 2. [Optional] Property Person > lastName + + 2. [Optional] Property Person > lastName
@@ -43,7 +45,8 @@
- 3. [Optional] Property Person > age + + 3. [Optional] Property Person > age
@@ -62,7 +65,8 @@
- 4. [Optional] Property Person > anything + + 4. [Optional] Property Person > anything
diff --git a/docs/examples/examples_md_nested_with_badges/pattern_properties.md b/docs/examples/examples_md_nested_with_badges/pattern_properties.md index 4870d828..70c19903 100644 --- a/docs/examples/examples_md_nested_with_badges/pattern_properties.md +++ b/docs/examples/examples_md_nested_with_badges/pattern_properties.md @@ -14,7 +14,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > firstName + + 1. [Optional] Property Person > firstName
@@ -31,7 +32,8 @@
- 2. [Optional] Property Person > lastName + + 2. [Optional] Property Person > lastName
@@ -48,7 +50,8 @@
- 3. [Optional]Pattern Property Person > paperSize + + 3. [Optional]Pattern Property Person > paperSize > All properties whose name matches the regular expression ```$[a-c][0-9]^``` ([Test](https://regex101.com/?regex=%24%5Ba-c%5D%5B0-9%5D%5E)) must respect the following conditions @@ -66,7 +69,8 @@ must respect the following conditions **Description:** Review of a paper size.
- 3.1. [Required] Property Person > paperSize > rating + + 3.1. [Required] Property Person > paperSize > rating
@@ -83,7 +87,8 @@ must respect the following conditions
- 3.2. [Required] Property Person > paperSize > review + + 3.2. [Required] Property Person > paperSize > review
diff --git a/docs/examples/examples_md_nested_with_badges/pattern_properties_html_id.md b/docs/examples/examples_md_nested_with_badges/pattern_properties_html_id.md index 6c5989f3..18a79b09 100644 --- a/docs/examples/examples_md_nested_with_badges/pattern_properties_html_id.md +++ b/docs/examples/examples_md_nested_with_badges/pattern_properties_html_id.md @@ -14,7 +14,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > not_a_pattern + + 1. [Optional] Property Person > not_a_pattern
@@ -25,7 +26,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1.1. [Optional]Pattern Property Person > not_a_pattern > Title 4 + + 1.1. [Optional]Pattern Property Person > not_a_pattern > Title 4 > All properties whose name matches the regular expression ```.$``` ([Test](https://regex101.com/?regex=.%24)) must respect the following conditions @@ -49,7 +51,8 @@ must respect the following conditions
- 2. [Optional]Pattern Property Person > Title 1 + + 2. [Optional]Pattern Property Person > Title 1 > All properties whose name matches the regular expression ```.*``` ([Test](https://regex101.com/?regex=.%2A)) must respect the following conditions @@ -70,7 +73,8 @@ must respect the following conditions
- 3. [Optional]Pattern Property Person > Title 2 + + 3. [Optional]Pattern Property Person > Title 2 > All properties whose name matches the regular expression ```..``` ([Test](https://regex101.com/?regex=..)) must respect the following conditions @@ -91,7 +95,8 @@ must respect the following conditions
- 4. [Optional]Pattern Property Person > Title 3 + + 4. [Optional]Pattern Property Person > Title 3 > All properties whose name matches the regular expression ```^.``` ([Test](https://regex101.com/?regex=%5E.)) must respect the following conditions diff --git a/docs/examples/examples_md_nested_with_badges/prefixItems.md b/docs/examples/examples_md_nested_with_badges/prefixItems.md index 48dbc741..b8609252 100644 --- a/docs/examples/examples_md_nested_with_badges/prefixItems.md +++ b/docs/examples/examples_md_nested_with_badges/prefixItems.md @@ -14,7 +14,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Address > address + + 1. [Optional] Property Address > address
diff --git a/docs/examples/examples_md_nested_with_badges/recursive.md b/docs/examples/examples_md_nested_with_badges/recursive.md index ce418696..1c5fbc4a 100644 --- a/docs/examples/examples_md_nested_with_badges/recursive.md +++ b/docs/examples/examples_md_nested_with_badges/recursive.md @@ -12,7 +12,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > person + + 1. [Optional] Property Person > person
@@ -26,7 +27,8 @@ **Description:** A human being
- 1.1. [Optional] Property Person > person > children + + 1.1. [Optional] Property Person > person > children
diff --git a/docs/examples/examples_md_nested_with_badges/recursive_array.md b/docs/examples/examples_md_nested_with_badges/recursive_array.md index 04d62cba..08c7e6db 100644 --- a/docs/examples/examples_md_nested_with_badges/recursive_array.md +++ b/docs/examples/examples_md_nested_with_badges/recursive_array.md @@ -13,7 +13,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > person + + 1. [Optional] Property Person > person
@@ -47,7 +48,8 @@ **Description:** A human being
- 1.1.1. [Optional] Property Person > person > person items > children + + 1.1.1. [Optional] Property Person > person > person items > children
diff --git a/docs/examples/examples_md_nested_with_badges/recursive_full_schema.md b/docs/examples/examples_md_nested_with_badges/recursive_full_schema.md index 38005bb7..86bbc56d 100644 --- a/docs/examples/examples_md_nested_with_badges/recursive_full_schema.md +++ b/docs/examples/examples_md_nested_with_badges/recursive_full_schema.md @@ -18,7 +18,8 @@ **Description:** Display the issue.
- 1. [Optional] Property Bug > Code + + 1. [Optional] Property Bug > Code
@@ -33,7 +34,8 @@
- 2. [Optional] Property Bug > RecursiveArray + + 2. [Optional] Property Bug > RecursiveArray
@@ -70,7 +72,8 @@
- 3. [Optional] Property Bug > DecoratedRecursiveArray + + 3. [Optional] Property Bug > DecoratedRecursiveArray
@@ -101,7 +104,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 3.1.1. [Optional] Property Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > SomeName + + 3.1.1. [Optional] Property Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > SomeName
@@ -114,7 +118,8 @@
- 3.1.2. [Optional] Property Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > TheThing + + 3.1.2. [Optional] Property Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > TheThing
diff --git a/docs/examples/examples_md_nested_with_badges/recursive_full_schema_simple.md b/docs/examples/examples_md_nested_with_badges/recursive_full_schema_simple.md index 51b5cd0c..bb3668f3 100644 --- a/docs/examples/examples_md_nested_with_badges/recursive_full_schema_simple.md +++ b/docs/examples/examples_md_nested_with_badges/recursive_full_schema_simple.md @@ -10,7 +10,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > itself + + 1. [Optional] Property Person > itself
diff --git a/docs/examples/examples_md_nested_with_badges/recursive_parent_in_definition.md b/docs/examples/examples_md_nested_with_badges/recursive_parent_in_definition.md index 58e4bebf..b62b4233 100644 --- a/docs/examples/examples_md_nested_with_badges/recursive_parent_in_definition.md +++ b/docs/examples/examples_md_nested_with_badges/recursive_parent_in_definition.md @@ -13,7 +13,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > relationships + + 1. [Optional] Property Person > relationships
@@ -27,7 +28,8 @@ **Description:** Relationships between this person and others
- 1.1. [Optional] Property Person > relationships > mother + + 1.1. [Optional] Property Person > relationships > mother
@@ -41,7 +43,8 @@ **Description:** A human being
- 1.1.1. [Optional] Property Person > relationships > mother > relationships + + 1.1.1. [Optional] Property Person > relationships > mother > relationships
@@ -54,7 +57,8 @@ **Description:** Relationships between this person and others
- 1.1.1.1. [Optional] Property Person > relationships > mother > relationships > mother + + 1.1.1.1. [Optional] Property Person > relationships > mother > relationships > mother
diff --git a/docs/examples/examples_md_nested_with_badges/recursive_two_files.md b/docs/examples/examples_md_nested_with_badges/recursive_two_files.md index 9aa883fa..e9c1e5aa 100644 --- a/docs/examples/examples_md_nested_with_badges/recursive_two_files.md +++ b/docs/examples/examples_md_nested_with_badges/recursive_two_files.md @@ -13,7 +13,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > person + + 1. [Optional] Property Person > person
@@ -27,7 +28,8 @@ **Description:** A human being
- 1.1. [Optional] Property Person > person > children + + 1.1. [Optional] Property Person > person > children
@@ -64,7 +66,8 @@
- 1.2. [Optional] Property Person > person > siblings + + 1.2. [Optional] Property Person > person > siblings
diff --git a/docs/examples/examples_md_nested_with_badges/ref_merge.md b/docs/examples/examples_md_nested_with_badges/ref_merge.md index 1f010966..46ddfc10 100644 --- a/docs/examples/examples_md_nested_with_badges/ref_merge.md +++ b/docs/examples/examples_md_nested_with_badges/ref_merge.md @@ -13,7 +13,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Test > aProperty + + 1. [Optional] Property Test > aProperty
@@ -34,7 +35,8 @@ Must be one of:
- 2. [Optional] Property Test > aDictPropertyARequired + + 2. [Optional] Property Test > aDictPropertyARequired
@@ -47,7 +49,8 @@ Must be one of: | **Defined in** | #/definitions/aDictProperty |
- 2.1. [Required] Property Test > aDictPropertyARequired > a + + 2.1. [Required] Property Test > aDictPropertyARequired > a
@@ -60,7 +63,8 @@ Must be one of:
- 2.2. [Required] Property Test > aDictPropertyARequired > b + + 2.2. [Required] Property Test > aDictPropertyARequired > b
diff --git a/docs/examples/examples_md_nested_with_badges/ref_with_tabs.md b/docs/examples/examples_md_nested_with_badges/ref_with_tabs.md index 81120592..0665e759 100644 --- a/docs/examples/examples_md_nested_with_badges/ref_with_tabs.md +++ b/docs/examples/examples_md_nested_with_badges/ref_with_tabs.md @@ -45,7 +45,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property root > objectA + + 1. [Optional] Property root > objectA
@@ -56,7 +57,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1.1. [Optional] Property root > objectA > signature + + 1.1. [Optional] Property root > objectA > signature
@@ -87,7 +89,8 @@ | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") |
- 1.1.1.1. [Optional] Property root > objectA > signature > oneOf > item 0 > signers + + 1.1.1.1. [Optional] Property root > objectA > signature > oneOf > item 0 > signers
@@ -121,7 +124,8 @@ | **Defined in** | #/definitions/signer |
- 1.1.1.1.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm + + 1.1.1.1.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm
@@ -188,7 +192,8 @@ Must be one of:
- 1.1.1.1.1.2. [Optional] Property root > objectA > signature > oneOf > item 0 > signers > Signature > keyId + + 1.1.1.1.1.2. [Optional] Property root > objectA > signature > oneOf > item 0 > signers > Signature > keyId
@@ -205,7 +210,8 @@ Must be one of:
- 1.1.1.1.1.3. [Optional] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey + + 1.1.1.1.1.3. [Optional] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey
@@ -245,7 +251,8 @@ Must be one of: | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") |
- 1.1.1.1.1.3.1.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty + + 1.1.1.1.1.3.1.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty
@@ -261,7 +268,8 @@ Must be one of:
- 1.1.1.1.1.3.1.1.2. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > crv + + 1.1.1.1.1.3.1.1.2. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > crv
@@ -283,7 +291,8 @@ Must be one of:
- 1.1.1.1.1.3.1.1.3. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > x + + 1.1.1.1.1.3.1.1.3. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > x
@@ -300,7 +309,8 @@ Must be one of:
- 1.1.1.1.1.3.1.1.4. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > y + + 1.1.1.1.1.3.1.1.4. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > y
@@ -334,7 +344,8 @@ Must be one of: | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") |
- 1.1.1.1.1.3.2.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty + + 1.1.1.1.1.3.2.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty
@@ -350,7 +361,8 @@ Must be one of:
- 1.1.1.1.1.3.2.1.2. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > crv + + 1.1.1.1.1.3.2.1.2. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > crv
@@ -371,7 +383,8 @@ Must be one of:
- 1.1.1.1.1.3.2.1.3. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > x + + 1.1.1.1.1.3.2.1.3. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > x
@@ -405,7 +418,8 @@ Must be one of: | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") |
- 1.1.1.1.1.3.3.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty + + 1.1.1.1.1.3.3.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty
@@ -421,7 +435,8 @@ Must be one of:
- 1.1.1.1.1.3.3.1.2. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > n + + 1.1.1.1.1.3.3.1.2. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > n
@@ -438,7 +453,8 @@ Must be one of:
- 1.1.1.1.1.3.3.1.3. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > e + + 1.1.1.1.1.3.3.1.3. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > e
@@ -459,7 +475,8 @@ Must be one of:
- 1.1.1.1.1.3.4. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > kty + + 1.1.1.1.1.3.4. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > kty
@@ -483,7 +500,8 @@ Must be one of:
- 1.1.1.1.1.4. [Optional] Property root > objectA > signature > oneOf > item 0 > signers > Signature > certificatePath + + 1.1.1.1.1.4. [Optional] Property root > objectA > signature > oneOf > item 0 > signers > Signature > certificatePath
@@ -518,7 +536,8 @@ Must be one of:
- 1.1.1.1.1.5. [Optional] Property root > objectA > signature > oneOf > item 0 > signers > Signature > excludes + + 1.1.1.1.1.5. [Optional] Property root > objectA > signature > oneOf > item 0 > signers > Signature > excludes
@@ -553,7 +572,8 @@ Must be one of:
- 1.1.1.1.1.6. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > value + + 1.1.1.1.1.6. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > value
@@ -583,7 +603,8 @@ Must be one of: | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") |
- 1.1.2.1. [Optional] Property root > objectA > signature > oneOf > item 1 > chain + + 1.1.2.1. [Optional] Property root > objectA > signature > oneOf > item 1 > chain
@@ -645,7 +666,8 @@ Must be one of:
- 2. [Optional] Property root > objectB + + 2. [Optional] Property root > objectB
@@ -656,7 +678,8 @@ Must be one of: | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 2.1. [Optional] Property root > objectB > signature + + 2.1. [Optional] Property root > objectB > signature
diff --git a/docs/examples/examples_md_nested_with_badges/reference_int.md b/docs/examples/examples_md_nested_with_badges/reference_int.md index cc273236..a463e52d 100644 --- a/docs/examples/examples_md_nested_with_badges/reference_int.md +++ b/docs/examples/examples_md_nested_with_badges/reference_int.md @@ -11,7 +11,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > extra_options_object + + 1. [Optional] Property Person > extra_options_object
@@ -28,7 +29,8 @@
- 2. [Optional] Property Person > name_looks_like_an_int + + 2. [Optional] Property Person > name_looks_like_an_int
diff --git a/docs/examples/examples_md_nested_with_badges/references.md b/docs/examples/examples_md_nested_with_badges/references.md index bd854a62..fe312e34 100644 --- a/docs/examples/examples_md_nested_with_badges/references.md +++ b/docs/examples/examples_md_nested_with_badges/references.md @@ -28,7 +28,8 @@ **Description:** Testing $ref
- 1. [Optional] Property root > a_gift + + 1. [Optional] Property root > a_gift
@@ -44,7 +45,8 @@
- 2. [Optional] Property root > file_prefix + + 2. [Optional] Property root > file_prefix
@@ -60,7 +62,8 @@
- 3. [Optional] Property root > anchor_with_slash + + 3. [Optional] Property root > anchor_with_slash
@@ -72,7 +75,8 @@ | **Defined in** | #/definitions/object_def |
- 3.1. [Optional] Property root > anchor_with_slash > propertyA + + 3.1. [Optional] Property root > anchor_with_slash > propertyA
@@ -90,7 +94,8 @@
- 4. [Optional] Property root > anchor_no_slash + + 4. [Optional] Property root > anchor_no_slash
@@ -124,7 +129,8 @@
- 5. [Optional] Property root > anchor_nested_reference + + 5. [Optional] Property root > anchor_nested_reference
@@ -138,7 +144,8 @@
- 6. [Optional] Property root > same_file_anchor_with_slash + + 6. [Optional] Property root > same_file_anchor_with_slash
@@ -154,7 +161,8 @@
- 7. [Optional] Property root > same_file_anchor_no_slash + + 7. [Optional] Property root > same_file_anchor_no_slash
@@ -169,7 +177,8 @@
- 8. [Optional] Property root > same_file_nested_reference + + 8. [Optional] Property root > same_file_nested_reference
@@ -183,7 +192,8 @@
- 9. [Optional] Property root > other_file_anchor + + 9. [Optional] Property root > other_file_anchor
@@ -197,7 +207,8 @@ **Description:** The delivery is a gift, no prices displayed
- 9.1. [Optional] Property root > other_file_anchor > with_wrap + + 9.1. [Optional] Property root > other_file_anchor > with_wrap
@@ -213,7 +224,8 @@
- 10. [Optional] Property root > other_file_dot_anchor + + 10. [Optional] Property root > other_file_dot_anchor
@@ -230,7 +242,8 @@
- 11. [Optional] Property root > other_file_dot_dot_anchor + + 11. [Optional] Property root > other_file_dot_dot_anchor
@@ -247,7 +260,8 @@
- 12. [Optional] Property root > other_file_only + + 12. [Optional] Property root > other_file_only
@@ -261,7 +275,8 @@ **Description:** Test schema with a not
- 12.1. [Required] Property root > other_file_only > not_a_string + + 12.1. [Required] Property root > other_file_only > not_a_string
@@ -284,7 +299,8 @@
- 13. [Optional] Property root > multi_hierarchy_reference + + 13. [Optional] Property root > multi_hierarchy_reference
@@ -296,7 +312,8 @@ | **Defined in** | reference_schemas/intermediate.json#/properties/cross_file_reference |
- 13.1. [Optional] Property root > multi_hierarchy_reference > propertyA + + 13.1. [Optional] Property root > multi_hierarchy_reference > propertyA
diff --git a/docs/examples/examples_md_nested_with_badges/references_url.md b/docs/examples/examples_md_nested_with_badges/references_url.md index d141e0e9..2cef7ae4 100644 --- a/docs/examples/examples_md_nested_with_badges/references_url.md +++ b/docs/examples/examples_md_nested_with_badges/references_url.md @@ -10,7 +10,8 @@ **Description:** Testing $ref with URL
- 1. [Optional] Property root > firstName + + 1. [Optional] Property root > firstName
diff --git a/docs/examples/examples_md_nested_with_badges/references_url_two_levels.md b/docs/examples/examples_md_nested_with_badges/references_url_two_levels.md index bdc2f87b..e7cee37e 100644 --- a/docs/examples/examples_md_nested_with_badges/references_url_two_levels.md +++ b/docs/examples/examples_md_nested_with_badges/references_url_two_levels.md @@ -12,7 +12,8 @@ **Description:** Testing $ref of a remote $ref
- 1. [Optional] Property root > described + + 1. [Optional] Property root > described
@@ -24,7 +25,8 @@ | **Defined in** | https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/description_from_ref.json |
- 1.1. [Optional] Property root > described > name + + 1.1. [Optional] Property root > described > name
@@ -44,7 +46,8 @@
- 1.2. [Optional] Property root > described > alignment + + 1.2. [Optional] Property root > described > alignment
diff --git a/docs/examples/examples_md_nested_with_badges/references_url_yaml.md b/docs/examples/examples_md_nested_with_badges/references_url_yaml.md index cb4b93de..677b8dfb 100644 --- a/docs/examples/examples_md_nested_with_badges/references_url_yaml.md +++ b/docs/examples/examples_md_nested_with_badges/references_url_yaml.md @@ -13,7 +13,8 @@ **Description:** Testing $ref with URL with YAML destination
- 1. [Optional] Property root > address + + 1. [Optional] Property root > address
@@ -25,7 +26,8 @@ | **Defined in** | https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/yaml.yaml#/definitions/address |
- 1.1. [Required] Property root > address > street_address + + 1.1. [Required] Property root > address > street_address
@@ -38,7 +40,8 @@
- 1.2. [Required] Property root > address > city + + 1.2. [Required] Property root > address > city
@@ -51,7 +54,8 @@
- 1.3. [Required] Property root > address > state + + 1.3. [Required] Property root > address > state
diff --git a/docs/examples/examples_md_nested_with_badges/required_properties_order.md b/docs/examples/examples_md_nested_with_badges/required_properties_order.md index d5b6257e..fb7c515b 100644 --- a/docs/examples/examples_md_nested_with_badges/required_properties_order.md +++ b/docs/examples/examples_md_nested_with_badges/required_properties_order.md @@ -13,7 +13,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Undocumented Required Properties order > group1 + + 1. [Optional] Property Undocumented Required Properties order > group1
@@ -31,7 +32,8 @@
- 2. [Optional] Property Undocumented Required Properties order > group2 + + 2. [Optional] Property Undocumented Required Properties order > group2
diff --git a/docs/examples/examples_md_nested_with_badges/single_element_allOf.md b/docs/examples/examples_md_nested_with_badges/single_element_allOf.md index e8f24713..da7a59c2 100644 --- a/docs/examples/examples_md_nested_with_badges/single_element_allOf.md +++ b/docs/examples/examples_md_nested_with_badges/single_element_allOf.md @@ -13,7 +13,8 @@ **Description:** Schema containing a single-element allOf
- 1. [Optional] Property Schema containing a single-element allOf > prop1 + + 1. [Optional] Property Schema containing a single-element allOf > prop1
@@ -30,7 +31,8 @@
- 2. [Optional] Property Schema containing a single-element allOf > prop2 + + 2. [Optional] Property Schema containing a single-element allOf > prop2
diff --git a/docs/examples/examples_md_nested_with_badges/type_object_null.md b/docs/examples/examples_md_nested_with_badges/type_object_null.md index aee044d6..b47f5755 100644 --- a/docs/examples/examples_md_nested_with_badges/type_object_null.md +++ b/docs/examples/examples_md_nested_with_badges/type_object_null.md @@ -11,7 +11,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > prop1 + + 1. [Optional] Property Person > prop1
@@ -21,7 +22,8 @@ | **Type** | `object or null` |
- 1.1. [Optional] Property Person > prop1 > lol + + 1.1. [Optional] Property Person > prop1 > lol
diff --git a/docs/examples/examples_md_nested_with_badges/with_default.md b/docs/examples/examples_md_nested_with_badges/with_default.md index 5c96d7e9..fecedd22 100644 --- a/docs/examples/examples_md_nested_with_badges/with_default.md +++ b/docs/examples/examples_md_nested_with_badges/with_default.md @@ -13,7 +13,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property User Preference > favorite_os + + 1. [Optional] Property User Preference > favorite_os
@@ -32,7 +33,8 @@ Must be one of:
- 2. [Optional] Property User Preference > favorite_colors + + 2. [Optional] Property User Preference > favorite_colors
@@ -72,7 +74,8 @@ Must be one of:
- 3. [Optional] Property User Preference > desired_number_of_shoes + + 3. [Optional] Property User Preference > desired_number_of_shoes
diff --git a/docs/examples/examples_md_nested_with_badges/with_definitions.md b/docs/examples/examples_md_nested_with_badges/with_definitions.md index 914af42b..a90142f1 100644 --- a/docs/examples/examples_md_nested_with_badges/with_definitions.md +++ b/docs/examples/examples_md_nested_with_badges/with_definitions.md @@ -13,7 +13,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property root > billing_address + + 1. [Optional] Property root > billing_address
@@ -25,7 +26,8 @@ | **Defined in** | #/definitions/address |
- 1.1. [Required] Property root > billing_address > street_address + + 1.1. [Required] Property root > billing_address > street_address
@@ -38,7 +40,8 @@
- 1.2. [Required] Property root > billing_address > city + + 1.2. [Required] Property root > billing_address > city
@@ -51,7 +54,8 @@
- 1.3. [Required] Property root > billing_address > state + + 1.3. [Required] Property root > billing_address > state
@@ -64,7 +68,8 @@
- 1.4. [Optional] Property root > billing_address > futureProperty + + 1.4. [Optional] Property root > billing_address > futureProperty
@@ -80,7 +85,8 @@
- 2. [Optional] Property root > shipping_address + + 2. [Optional] Property root > shipping_address
diff --git a/docs/examples/examples_md_nested_with_badges/with_descriptions.md b/docs/examples/examples_md_nested_with_badges/with_descriptions.md index 312dacbd..975f1288 100644 --- a/docs/examples/examples_md_nested_with_badges/with_descriptions.md +++ b/docs/examples/examples_md_nested_with_badges/with_descriptions.md @@ -19,7 +19,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Delivery Schema > shipping_address + + 1. [Optional] Property Delivery Schema > shipping_address
@@ -33,7 +34,8 @@ **Description:** Exact address
- 1.1. [Required] Property Delivery Schema > shipping_address > street_address + + 1.1. [Required] Property Delivery Schema > shipping_address > street_address
@@ -46,7 +48,8 @@
- 1.2. [Required] Property Delivery Schema > shipping_address > city + + 1.2. [Required] Property Delivery Schema > shipping_address > city
@@ -59,7 +62,8 @@
- 1.3. [Required] Property Delivery Schema > shipping_address > state + + 1.3. [Required] Property Delivery Schema > shipping_address > state
@@ -75,7 +79,8 @@
- 2. [Optional] Property Delivery Schema > billing_address + + 2. [Optional] Property Delivery Schema > billing_address
@@ -92,7 +97,8 @@
- 3. [Optional] Property Delivery Schema > delivery_info + + 3. [Optional] Property Delivery Schema > delivery_info
@@ -123,7 +129,8 @@ | **Defined in** | #/definitions/classic |
- 3.1.1. [Optional] Property Delivery Schema > delivery_info > oneOf > item 0 > price + + 3.1.1. [Optional] Property Delivery Schema > delivery_info > oneOf > item 0 > price
@@ -149,7 +156,8 @@ **Description:** The delivery is a gift, no prices displayed
- 3.2.1. [Optional] Property Delivery Schema > delivery_info > oneOf > item 1 > with_wrap + + 3.2.1. [Optional] Property Delivery Schema > delivery_info > oneOf > item 1 > with_wrap
diff --git a/docs/examples/examples_md_nested_with_badges/with_examples.md b/docs/examples/examples_md_nested_with_badges/with_examples.md index 5142705e..205a1c42 100644 --- a/docs/examples/examples_md_nested_with_badges/with_examples.md +++ b/docs/examples/examples_md_nested_with_badges/with_examples.md @@ -13,7 +13,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Person > firstName + + 1. [Optional] Property Person > firstName
@@ -39,7 +40,8 @@
- 2. [Optional] Property Person > lastName + + 2. [Optional] Property Person > lastName
@@ -62,7 +64,8 @@
- 3. [Optional] Property Person > age + + 3. [Optional] Property Person > age
@@ -89,7 +92,8 @@
- 4. [Optional] Property Person > moreInfo + + 4. [Optional] Property Person > moreInfo
diff --git a/docs/examples/examples_md_nested_with_badges/with_keywords.md b/docs/examples/examples_md_nested_with_badges/with_keywords.md index 691db16b..52473f79 100644 --- a/docs/examples/examples_md_nested_with_badges/with_keywords.md +++ b/docs/examples/examples_md_nested_with_badges/with_keywords.md @@ -20,7 +20,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Required] Property Person > default + + 1. [Required] Property Person > default
@@ -35,7 +36,8 @@
- 2. [Required] Property Person > examples + + 2. [Required] Property Person > examples
@@ -50,7 +52,8 @@
- 3. [Optional] Property Person > if + + 3. [Optional] Property Person > if
@@ -66,7 +69,8 @@
- 4. [Optional] Property Person > then + + 4. [Optional] Property Person > then
@@ -82,7 +86,8 @@
- 5. [Optional] Property Person > else + + 5. [Optional] Property Person > else
@@ -98,7 +103,8 @@
- 6. [Optional] Property Person > anyOf + + 6. [Optional] Property Person > anyOf
@@ -114,7 +120,8 @@
- 7. [Optional] Property Person > allOf + + 7. [Optional] Property Person > allOf
@@ -130,7 +137,8 @@
- 8. [Optional] Property Person > not + + 8. [Optional] Property Person > not
@@ -146,7 +154,8 @@
- 9. [Optional] Property Person > properties + + 9. [Optional] Property Person > properties
@@ -162,7 +171,8 @@
- 10. [Optional] Property Person > patternProperties + + 10. [Optional] Property Person > patternProperties
@@ -178,7 +188,8 @@
- 11. [Optional] Property Person > required + + 11. [Optional] Property Person > required
diff --git a/docs/examples/examples_md_nested_with_badges/with_special_chars.md b/docs/examples/examples_md_nested_with_badges/with_special_chars.md index 1d4eb6fe..402e6e22 100644 --- a/docs/examples/examples_md_nested_with_badges/with_special_chars.md +++ b/docs/examples/examples_md_nested_with_badges/with_special_chars.md @@ -15,7 +15,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property Personne > prénom + + 1. [Optional] Property Personne > prénom
@@ -30,7 +31,8 @@
- 2. [Optional] Property Personne > nomDeFamille + + 2. [Optional] Property Personne > nomDeFamille
@@ -45,7 +47,8 @@
- 3. [Optional] Property Personne > âge + + 3. [Optional] Property Personne > âge
@@ -64,7 +67,8 @@
- 4. [Optional] Property Personne > 0 de quoi d'autre + + 4. [Optional] Property Personne > 0 de quoi d'autre
@@ -89,7 +93,8 @@
- 5. [Optional] Property Personne > 名前 + + 5. [Optional] Property Personne > 名前
@@ -104,7 +109,8 @@
- 6. [Optional] Property Personne > 年齢 + + 6. [Optional] Property Personne > 年齢
diff --git a/docs/examples/examples_md_nested_with_badges/with_urlencoded_anchor.md b/docs/examples/examples_md_nested_with_badges/with_urlencoded_anchor.md index a8224337..388f8c5f 100644 --- a/docs/examples/examples_md_nested_with_badges/with_urlencoded_anchor.md +++ b/docs/examples/examples_md_nested_with_badges/with_urlencoded_anchor.md @@ -12,7 +12,8 @@ | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
- 1. [Optional] Property root > signingTimeInfo + + 1. [Optional] Property root > signingTimeInfo
@@ -24,7 +25,8 @@ | **Defined in** | #/definitions/dss2-SigningTimeInfoType |
- 1.1. [Required] Property root > signingTimeInfo > signingTime + + 1.1. [Required] Property root > signingTimeInfo > signingTime
@@ -38,7 +40,8 @@
- 1.2. [Optional] Property root > signingTimeInfo > signingTimeBounds + + 1.2. [Optional] Property root > signingTimeInfo > signingTimeBounds
@@ -50,7 +53,8 @@ | **Defined in** | #/definitions/dss2-SigningTimeInfoType%3ASigningTimeBoundaries |
- 1.2.1. [Optional] Property root > signingTimeInfo > signingTimeBounds > lowerBound + + 1.2.1. [Optional] Property root > signingTimeInfo > signingTimeBounds > lowerBound
@@ -64,7 +68,8 @@
- 1.2.2. [Optional] Property root > signingTimeInfo > signingTimeBounds > upperBound + + 1.2.2. [Optional] Property root > signingTimeInfo > signingTimeBounds > upperBound
diff --git a/docs/examples/examples_md_with_badges/Configuration.md b/docs/examples/examples_md_with_badges/Configuration.md index 32f498cc..68a7b3fd 100644 --- a/docs/examples/examples_md_with_badges/Configuration.md +++ b/docs/examples/examples_md_with_badges/Configuration.md @@ -23,6 +23,8 @@ - [20.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `JSON Schema for Humans configuration file > template_md_options > badge_as_image`](#template_md_options_badge_as_image) - [20.2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `JSON Schema for Humans configuration file > template_md_options > show_heading_numbers`](#template_md_options_show_heading_numbers) - [20.3. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `JSON Schema for Humans configuration file > template_md_options > show_array_restrictions`](#template_md_options_show_array_restrictions) + - [20.4. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `JSON Schema for Humans configuration file > template_md_options > properties_table_columns`](#template_md_options_properties_table_columns) + - [20.4.1. JSON Schema for Humans configuration file > template_md_options > properties_table_columns > properties_table_columns items](#autogenerated_heading_2) - [21. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `JSON Schema for Humans configuration file > with_footer`](#with_footer) - [22. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `JSON Schema for Humans configuration file > footer_show_time`](#footer_show_time) @@ -298,11 +300,12 @@ Adding an extra, even if the value is false, will activate it. For example `{"br **Description:** specific options to md template -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------- | -| - [badge_as_image](#template_md_options_badge_as_image ) | No | boolean | No | - | if true generate badges(eg: optional, required) using embedded image (https://img.shields.io).

if false, use text instead | -| - [show_heading_numbers](#template_md_options_show_heading_numbers ) | No | boolean | No | - | if true generate heading numbers to correspond to table of contents.

if false, do not generate heading numbers | -| - [show_array_restrictions](#template_md_options_show_array_restrictions ) | No | boolean | No | - | if true generate array restrictions section.

if false, do not generate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------------------------------------------- | ------- | ------------------------- | ---------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [badge_as_image](#template_md_options_badge_as_image ) | No | boolean | No | - | if true generate badges(eg: optional, required) using embedded image (https://img.shields.io).

if false, use text instead | +| - [show_heading_numbers](#template_md_options_show_heading_numbers ) | No | boolean | No | - | if true generate heading numbers to correspond to table of contents.

if false, do not generate heading numbers | +| - [show_array_restrictions](#template_md_options_show_array_restrictions ) | No | boolean | No | - | if true generate array restrictions section.

if false, do not generate | +| - [properties_table_columns](#template_md_options_properties_table_columns ) | No | array of enum (of string) | No | - | array of column names to display in the properties table.

if empty, the default is ['Property','Pattern','Type','Deprecated','Definition','Title/Description'] | ### 20.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `JSON Schema for Humans configuration file > template_md_options > badge_as_image` @@ -337,6 +340,42 @@ Adding an extra, even if the value is false, will activate it. For example `{"br if false, do not generate +### 20.4. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `JSON Schema for Humans configuration file > template_md_options > properties_table_columns` + +| | | +| -------- | --------------------------- | +| **Type** | `array of enum (of string)` | + +**Description:** array of column names to display in the properties table. + + if empty, the default is ['Property','Pattern','Type','Deprecated','Definition','Title/Description'] + +| | Array restrictions | +| -------------------- | ------------------ | +| **Min items** | N/A | +| **Max items** | N/A | +| **Items unicity** | False | +| **Additional items** | False | +| **Tuple validation** | See below | + +| Each item of this array must be | Description | +| ------------------------------------------------------------------------------------- | ----------- | +| [properties_table_columns items](#template_md_options_properties_table_columns_items) | - | + +#### 20.4.1. JSON Schema for Humans configuration file > template_md_options > properties_table_columns > properties_table_columns items + +| | | +| -------- | ------------------ | +| **Type** | `enum (of string)` | + +Must be one of: +* "Property" +* "Pattern" +* "Type" +* "Deprecated" +* "Definition" +* "Title/Description" + ## 21. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `JSON Schema for Humans configuration file > with_footer` | | | diff --git a/json_schema_for_humans/templates/md_nested/section_properties_details.md b/json_schema_for_humans/templates/md_nested/section_properties_details.md index a4f306a2..6143144e 100644 --- a/json_schema_for_humans/templates/md_nested/section_properties_details.md +++ b/json_schema_for_humans/templates/md_nested/section_properties_details.md @@ -7,7 +7,8 @@ {% set description = sub_property | get_description %}
-{% filter md_heading(depth + 1, html_id, True) -%} + + {% filter md_heading(depth + 1, html_id, True) -%} {%- filter replace('\n', '') -%} {%- if not skip_required and sub_property.property_name -%} {{ md_badge("Required", "blue", show_text=True) if sub_property.is_required_property else md_badge("Optional", "yellow", show_text=True) -}} diff --git a/tests/test_md_generate.py b/tests/test_md_generate.py index 1d8b3118..a793c012 100644 --- a/tests/test_md_generate.py +++ b/tests/test_md_generate.py @@ -12,19 +12,6 @@ parent_dir = os.path.abspath(os.path.dirname(current_dir)) examples_dir = os.path.join(parent_dir, "docs", "examples") -config_badge = GenerationConfiguration( - template_name="md", - template_md_options={"badge_as_image": True}, - deprecated_from_description=True, - footer_show_time=False, -) -config_no_badge = GenerationConfiguration( - template_name="md", - template_md_options={"badge_as_image": False}, - deprecated_from_description=True, - footer_show_time=False, -) - @dataclass class TestCase: @@ -46,11 +33,25 @@ def list_cases() -> List[str]: class TestMdGenerate(MdUtilsAsserts): @pytest.mark.parametrize("test_case", list_cases()) @pytest.mark.parametrize("with_badge", [True, False]) - def test_basic(self, test_case: str, with_badge: bool): + @pytest.mark.parametrize("nested", [True, False]) + def test_basic(self, test_case: str, with_badge: bool, nested: bool): """Test rendering a basic schema with title""" + dir_name = "examples_md" + if nested: + dir_name = f"{dir_name}_nested" + if with_badge: + dir_name = f"{dir_name}_with_badges" + else: + dir_name = f"{dir_name}_default" + self.assert_case_equals( examples_dir, - "examples_md_with_badges" if with_badge else "examples_md_default", + dir_name, test_case, - config_badge if with_badge else config_no_badge, + GenerationConfiguration( + template_name="md_nested" if nested else "md", + template_md_options={"badge_as_image": with_badge}, + deprecated_from_description=True, + footer_show_time=False, + ), )