From 635b4e9e48d74e88c97348df0ed8f8b7a2029575 Mon Sep 17 00:00:00 2001 From: Denis Blanchette Date: Fri, 29 Nov 2024 16:29:07 -0500 Subject: [PATCH] fix: Badge will not have invalid links anymore --- .../examples_md_default/Configuration.md | 108 ++-- .../additional_properties.md | 40 +- .../examples_md_default/anyOf_option_names.md | 66 +-- docs/examples/examples_md_default/array.md | 22 +- .../array_additionalItems.md | 10 +- .../examples_md_default/array_advanced.md | 20 +- .../examples_md_default/array_example.md | 10 +- docs/examples/examples_md_default/basic.md | 20 +- .../examples_md_default/break_on_newline.md | 10 +- .../examples_md_default/broken_ref.md | 22 +- docs/examples/examples_md_default/circular.md | 22 +- .../examples_md_default/combining_not.md | 20 +- .../examples_md_default/combining_oneOf.md | 68 +-- .../conditional_subschema.md | 50 +- .../conditional_subschema_no_else.md | 100 ++-- docs/examples/examples_md_default/defaults.md | 38 +- .../examples_md_default/deprecated.md | 72 +-- .../description_from_ref.md | 10 +- .../description_markdown.md | 10 +- .../description_with_ref.md | 34 +- .../empty_property_name.md | 10 +- .../examples_md_default/enumofnone.md | 10 +- docs/examples/examples_md_default/geo.md | 10 +- .../html_in_description.md | 10 +- .../examples_md_default/long_description.md | 10 +- .../examples_md_default/multiple_types.md | 10 +- .../examples_md_default/pattern_properties.md | 20 +- .../pattern_properties_html_id.md | 60 +-- .../examples_md_default/prefixItems.md | 10 +- .../examples/examples_md_default/recursive.md | 34 +- .../examples_md_default/recursive_array.md | 34 +- .../recursive_full_schema.md | 44 +- .../recursive_full_schema_simple.md | 22 +- .../recursive_parent_in_definition.md | 56 +- .../recursive_two_files.md | 46 +- .../recursive_two_files2.md | 10 +- .../examples/examples_md_default/ref_merge.md | 24 +- .../ref_with_other_elements.md | 10 +- .../examples_md_default/ref_with_tabs.md | 494 +++++++++--------- .../examples_md_default/reference_int.md | 34 +- .../examples_md_default/references.md | 104 ++-- .../examples_md_default/references_url.md | 10 +- .../references_url_two_levels.md | 12 +- .../references_url_yaml.md | 12 +- .../required_properties_order.md | 30 +- .../single_element_allOf.md | 10 +- .../top_level_combining.md | 58 +- .../examples_md_default/type_object_null.md | 10 +- .../examples_md_default/with_default.md | 10 +- .../examples_md_default/with_definitions.md | 34 +- .../examples_md_default/with_descriptions.md | 70 +-- .../examples_md_default/with_examples.md | 20 +- .../examples_md_default/with_keywords.md | 100 ++-- .../examples_md_default/with_special_chars.md | 10 +- .../with_urlencoded_anchor.md | 34 +- .../Configuration.md | 56 +- .../additional_properties.md | 40 +- .../anyOf_option_names.md | 66 +-- .../examples_md_nested_default/array.md | 22 +- .../array_additionalItems.md | 10 +- .../array_advanced.md | 20 +- .../array_example.md | 10 +- .../examples_md_nested_default/basic.md | 20 +- .../break_on_newline.md | 10 +- .../examples_md_nested_default/broken_ref.md | 22 +- .../examples_md_nested_default/circular.md | 22 +- .../combining_not.md | 20 +- .../combining_oneOf.md | 68 +-- .../conditional_subschema.md | 50 +- .../conditional_subschema_no_else.md | 100 ++-- .../examples_md_nested_default/defaults.md | 38 +- .../examples_md_nested_default/deprecated.md | 58 +- .../description_from_ref.md | 10 +- .../description_markdown.md | 10 +- .../description_with_ref.md | 34 +- .../empty_property_name.md | 10 +- .../examples_md_nested_default/enumofnone.md | 10 +- .../examples_md_nested_default/geo.md | 10 +- .../html_in_description.md | 10 +- .../long_description.md | 10 +- .../multiple_types.md | 10 +- .../pattern_properties.md | 20 +- .../pattern_properties_html_id.md | 60 +-- .../examples_md_nested_default/prefixItems.md | 10 +- .../examples_md_nested_default/recursive.md | 34 +- .../recursive_array.md | 34 +- .../recursive_full_schema.md | 44 +- .../recursive_full_schema_simple.md | 22 +- .../recursive_parent_in_definition.md | 56 +- .../recursive_two_files.md | 46 +- .../recursive_two_files2.md | 10 +- .../examples_md_nested_default/ref_merge.md | 24 +- .../ref_with_other_elements.md | 10 +- .../ref_with_tabs.md | 494 +++++++++--------- .../reference_int.md | 34 +- .../examples_md_nested_default/references.md | 104 ++-- .../references_url.md | 10 +- .../references_url_two_levels.md | 12 +- .../references_url_yaml.md | 12 +- .../required_properties_order.md | 30 +- .../single_element_allOf.md | 10 +- .../top_level_combining.md | 58 +- .../type_object_null.md | 10 +- .../with_default.md | 10 +- .../with_definitions.md | 34 +- .../with_descriptions.md | 70 +-- .../with_examples.md | 20 +- .../with_keywords.md | 100 ++-- .../with_special_chars.md | 10 +- .../with_urlencoded_anchor.md | 34 +- .../Configuration.md | 49 +- .../additional_properties.md | 32 +- .../anyOf_option_names.md | 54 +- .../examples_md_nested_with_badges/array.md | 18 +- .../array_additionalItems.md | 8 +- .../array_advanced.md | 16 +- .../array_example.md | 8 +- .../examples_md_nested_with_badges/basic.md | 16 +- .../break_on_newline.md | 8 +- .../broken_ref.md | 18 +- .../circular.md | 18 +- .../combining_not.md | 16 +- .../combining_oneOf.md | 56 +- .../conditional_subschema.md | 40 +- .../conditional_subschema_no_else.md | 80 +-- .../defaults.md | 32 +- .../deprecated.md | 52 +- .../description_from_ref.md | 8 +- .../description_markdown.md | 8 +- .../description_with_ref.md | 28 +- .../empty_property_name.md | 8 +- .../enumofnone.md | 8 +- .../examples_md_nested_with_badges/geo.md | 8 +- .../html_in_description.md | 8 +- .../long_description.md | 8 +- .../multiple_types.md | 8 +- .../pattern_properties.md | 16 +- .../pattern_properties_html_id.md | 48 +- .../prefixItems.md | 8 +- .../recursive.md | 28 +- .../recursive_array.md | 28 +- .../recursive_full_schema.md | 36 +- .../recursive_full_schema_simple.md | 18 +- .../recursive_parent_in_definition.md | 46 +- .../recursive_two_files.md | 38 +- .../recursive_two_files2.md | 8 +- .../ref_merge.md | 20 +- .../ref_with_other_elements.md | 8 +- .../ref_with_tabs.md | 400 +++++++------- .../reference_int.md | 28 +- .../references.md | 86 +-- .../references_url.md | 8 +- .../references_url_two_levels.md | 10 +- .../references_url_yaml.md | 18 +- .../required_properties_order.md | 24 +- .../single_element_allOf.md | 8 +- .../top_level_combining.md | 48 +- .../type_object_null.md | 8 +- .../with_default.md | 8 +- .../with_definitions.md | 28 +- .../with_descriptions.md | 58 +- .../with_examples.md | 16 +- .../with_keywords.md | 80 +-- .../with_special_chars.md | 8 +- .../with_urlencoded_anchor.md | 28 +- .../examples_md_with_badges/Configuration.md | 49 +- .../additional_properties.md | 32 +- .../anyOf_option_names.md | 54 +- .../examples/examples_md_with_badges/array.md | 18 +- .../array_additionalItems.md | 8 +- .../examples_md_with_badges/array_advanced.md | 16 +- .../examples_md_with_badges/array_example.md | 8 +- .../examples/examples_md_with_badges/basic.md | 16 +- .../break_on_newline.md | 8 +- .../examples_md_with_badges/broken_ref.md | 18 +- .../examples_md_with_badges/circular.md | 18 +- .../examples_md_with_badges/combining_not.md | 16 +- .../combining_oneOf.md | 56 +- .../conditional_subschema.md | 40 +- .../conditional_subschema_no_else.md | 80 +-- .../examples_md_with_badges/defaults.md | 32 +- .../examples_md_with_badges/deprecated.md | 52 +- .../description_from_ref.md | 8 +- .../description_markdown.md | 8 +- .../description_with_ref.md | 28 +- .../empty_property_name.md | 8 +- .../examples_md_with_badges/enumofnone.md | 8 +- docs/examples/examples_md_with_badges/geo.md | 8 +- .../html_in_description.md | 8 +- .../long_description.md | 8 +- .../examples_md_with_badges/multiple_types.md | 8 +- .../pattern_properties.md | 16 +- .../pattern_properties_html_id.md | 48 +- .../examples_md_with_badges/prefixItems.md | 8 +- .../examples_md_with_badges/recursive.md | 28 +- .../recursive_array.md | 28 +- .../recursive_full_schema.md | 36 +- .../recursive_full_schema_simple.md | 18 +- .../recursive_parent_in_definition.md | 46 +- .../recursive_two_files.md | 38 +- .../recursive_two_files2.md | 8 +- .../examples_md_with_badges/ref_merge.md | 20 +- .../ref_with_other_elements.md | 8 +- .../examples_md_with_badges/ref_with_tabs.md | 400 +++++++------- .../examples_md_with_badges/reference_int.md | 28 +- .../examples_md_with_badges/references.md | 86 +-- .../examples_md_with_badges/references_url.md | 8 +- .../references_url_two_levels.md | 10 +- .../references_url_yaml.md | 18 +- .../required_properties_order.md | 24 +- .../single_element_allOf.md | 8 +- .../top_level_combining.md | 48 +- .../type_object_null.md | 8 +- .../examples_md_with_badges/with_default.md | 8 +- .../with_definitions.md | 28 +- .../with_descriptions.md | 58 +- .../examples_md_with_badges/with_examples.md | 16 +- .../examples_md_with_badges/with_keywords.md | 80 +-- .../with_special_chars.md | 8 +- .../with_urlencoded_anchor.md | 28 +- .../generation_configuration.py | 4 + json_schema_for_humans/md_template.py | 70 +-- .../md/section_properties_details.md | 12 +- .../md_nested/section_properties_details.md | 16 +- 224 files changed, 4043 insertions(+), 4019 deletions(-) diff --git a/docs/examples/examples_md_default/Configuration.md b/docs/examples/examples_md_default/Configuration.md index d0f93323..3286f6a5 100644 --- a/docs/examples/examples_md_default/Configuration.md +++ b/docs/examples/examples_md_default/Configuration.md @@ -32,11 +32,11 @@ **Title:** JSON Schema for Humans configuration file -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Choose how to generate JSON Schema for Humans documentation file. @@ -46,32 +46,32 @@ Configuration parameters can be provided in several ways: - On the CLI using a config file `--config-file config.json` - From code, by providing a GenerationConfiguration object to the called generation method. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------------------------------- | ------- | ------------------------ | ------------ | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| - [description_is_markdown](#description_is_markdown ) | No | boolean | No | - | (HTML outputs only)
Whether to consider the description as Markdown and render it accordingly. | -| - [description_safe_mode](#description_safe_mode ) | No | enum (of null or string) | No | - | (HTML outputs only)
(Only used with \`description_is_markdown\`)
How are HTML tags in descriptions handled. Correspond to the \`safe_mode\` option of the markdown2 library.

- "escape": Escape all HTML tags in descriptions
- "replace": Replace HTML tags with \`[HTML_REMOVED]\`
- null: Allow HTML in descriptions | -| - [expand_buttons](#expand_buttons ) | No | boolean | No | - | Add an \`Expand all\` and a \`Collapse all\` button at the top of the generated documentation. | -| - [show_breadcrumbs](#show_breadcrumbs ) | No | boolean | No | - | For each property, show the relative place of that property in the schema. | -| - [collapse_long_descriptions](#collapse_long_descriptions ) | No | boolean | No | - | If a description is considered big, show only the beginning and add a \`Read more\` button. | -| - [collapse_long_examples](#collapse_long_examples ) | No | boolean | No | - | If an example is considered big, collapse it, it can be displayed with a \`Show\` option. | -| - [link_to_reused_ref](#link_to_reused_ref ) | No | boolean | No | - | If several \`$ref\` points to the same definition, only render the documentation for this definition the first time. All other occurrences are replaced by an anchor link to the first occurrence. The first occurrence is the one that is the least nested from the top of the schema and appears first in that nesting level.

*Note*: If this option is off and the schema contains recursive definitions, the generation will crash! | -| - [recursive_detection_depth](#recursive_detection_depth ) | No | integer | No | - | *Advanced option*
If \`link_to_reused_ref\` is false and a \`$ref\` in the schema refers to a parent of itself, we would get a \`RecursionError\` trying to render the documentation. To avoid this, each reference is checked for circular references.

This option determines the number of times to recursively follow definitions looking for a circular reference.

In other words, if a schema has a deeply nested element that refers to itself, this option may need to be increased. | -| - [deprecated_from_description](#deprecated_from_description ) | No | boolean | No | - | Mark a property as deprecated (with a big red badge) if the description contains the string \`[​Deprecated\`. | -| - [default_from_description](#default_from_description ) | No | boolean | No | - | Extract the default value of a property from the description like this: \`\`[Default \`the_default_value\`]\`\`.

The default value from the "default" attribute will be used in priority. | -| - [copy_css](#copy_css ) | No | boolean | No | - | Copy \`schema_doc.css\` to the same directory as \`RESULT_FILE\` after generation. | -| - [copy_js](#copy_js ) | No | boolean | No | - | Copy \`schema_doc.min.js\` to the same directory as \`RESULT_FILE\` after generation.

This file contains the logic for the anchor links. | -| - [template_name](#template_name ) | No | enum (of string) | No | - | The name of the built-in template to use to render the documentation.

\`js\` is the default and uses javascript for anchor links, collapsible sections and tabs.

\`js_offline\` is identical to \`js\` except that all CSS, fonts and JavaScript are bundled for offline use.

\`flat\` uses no javascript, but has no interactivity.

\`md\` is the markdown template.

\`md_nested\` is the markdown template with collapsible nested sections. | -| - [custom_template_path](#custom_template_path ) | No | string | No | - | Path to a custom Jinja2 template file.

There can be multiple files to split the template, but this path should be the entry point.

If no output file is specified, the extension of the template file will be used to determine the output documentation extension. i.e. if the template is in ./custom_template/content.html, the resulting documentation will have the html extension. | -| - [show_toc](#show_toc ) | No | boolean | No | - | Whether to render table of contents. | -| - [examples_as_yaml](#examples_as_yaml ) | No | boolean | No | - | Whether to display examples as YAML instead of JSON | -| - [old_anchor_links](#old_anchor_links ) | No | boolean | No | - | Generate HTML ids for anchor links without special characters (keep only letters, digits, \`_\`, and \`-\`).

This is the old behaviour and is only needed for browsers that do not support HTML 5. | -| - [markdown_options](#markdown_options ) | No | object | No | - | (Only used with \`description_is_markdown\`)
[Markdown 2 options](https://github.com/trentm/python-markdown2/wiki/Extras) for the descriptions. | -| - [template_md_options](#template_md_options ) | No | object | No | - | specific options to md template | -| - [with_footer](#with_footer ) | No | boolean | No | - | Whether to show the footer linking to the library repo and with the generation datetime | -| - [footer_show_time](#footer_show_time ) | No | boolean | No | - | Whether the footer should display the generation time | -| - [allow_html_description](#allow_html_description ) | No | boolean | [Deprecated] | - | [Deprecated] | -| - [minify](#minify ) | No | boolean | [Deprecated] | - | [Deprecated] | -| - [templates_directory](#templates_directory ) | No | string | [Deprecated] | - | [Deprecated] | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------------------------------- | ------- | ------------------------ | ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| - [description_is_markdown](#description_is_markdown ) | No | boolean | No | - | (HTML outputs only)
Whether to consider the description as Markdown and render it accordingly. | +| - [description_safe_mode](#description_safe_mode ) | No | enum (of null or string) | No | - | (HTML outputs only)
(Only used with \`description_is_markdown\`)
How are HTML tags in descriptions handled. Correspond to the \`safe_mode\` option of the markdown2 library.

- "escape": Escape all HTML tags in descriptions
- "replace": Replace HTML tags with \`[HTML_REMOVED]\`
- null: Allow HTML in descriptions | +| - [expand_buttons](#expand_buttons ) | No | boolean | No | - | Add an \`Expand all\` and a \`Collapse all\` button at the top of the generated documentation. | +| - [show_breadcrumbs](#show_breadcrumbs ) | No | boolean | No | - | For each property, show the relative place of that property in the schema. | +| - [collapse_long_descriptions](#collapse_long_descriptions ) | No | boolean | No | - | If a description is considered big, show only the beginning and add a \`Read more\` button. | +| - [collapse_long_examples](#collapse_long_examples ) | No | boolean | No | - | If an example is considered big, collapse it, it can be displayed with a \`Show\` option. | +| - [link_to_reused_ref](#link_to_reused_ref ) | No | boolean | No | - | If several \`$ref\` points to the same definition, only render the documentation for this definition the first time. All other occurrences are replaced by an anchor link to the first occurrence. The first occurrence is the one that is the least nested from the top of the schema and appears first in that nesting level.

*Note*: If this option is off and the schema contains recursive definitions, the generation will crash! | +| - [recursive_detection_depth](#recursive_detection_depth ) | No | integer | No | - | *Advanced option*
If \`link_to_reused_ref\` is false and a \`$ref\` in the schema refers to a parent of itself, we would get a \`RecursionError\` trying to render the documentation. To avoid this, each reference is checked for circular references.

This option determines the number of times to recursively follow definitions looking for a circular reference.

In other words, if a schema has a deeply nested element that refers to itself, this option may need to be increased. | +| - [deprecated_from_description](#deprecated_from_description ) | No | boolean | No | - | Mark a property as deprecated (with a big red badge) if the description contains the string \`[​Deprecated\`. | +| - [default_from_description](#default_from_description ) | No | boolean | No | - | Extract the default value of a property from the description like this: \`\`[Default \`the_default_value\`]\`\`.

The default value from the "default" attribute will be used in priority. | +| - [copy_css](#copy_css ) | No | boolean | No | - | Copy \`schema_doc.css\` to the same directory as \`RESULT_FILE\` after generation. | +| - [copy_js](#copy_js ) | No | boolean | No | - | Copy \`schema_doc.min.js\` to the same directory as \`RESULT_FILE\` after generation.

This file contains the logic for the anchor links. | +| - [template_name](#template_name ) | No | enum (of string) | No | - | The name of the built-in template to use to render the documentation.

\`js\` is the default and uses javascript for anchor links, collapsible sections and tabs.

\`js_offline\` is identical to \`js\` except that all CSS, fonts and JavaScript are bundled for offline use.

\`flat\` uses no javascript, but has no interactivity.

\`md\` is the markdown template.

\`md_nested\` is the markdown template with collapsible nested sections. | +| - [custom_template_path](#custom_template_path ) | No | string | No | - | Path to a custom Jinja2 template file.

There can be multiple files to split the template, but this path should be the entry point.

If no output file is specified, the extension of the template file will be used to determine the output documentation extension. i.e. if the template is in ./custom_template/content.html, the resulting documentation will have the html extension. | +| - [show_toc](#show_toc ) | No | boolean | No | - | Whether to render table of contents. | +| - [examples_as_yaml](#examples_as_yaml ) | No | boolean | No | - | Whether to display examples as YAML instead of JSON | +| - [old_anchor_links](#old_anchor_links ) | No | boolean | No | - | Generate HTML ids for anchor links without special characters (keep only letters, digits, \`_\`, and \`-\`).

This is the old behaviour and is only needed for browsers that do not support HTML 5. | +| - [markdown_options](#markdown_options ) | No | object | No | - | (Only used with \`description_is_markdown\`)
[Markdown 2 options](https://github.com/trentm/python-markdown2/wiki/Extras) for the descriptions. | +| - [template_md_options](#template_md_options ) | No | object | No | - | specific options to md template | +| - [with_footer](#with_footer ) | No | boolean | No | - | Whether to show the footer linking to the library repo and with the generation datetime | +| - [footer_show_time](#footer_show_time ) | No | boolean | No | - | Whether the footer should display the generation time | +| - [allow_html_description](#allow_html_description ) | No | boolean | Deprecated | - | [Deprecated] | +| - [minify](#minify ) | No | boolean | Deprecated | - | [Deprecated] | +| - [templates_directory](#templates_directory ) | No | string | Deprecated | - | [Deprecated] | ## 1. Property `JSON Schema for Humans configuration file > description_is_markdown` @@ -295,7 +295,7 @@ This is the old behaviour and is only needed for browsers that do not support HT | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | **Type** | `object` | | **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Additional properties** | Any type allowed | | **Default** | `{"fenced-code-blocks": {"cssclass": "highlight jumbotron"}, "tables": null, "breaks": {"on_newline": true, "on_backslash": true}}` | **Description:** (Only used with `description_is_markdown`) @@ -316,11 +316,11 @@ This is the old behaviour and is only needed for browsers that do not support HT ## 19. Property `JSON Schema for Humans configuration file > template_md_options` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** specific options to md template @@ -427,33 +427,33 @@ Must be one of: ## 22. ~~ Property `JSON Schema for Humans configuration file > allow_html_description`~~ -| | | -| -------------- | ------------ | -| **Type** | `boolean` | -| **Required** | No | -| **Deprecated** | [Deprecated] | -| **Default** | `false` | +| | | +| -------------- | --------- | +| **Type** | `boolean` | +| **Required** | No | +| **Deprecated** | +| **Default** | `false` | **Description:** [Deprecated] ## 23. ~~ Property `JSON Schema for Humans configuration file > minify`~~ -| | | -| -------------- | ------------ | -| **Type** | `boolean` | -| **Required** | No | -| **Deprecated** | [Deprecated] | -| **Default** | `true` | +| | | +| -------------- | --------- | +| **Type** | `boolean` | +| **Required** | No | +| **Deprecated** | +| **Default** | `true` | **Description:** [Deprecated] ## 24. ~~ Property `JSON Schema for Humans configuration file > templates_directory`~~ -| | | -| -------------- | ------------ | -| **Type** | `string` | -| **Required** | No | -| **Deprecated** | [Deprecated] | +| | | +| -------------- | -------- | +| **Type** | `string` | +| **Required** | No | +| **Deprecated** | **Description:** [Deprecated] diff --git a/docs/examples/examples_md_default/additional_properties.md b/docs/examples/examples_md_default/additional_properties.md index e48d6c3a..5118f49b 100644 --- a/docs/examples/examples_md_default/additional_properties.md +++ b/docs/examples/examples_md_default/additional_properties.md @@ -10,11 +10,11 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Should-conform]](#additionalProperties "Each additional property must conform to the following schema") | +| | | +| ------------------------- | ---------------------------------------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | [Each additional property must conform to the schema](#additionalProperties) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------- | ------- | ------- | ---------- | ---------- | -------------------------------------------------------------------------- | @@ -25,11 +25,11 @@ ## 1. Property `Person > subType1` -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | **Description:** A sub type with additionalProperties false. @@ -46,11 +46,11 @@ ## 2. Property `Person > subType2` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** A sub type with additionalProperties true. @@ -77,11 +77,11 @@ ## 4. Property `Person > additionalProperties` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** additionalProperties schema. diff --git a/docs/examples/examples_md_default/anyOf_option_names.md b/docs/examples/examples_md_default/anyOf_option_names.md index 62bae3ad..65b6181c 100644 --- a/docs/examples/examples_md_default/anyOf_option_names.md +++ b/docs/examples/examples_md_default/anyOf_option_names.md @@ -6,11 +6,11 @@ - [1.3. Property `root > storage > anyOf > item 2`](#storage_anyOf_i2) - [1.4. Property `root > storage > anyOf > tmpfs`](#storage_anyOf_i3) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** JSON Schema for an fstab entry @@ -20,11 +20,11 @@ ## 1. Property `root > storage` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | Yes | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | Yes | +| **Additional properties** | Any type allowed | | Any of(Option) | | ------------------------------- | @@ -35,38 +35,38 @@ ### 1.1. Property `root > storage > anyOf > diskDevice` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskDevice | +| | | +| ------------------------- | ------------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/diskDevice | ### 1.2. Property `root > storage > anyOf > diskUUID` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskUUID | +| | | +| ------------------------- | ---------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/diskUUID | ### 1.3. Property `root > storage > anyOf > item 2` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ### 1.4. Property `root > storage > anyOf > tmpfs` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/tmpfs | +| | | +| ------------------------- | ------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/tmpfs | ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) diff --git a/docs/examples/examples_md_default/array.md b/docs/examples/examples_md_default/array.md index c227509a..e26086c7 100644 --- a/docs/examples/examples_md_default/array.md +++ b/docs/examples/examples_md_default/array.md @@ -7,11 +7,11 @@ - [2.1.1. Property `root > vegetables > vegetables items > veggieName`](#vegetables_items_veggieName) - [2.1.2. Property `root > vegetables > vegetables items > veggieLike`](#vegetables_items_veggieLike) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** A schema with an array @@ -67,12 +67,12 @@ ### 2.1. root > vegetables > veggie -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/veggie | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/veggie | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | --------------------------------------------- | ------- | ------- | ---------- | ---------- | -------------------------- | diff --git a/docs/examples/examples_md_default/array_additionalItems.md b/docs/examples/examples_md_default/array_additionalItems.md index e30ae111..4af01146 100644 --- a/docs/examples/examples_md_default/array_additionalItems.md +++ b/docs/examples/examples_md_default/array_additionalItems.md @@ -9,11 +9,11 @@ - [2.1. root > addressLines > addressLines item 0](#autogenerated_heading_6) - [3. Property `root > arrayEmpty`](#arrayEmpty) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** A little food fun diff --git a/docs/examples/examples_md_default/array_advanced.md b/docs/examples/examples_md_default/array_advanced.md index dd26262f..7448e2a6 100644 --- a/docs/examples/examples_md_default/array_advanced.md +++ b/docs/examples/examples_md_default/array_advanced.md @@ -6,11 +6,11 @@ - [2.1. root > vegetables > vegetables items](#vegetables_items) - [2.2. At least one of the items must be](#autogenerated_heading_2) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** A little food fun @@ -68,11 +68,11 @@ ### 2.1. root > vegetables > vegetables items -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ### 2.2. At least one of the items must be diff --git a/docs/examples/examples_md_default/array_example.md b/docs/examples/examples_md_default/array_example.md index 217b0a54..e61b20af 100644 --- a/docs/examples/examples_md_default/array_example.md +++ b/docs/examples/examples_md_default/array_example.md @@ -3,11 +3,11 @@ - [1. Property `root > fruits`](#fruits) - [1.1. root > fruits > fruits items](#fruits_items) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** A schema with an array diff --git a/docs/examples/examples_md_default/basic.md b/docs/examples/examples_md_default/basic.md index f8607a2e..52f8dca9 100644 --- a/docs/examples/examples_md_default/basic.md +++ b/docs/examples/examples_md_default/basic.md @@ -9,11 +9,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------- | @@ -61,11 +61,11 @@ ## 4. Property `Person > driverLicenseId` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | | All of(Requirement) | | ---------------------------------------------- | diff --git a/docs/examples/examples_md_default/break_on_newline.md b/docs/examples/examples_md_default/break_on_newline.md index e7138ca6..d56a7b80 100644 --- a/docs/examples/examples_md_default/break_on_newline.md +++ b/docs/examples/examples_md_default/break_on_newline.md @@ -4,11 +4,11 @@ **Title:** Hello -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | diff --git a/docs/examples/examples_md_default/broken_ref.md b/docs/examples/examples_md_default/broken_ref.md index 1a884d46..1ee159aa 100644 --- a/docs/examples/examples_md_default/broken_ref.md +++ b/docs/examples/examples_md_default/broken_ref.md @@ -5,11 +5,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------- | ------- | ------ | ---------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- | @@ -29,12 +29,12 @@ ## 2. Property `Person > lastName` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | a_file_that_does_not_exist_and_will_never_i_hope.lol.json | +| | | +| ------------------------- | --------------------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | a_file_that_does_not_exist_and_will_never_i_hope.lol.json | **Description:** 😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️ diff --git a/docs/examples/examples_md_default/circular.md b/docs/examples/examples_md_default/circular.md index 963496a8..c946c2ae 100644 --- a/docs/examples/examples_md_default/circular.md +++ b/docs/examples/examples_md_default/circular.md @@ -5,11 +5,11 @@ **Title:** Circular reference Schema -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------- | ------- | ------ | ---------- | ------------------ | ----------------- | @@ -17,12 +17,12 @@ ## 1. Property `Circular reference Schema > person` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/a | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/a | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------- | ------- | ------ | ---------- | ------------------ | ------------------ | diff --git a/docs/examples/examples_md_default/combining_not.md b/docs/examples/examples_md_default/combining_not.md index 82ec8d91..d00cd0cd 100644 --- a/docs/examples/examples_md_default/combining_not.md +++ b/docs/examples/examples_md_default/combining_not.md @@ -3,11 +3,11 @@ - [1. Property `root > not_a_string`](#not_a_string) - [1.1. Must **not** be](#autogenerated_heading_2) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Test schema with a not @@ -17,11 +17,11 @@ ## 1. Property `root > not_a_string` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | Yes | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | Yes | +| **Additional properties** | Any type allowed | ### 1.1. Must **not** be diff --git a/docs/examples/examples_md_default/combining_oneOf.md b/docs/examples/examples_md_default/combining_oneOf.md index f4bf037d..829255c3 100644 --- a/docs/examples/examples_md_default/combining_oneOf.md +++ b/docs/examples/examples_md_default/combining_oneOf.md @@ -6,11 +6,11 @@ - [1.3. Property `root > storage > oneOf > nfs`](#storage_oneOf_i2) - [1.4. Property `root > storage > oneOf > tmpfs`](#storage_oneOf_i3) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** JSON Schema for an fstab entry @@ -20,11 +20,11 @@ ## 1. Property `root > storage` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | Yes | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | Yes | +| **Additional properties** | Any type allowed | | One of(Option) | | ------------------------------- | @@ -35,39 +35,39 @@ ### 1.1. Property `root > storage > oneOf > diskDevice` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskDevice | +| | | +| ------------------------- | ------------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/diskDevice | ### 1.2. Property `root > storage > oneOf > diskUUID` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskUUID | +| | | +| ------------------------- | ---------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/diskUUID | ### 1.3. Property `root > storage > oneOf > nfs` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/nfs | +| | | +| ------------------------- | ----------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/nfs | ### 1.4. Property `root > storage > oneOf > tmpfs` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/tmpfs | +| | | +| ------------------------- | ------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/tmpfs | ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) diff --git a/docs/examples/examples_md_default/conditional_subschema.md b/docs/examples/examples_md_default/conditional_subschema.md index 181fae46..e93d42c2 100644 --- a/docs/examples/examples_md_default/conditional_subschema.md +++ b/docs/examples/examples_md_default/conditional_subschema.md @@ -7,11 +7,11 @@ - [3. Property `root > street_address`](#street_address) - [4. Property `root > country`](#country) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------ | ------- | ---------------- | ---------- | ---------- | ----------------- | @@ -20,11 +20,11 @@ ## 1. If (country = "United States of America") -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ----------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -32,11 +32,11 @@ ### 1.1. Property `root > then > postal_code` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------------------- | @@ -44,11 +44,11 @@ ## 2. Else (i.e. country != "United States of America") -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ----------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -56,11 +56,11 @@ ### 2.1. Property `root > else > postal_code` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/examples/examples_md_default/conditional_subschema_no_else.md b/docs/examples/examples_md_default/conditional_subschema_no_else.md index 63155513..2a76725a 100644 --- a/docs/examples/examples_md_default/conditional_subschema_no_else.md +++ b/docs/examples/examples_md_default/conditional_subschema_no_else.md @@ -12,11 +12,11 @@ - [4. Property `root > street_address`](#street_address) - [5. Property `root > country`](#country) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------ | ------- | ---------------- | ---------- | ---------- | ----------------- | @@ -31,19 +31,19 @@ ## 1. Property `root > allOf > item 0` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ### 1.1. If (country = "United States of America") -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -51,11 +51,11 @@ #### 1.1.1. Property `root > allOf > item 0 > then > postal_code` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------------------- | @@ -63,19 +63,19 @@ ## 2. Property `root > allOf > item 1` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ### 2.1. If (country = "Canada") -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -83,11 +83,11 @@ #### 2.1.1. Property `root > allOf > item 1 > then > postal_code` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | @@ -95,19 +95,19 @@ ## 3. Property `root > allOf > item 2` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ### 3.1. If (country = "Netherlands") -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -115,11 +115,11 @@ #### 3.1.1. Property `root > allOf > item 2 > then > postal_code` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------- | diff --git a/docs/examples/examples_md_default/defaults.md b/docs/examples/examples_md_default/defaults.md index 7b64666b..612d7ad0 100644 --- a/docs/examples/examples_md_default/defaults.md +++ b/docs/examples/examples_md_default/defaults.md @@ -3,11 +3,11 @@ - [1. Property `root > a`](#a) - [2. Property `root > b`](#b) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------- | ------- | ------ | ---------- | ----------------------- | -------------------- | @@ -16,25 +16,25 @@ ## 1. Property `root > a` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Default** | `"Default from a"` | -| **Defined in** | #/definitions/common | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Default** | `"Default from a"` | +| **Defined in** | #/definitions/common | **Description:** Description of a ## 2. Property `root > b` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Default** | `"Default from b"` | -| **Defined in** | #/definitions/common | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Default** | `"Default from b"` | +| **Defined in** | #/definitions/common | **Description:** A common description diff --git a/docs/examples/examples_md_default/deprecated.md b/docs/examples/examples_md_default/deprecated.md index 8d402ac3..e487cc8e 100644 --- a/docs/examples/examples_md_default/deprecated.md +++ b/docs/examples/examples_md_default/deprecated.md @@ -6,63 +6,63 @@ - [4. ~~ Property `root > deprecated4`~~](#deprecated4) - [5. Property `root > not_deprecated`](#not_deprecated) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Test schema with deprecated in description -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------ | ------- | ------ | ------------ | ---------- | ----------------------------------------------------- | -| - [deprecated1](#deprecated1 ) | No | object | [Deprecated] | - | [Deprecated] | -| - [deprecated2](#deprecated2 ) | No | object | [Deprecated] | - | [Deprecated - Use \`not_deprecated\` instead] | -| - [deprecated3](#deprecated3 ) | No | object | [Deprecated] | - | This is [Deprecated] | -| - [deprecated4](#deprecated4 ) | No | object | [Deprecated] | - | This is [Deprecated - Use \`not_deprecated\` instead] | -| - [not_deprecated](#not_deprecated ) | No | string | No | - | - | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------ | ------- | ------ | ---------- | ---------- | ----------------------------------------------------- | +| - [deprecated1](#deprecated1 ) | No | object | Deprecated | - | [Deprecated] | +| - [deprecated2](#deprecated2 ) | No | object | Deprecated | - | [Deprecated - Use \`not_deprecated\` instead] | +| - [deprecated3](#deprecated3 ) | No | object | Deprecated | - | This is [Deprecated] | +| - [deprecated4](#deprecated4 ) | No | object | Deprecated | - | This is [Deprecated - Use \`not_deprecated\` instead] | +| - [not_deprecated](#not_deprecated ) | No | string | No | - | - | ## 1. ~~ Property `root > deprecated1`~~ -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Deprecated** | [Deprecated] | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Deprecated** | +| **Additional properties** | Any type allowed | **Description:** [Deprecated] ## 2. ~~ Property `root > deprecated2`~~ -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Deprecated** | [Deprecated] | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Deprecated** | +| **Additional properties** | Any type allowed | **Description:** [Deprecated - Use `not_deprecated` instead] ## 3. ~~ Property `root > deprecated3`~~ -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Deprecated** | [Deprecated] | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Deprecated** | +| **Additional properties** | Any type allowed | **Description:** This is [Deprecated] ## 4. ~~ Property `root > deprecated4`~~ -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Deprecated** | [Deprecated] | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Deprecated** | +| **Additional properties** | Any type allowed | **Description:** This is [Deprecated - Use `not_deprecated` instead] diff --git a/docs/examples/examples_md_default/description_from_ref.md b/docs/examples/examples_md_default/description_from_ref.md index bc14027c..d2eed437 100644 --- a/docs/examples/examples_md_default/description_from_ref.md +++ b/docs/examples/examples_md_default/description_from_ref.md @@ -3,11 +3,11 @@ - [1. Property `root > name`](#name) - [2. Property `root > alignment`](#alignment) -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------- | ------- | ------ | ---------- | ------------------------------ | ----------------- | diff --git a/docs/examples/examples_md_default/description_markdown.md b/docs/examples/examples_md_default/description_markdown.md index bd473a1b..15c1172b 100644 --- a/docs/examples/examples_md_default/description_markdown.md +++ b/docs/examples/examples_md_default/description_markdown.md @@ -2,11 +2,11 @@ **Title:** Delivery Schema -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** DOC * List 1 diff --git a/docs/examples/examples_md_default/description_with_ref.md b/docs/examples/examples_md_default/description_with_ref.md index c04ccdc3..4c7931a4 100644 --- a/docs/examples/examples_md_default/description_with_ref.md +++ b/docs/examples/examples_md_default/description_with_ref.md @@ -4,11 +4,11 @@ - [1.1. Property `root > outer > inner`](#outer_inner) - [2. Property `root > outer2`](#outer2) -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------- | ------- | ------ | ---------- | ----------------------------- | ---------------------- | @@ -17,12 +17,12 @@ ## 1. Property `root > outer` -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | Yes | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/inner schema | +| | | +| ------------------------- | -------------------------- | +| **Type** | `object` | +| **Required** | Yes | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/inner schema | **Description:** We should see this @@ -41,12 +41,12 @@ ## 2. Property `root > outer2` -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Same definition as** | [outer](#outer) | +| | | +| ------------------------- | --------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Same definition as** | [outer](#outer) | **Description:** We should see this too diff --git a/docs/examples/examples_md_default/empty_property_name.md b/docs/examples/examples_md_default/empty_property_name.md index 3a21c6f5..6961b84e 100644 --- a/docs/examples/examples_md_default/empty_property_name.md +++ b/docs/examples/examples_md_default/empty_property_name.md @@ -4,11 +4,11 @@ **Title:** Empty property name -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------ | ------- | ------ | ---------- | ---------- | --------------------------------------------------- | diff --git a/docs/examples/examples_md_default/enumofnone.md b/docs/examples/examples_md_default/enumofnone.md index 11a57cc3..5f14eb4a 100644 --- a/docs/examples/examples_md_default/enumofnone.md +++ b/docs/examples/examples_md_default/enumofnone.md @@ -4,11 +4,11 @@ **Title:** Enum of None -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------- | ------- | -------------- | ---------- | ---------- | ----------------- | diff --git a/docs/examples/examples_md_default/geo.md b/docs/examples/examples_md_default/geo.md index c53eb36a..cba496a0 100644 --- a/docs/examples/examples_md_default/geo.md +++ b/docs/examples/examples_md_default/geo.md @@ -5,11 +5,11 @@ **Title:** Longitude and Latitude Values -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** A geographical coordinate. diff --git a/docs/examples/examples_md_default/html_in_description.md b/docs/examples/examples_md_default/html_in_description.md index 3c9a9cfc..dee394b1 100644 --- a/docs/examples/examples_md_default/html_in_description.md +++ b/docs/examples/examples_md_default/html_in_description.md @@ -6,11 +6,11 @@ **Title:** HTML in descriptions -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------- | diff --git a/docs/examples/examples_md_default/long_description.md b/docs/examples/examples_md_default/long_description.md index 4e472eb7..4d7f7f22 100644 --- a/docs/examples/examples_md_default/long_description.md +++ b/docs/examples/examples_md_default/long_description.md @@ -4,11 +4,11 @@ **Title:** Long description -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------ | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/examples/examples_md_default/multiple_types.md b/docs/examples/examples_md_default/multiple_types.md index 84bda9cb..90927a8b 100644 --- a/docs/examples/examples_md_default/multiple_types.md +++ b/docs/examples/examples_md_default/multiple_types.md @@ -7,11 +7,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------- | ------- | ------------------------------- | ---------- | ---------- | --------------------------------------------------------- | diff --git a/docs/examples/examples_md_default/pattern_properties.md b/docs/examples/examples_md_default/pattern_properties.md index 4f3786b6..44ed5597 100644 --- a/docs/examples/examples_md_default/pattern_properties.md +++ b/docs/examples/examples_md_default/pattern_properties.md @@ -8,11 +8,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -49,11 +49,11 @@ must respect the following conditions **Title:** paperSize -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Review of a paper size. diff --git a/docs/examples/examples_md_default/pattern_properties_html_id.md b/docs/examples/examples_md_default/pattern_properties_html_id.md index 6b667f37..3e26b9f5 100644 --- a/docs/examples/examples_md_default/pattern_properties_html_id.md +++ b/docs/examples/examples_md_default/pattern_properties_html_id.md @@ -8,11 +8,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -23,11 +23,11 @@ ## 1. Property `Person > not_a_pattern` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -40,11 +40,11 @@ must respect the following conditions **Title:** Title 4 -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Description 4 @@ -55,11 +55,11 @@ must respect the following conditions **Title:** Title 1 -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Description 1 @@ -70,11 +70,11 @@ must respect the following conditions **Title:** Title 2 -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Description 2 @@ -85,11 +85,11 @@ must respect the following conditions **Title:** Title 3 -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Description 3 diff --git a/docs/examples/examples_md_default/prefixItems.md b/docs/examples/examples_md_default/prefixItems.md index 418ab3d1..3dd3b7d9 100644 --- a/docs/examples/examples_md_default/prefixItems.md +++ b/docs/examples/examples_md_default/prefixItems.md @@ -8,11 +8,11 @@ **Title:** Address -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------- | ------- | ----- | ---------- | ---------- | ----------------- | diff --git a/docs/examples/examples_md_default/recursive.md b/docs/examples/examples_md_default/recursive.md index 22ddf81d..97e9ae96 100644 --- a/docs/examples/examples_md_default/recursive.md +++ b/docs/examples/examples_md_default/recursive.md @@ -6,11 +6,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------- | ------- | ------ | ---------- | ----------------------- | ----------------- | @@ -18,12 +18,12 @@ ## 1. Property `Person > person` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/person | **Description:** A human being @@ -54,12 +54,12 @@ #### 1.1.1. Person > person > children > person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [person](#person) | +| | | +| ------------------------- | ----------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [person](#person) | **Description:** A human being diff --git a/docs/examples/examples_md_default/recursive_array.md b/docs/examples/examples_md_default/recursive_array.md index 650141bc..6afc6640 100644 --- a/docs/examples/examples_md_default/recursive_array.md +++ b/docs/examples/examples_md_default/recursive_array.md @@ -7,11 +7,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------- | ------- | ----- | ---------- | ---------- | ----------------- | @@ -40,12 +40,12 @@ ### 1.1. Person > person > person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/person | **Description:** A human being @@ -76,12 +76,12 @@ ##### 1.1.1.1. Person > person > person items > children > person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [person_items](#person_items) | +| | | +| ------------------------- | ----------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [person_items](#person_items) | **Description:** A human being diff --git a/docs/examples/examples_md_default/recursive_full_schema.md b/docs/examples/examples_md_default/recursive_full_schema.md index 0d98cb87..789a2b86 100644 --- a/docs/examples/examples_md_default/recursive_full_schema.md +++ b/docs/examples/examples_md_default/recursive_full_schema.md @@ -10,11 +10,11 @@ **Title:** Bug -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Display the issue. @@ -58,12 +58,12 @@ **Title:** Bug -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [Bug](#root) | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Bug](#root) | **Description:** Display the issue. @@ -90,11 +90,11 @@ ### 3.1. Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------ | ------- | ------ | ---------- | --------------------- | ----------------- | @@ -112,12 +112,12 @@ **Title:** Bug -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [Bug](#root) | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Bug](#root) | **Description:** Display the issue. diff --git a/docs/examples/examples_md_default/recursive_full_schema_simple.md b/docs/examples/examples_md_default/recursive_full_schema_simple.md index 8a17d655..0b3b1536 100644 --- a/docs/examples/examples_md_default/recursive_full_schema_simple.md +++ b/docs/examples/examples_md_default/recursive_full_schema_simple.md @@ -4,11 +4,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------- | ------- | ------ | ---------- | ------------------------ | ----------------- | @@ -18,12 +18,12 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [Person](#root) | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Person](#root) | ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) diff --git a/docs/examples/examples_md_default/recursive_parent_in_definition.md b/docs/examples/examples_md_default/recursive_parent_in_definition.md index a567ecd0..f4f9ee14 100644 --- a/docs/examples/examples_md_default/recursive_parent_in_definition.md +++ b/docs/examples/examples_md_default/recursive_parent_in_definition.md @@ -7,11 +7,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------- | ------- | ------ | ---------- | ------------------------------------------------ | -------------------------------------------- | @@ -19,12 +19,12 @@ ## 1. Property `Person > relationships` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person/properties/relationships | +| | | +| ------------------------- | --------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/person/properties/relationships | **Description:** Relationships between this person and others @@ -34,12 +34,12 @@ ### 1.1. Property `Person > relationships > mother` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/person | **Description:** A human being @@ -49,11 +49,11 @@ #### 1.1.1. Property `Person > relationships > mother > relationships` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Relationships between this person and others @@ -63,12 +63,12 @@ ##### 1.1.1.1. Property `Person > relationships > mother > relationships > mother` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [mother](#relationships_mother) | +| | | +| ------------------------- | ------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [mother](#relationships_mother) | **Description:** A human being diff --git a/docs/examples/examples_md_default/recursive_two_files.md b/docs/examples/examples_md_default/recursive_two_files.md index 39808533..1545a22d 100644 --- a/docs/examples/examples_md_default/recursive_two_files.md +++ b/docs/examples/examples_md_default/recursive_two_files.md @@ -7,11 +7,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------- | ------- | ------ | ---------- | ----------------------- | ----------------- | @@ -19,12 +19,12 @@ ## 1. Property `Person > person` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/person | **Description:** A human being @@ -56,23 +56,23 @@ #### 1.1.1. Person > person > children > person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | recursive_two_files2.json#/definitions/person | +| | | +| ------------------------- | --------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | recursive_two_files2.json#/definitions/person | **Description:** Person definition from second file. Not the same! ### 1.2. Property `Person > person > siblings` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [person_children_items](#person_children_items) | +| | | +| ------------------------- | ----------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [person_children_items](#person_children_items) | **Description:** Person definition from second file. Not the same! diff --git a/docs/examples/examples_md_default/recursive_two_files2.md b/docs/examples/examples_md_default/recursive_two_files2.md index d0cd27e8..bd625f25 100644 --- a/docs/examples/examples_md_default/recursive_two_files2.md +++ b/docs/examples/examples_md_default/recursive_two_files2.md @@ -2,11 +2,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) diff --git a/docs/examples/examples_md_default/ref_merge.md b/docs/examples/examples_md_default/ref_merge.md index b0dbc301..32a2e277 100644 --- a/docs/examples/examples_md_default/ref_merge.md +++ b/docs/examples/examples_md_default/ref_merge.md @@ -7,11 +7,11 @@ **Title:** Test -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------------ | --------------------- | @@ -37,13 +37,13 @@ Must be one of: ## 2. Property `Test > aDictPropertyARequired` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Default** | `{"a": "a", "b": "b"}` | -| **Defined in** | #/definitions/aDictProperty | +| | | +| ------------------------- | --------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Default** | `{"a": "a", "b": "b"}` | +| **Defined in** | #/definitions/aDictProperty | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | --------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | diff --git a/docs/examples/examples_md_default/ref_with_other_elements.md b/docs/examples/examples_md_default/ref_with_other_elements.md index 75bd0e11..b7eea4aa 100644 --- a/docs/examples/examples_md_default/ref_with_other_elements.md +++ b/docs/examples/examples_md_default/ref_with_other_elements.md @@ -6,11 +6,11 @@ **Title:** OF -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------- | ------- | ------ | ---------- | ------------------- | ----------------- | diff --git a/docs/examples/examples_md_default/ref_with_tabs.md b/docs/examples/examples_md_default/ref_with_tabs.md index 8c47ccf5..02c71cf1 100644 --- a/docs/examples/examples_md_default/ref_with_tabs.md +++ b/docs/examples/examples_md_default/ref_with_tabs.md @@ -127,11 +127,11 @@ - [2.1.3.5.1. root > objectA > signature > oneOf > item 0 > signers > Signature > excludes > excludes items](#objectA_signature_oneOf_i0_signers_items_excludes_items) - [2.1.3.6. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > value`](#objectA_signature_oneOf_i0_signers_items_value) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -140,11 +140,11 @@ ## 1. Property `root > objectA` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------- | ------- | ------ | ---------- | -------------------------- | ----------------- | @@ -154,12 +154,12 @@ **Title:** Signature -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/signature | +| | | +| ------------------------- | ----------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/signature | | One of(Option) | | ---------------------------------------- | @@ -169,11 +169,11 @@ #### 1.1.1. Property `root > objectA > signature > oneOf > item 0` -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- | @@ -206,12 +206,12 @@ **Title:** Signature -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/signer | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/signer | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------- | @@ -224,11 +224,11 @@ ###### 1.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | Yes | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | Yes | +| **Additional properties** | Any type allowed | | One of(Option) | | ------------------------------------------------------------------------- | @@ -289,12 +289,12 @@ Must be one of: **Title:** Public key -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/publicKey | +| | | +| ------------------------- | ----------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/publicKey | **Description:** Optional. Public key object. @@ -311,19 +311,19 @@ Must be one of: ###### 1.1.1.1.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 1.1.1.1.1.3.1.1. If (kty = "EC") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -384,19 +384,19 @@ Must be one of: ###### 1.1.1.1.1.3.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 1.1.1.1.1.3.2.1. If (kty = "OKP") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -444,19 +444,19 @@ Must be one of: ###### 1.1.1.1.1.3.3. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 1.1.1.1.1.3.3.1. If (kty = "RSA") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -588,11 +588,11 @@ Must be one of: #### 1.1.2. Property `root > objectA > signature > oneOf > item 1` -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | --------------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- | @@ -625,23 +625,23 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Same definition as** | [Signature](#objectA_signature_oneOf_i0_signers_items) | +| | | +| ------------------------- | ------------------------------------------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Same definition as** | [Signature](#objectA_signature_oneOf_i0_signers_items) | #### 1.1.3. Property `root > objectA > signature > oneOf > Signature` **Title:** Signature -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/signer | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/signer | **Description:** Unique top level property for simple signatures. (signaturecore) @@ -656,11 +656,11 @@ Must be one of: ##### 1.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | Yes | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | Yes | +| **Additional properties** | Any type allowed | | One of(Option) | | ------------------------------------------------------------------------- | @@ -721,12 +721,12 @@ Must be one of: **Title:** Public key -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/publicKey | +| | | +| ------------------------- | ----------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/publicKey | **Description:** Optional. Public key object. @@ -743,19 +743,19 @@ Must be one of: ###### 1.1.3.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 1.1.3.3.1.1. If (kty = "EC") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -816,19 +816,19 @@ Must be one of: ###### 1.1.3.3.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 1.1.3.3.2.1. If (kty = "OKP") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -876,19 +876,19 @@ Must be one of: ###### 1.1.3.3.3. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 1.1.3.3.3.1. If (kty = "RSA") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -1020,11 +1020,11 @@ Must be one of: ## 2. Property `root > objectB` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------- | ------- | ------ | ---------- | -------------------------- | ----------------- | @@ -1034,12 +1034,12 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/signature | +| | | +| ------------------------- | ----------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/signature | | One of(Option) | | ---------------------------------------- | @@ -1049,11 +1049,11 @@ Must be one of: #### 2.1.1. Property `root > objectA > signature > oneOf > item 0` -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- | @@ -1086,12 +1086,12 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/signer | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/signer | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------- | @@ -1104,11 +1104,11 @@ Must be one of: ###### 2.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | Yes | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | Yes | +| **Additional properties** | Any type allowed | | One of(Option) | | ------------------------------------------------------------------------- | @@ -1169,12 +1169,12 @@ Must be one of: **Title:** Public key -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/publicKey | +| | | +| ------------------------- | ----------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/publicKey | **Description:** Optional. Public key object. @@ -1191,19 +1191,19 @@ Must be one of: ###### 2.1.1.1.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 2.1.1.1.1.3.1.1. If (kty = "EC") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -1264,19 +1264,19 @@ Must be one of: ###### 2.1.1.1.1.3.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 2.1.1.1.1.3.2.1. If (kty = "OKP") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -1324,19 +1324,19 @@ Must be one of: ###### 2.1.1.1.1.3.3. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 2.1.1.1.1.3.3.1. If (kty = "RSA") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -1468,11 +1468,11 @@ Must be one of: #### 2.1.2. Property `root > objectA > signature > oneOf > item 1` -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | --------------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- | @@ -1505,23 +1505,23 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Same definition as** | [Signature](#objectA_signature_oneOf_i0_signers_items) | +| | | +| ------------------------- | ------------------------------------------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Same definition as** | [Signature](#objectA_signature_oneOf_i0_signers_items) | #### 2.1.3. Property `root > objectA > signature > oneOf > Signature` **Title:** Signature -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/signer | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/signer | **Description:** Unique top level property for simple signatures. (signaturecore) @@ -1536,11 +1536,11 @@ Must be one of: ##### 2.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | Yes | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | Yes | +| **Additional properties** | Any type allowed | | One of(Option) | | ------------------------------------------------------------------------- | @@ -1601,12 +1601,12 @@ Must be one of: **Title:** Public key -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/publicKey | +| | | +| ------------------------- | ----------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/publicKey | **Description:** Optional. Public key object. @@ -1623,19 +1623,19 @@ Must be one of: ###### 2.1.3.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 2.1.3.3.1.1. If (kty = "EC") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -1696,19 +1696,19 @@ Must be one of: ###### 2.1.3.3.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 2.1.3.3.2.1. If (kty = "OKP") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -1756,19 +1756,19 @@ Must be one of: ###### 2.1.3.3.3. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 2.1.3.3.3.1. If (kty = "RSA") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | diff --git a/docs/examples/examples_md_default/reference_int.md b/docs/examples/examples_md_default/reference_int.md index 01f080c5..cdbfe10b 100644 --- a/docs/examples/examples_md_default/reference_int.md +++ b/docs/examples/examples_md_default/reference_int.md @@ -5,11 +5,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------------------------- | ------- | ------ | ---------- | -------------------------------------- | ---------------------------------------------------------------- | @@ -18,23 +18,23 @@ ## 1. Property `Person > extra_options_object` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/extra_options/anyOf/0 | +| | | +| ------------------------- | ----------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/extra_options/anyOf/0 | **Description:** This is the one ## 2. Property `Person > name_looks_like_an_int` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/10 | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/10 | **Description:** This is just to be annoying. The property name looks like an int diff --git a/docs/examples/examples_md_default/references.md b/docs/examples/examples_md_default/references.md index 707696ff..17f69d0a 100644 --- a/docs/examples/examples_md_default/references.md +++ b/docs/examples/examples_md_default/references.md @@ -20,11 +20,11 @@ - [13. Property `root > multi_hierarchy_reference`](#multi_hierarchy_reference) - [13.1. Property `root > multi_hierarchy_reference > propertyA`](#multi_hierarchy_reference_propertyA) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Testing $ref @@ -66,12 +66,12 @@ ## 3. Property `root > anchor_with_slash` -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/object_def | +| | | +| ------------------------- | ------------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/object_def | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | @@ -135,12 +135,12 @@ ## 7. Property `root > same_file_anchor_no_slash` -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Same definition as** | [anchor_with_slash](#anchor_with_slash) | +| | | +| ------------------------- | --------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Same definition as** | [anchor_with_slash](#anchor_with_slash) | ## 8. Property `root > same_file_nested_reference` @@ -152,12 +152,12 @@ ## 9. Property `root > other_file_anchor` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | with_descriptions.json#/definitions/gift | +| | | +| ------------------------- | ---------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | with_descriptions.json#/definitions/gift | **Description:** The delivery is a gift, no prices displayed @@ -174,34 +174,34 @@ ## 10. Property `root > other_file_dot_anchor` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [other_file_anchor](#other_file_anchor) | +| | | +| ------------------------- | --------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [other_file_anchor](#other_file_anchor) | **Description:** The delivery is a gift, no prices displayed ## 11. Property `root > other_file_dot_dot_anchor` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [other_file_anchor](#other_file_anchor) | +| | | +| ------------------------- | --------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [other_file_anchor](#other_file_anchor) | **Description:** The delivery is a gift, no prices displayed ## 12. Property `root > other_file_only` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | combining_not.json | +| | | +| ------------------------- | ------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | combining_not.json | **Description:** Test schema with a not @@ -211,11 +211,11 @@ ### 12.1. Property `root > other_file_only > not_a_string` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | Yes | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | Yes | +| **Additional properties** | Any type allowed | #### 12.1.1. Must **not** be @@ -226,12 +226,12 @@ ## 13. Property `root > multi_hierarchy_reference` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | reference_schemas/intermediate.json#/properties/cross_file_reference | +| | | +| ------------------------- | -------------------------------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | reference_schemas/intermediate.json#/properties/cross_file_reference | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------- | diff --git a/docs/examples/examples_md_default/references_url.md b/docs/examples/examples_md_default/references_url.md index defd8b12..7730bf99 100644 --- a/docs/examples/examples_md_default/references_url.md +++ b/docs/examples/examples_md_default/references_url.md @@ -2,11 +2,11 @@ - [1. Property `root > firstName`](#firstName) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Testing $ref with URL diff --git a/docs/examples/examples_md_default/references_url_two_levels.md b/docs/examples/examples_md_default/references_url_two_levels.md index 36250922..9e89ace0 100644 --- a/docs/examples/examples_md_default/references_url_two_levels.md +++ b/docs/examples/examples_md_default/references_url_two_levels.md @@ -4,11 +4,11 @@ - [1.1. Property `root > described > name`](#described_name) - [1.2. Property `root > described > alignment`](#described_alignment) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Testing $ref of a remote $ref @@ -22,7 +22,7 @@ | ------------------------- | -------------------------------------------------------------------------------------------------------------------- | | **Type** | `object` | | **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| **Additional properties** | Not allowed | | **Defined in** | https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/description_from_ref.json | | Property | Pattern | Type | Deprecated | Definition | Title/Description | diff --git a/docs/examples/examples_md_default/references_url_yaml.md b/docs/examples/examples_md_default/references_url_yaml.md index f3025802..0edfd1ea 100644 --- a/docs/examples/examples_md_default/references_url_yaml.md +++ b/docs/examples/examples_md_default/references_url_yaml.md @@ -5,11 +5,11 @@ - [1.2. Property `root > address > city`](#address_city) - [1.3. Property `root > address > state`](#address_state) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Testing $ref with URL with YAML destination @@ -23,7 +23,7 @@ | ------------------------- | ------------------------------------------------------------------------------------------------------------------------- | | **Type** | `object` | | **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Additional properties** | Any type allowed | | **Defined in** | https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/yaml.yaml#/definitions/address | | Property | Pattern | Type | Deprecated | Definition | Title/Description | diff --git a/docs/examples/examples_md_default/required_properties_order.md b/docs/examples/examples_md_default/required_properties_order.md index 5945d833..cee89caa 100644 --- a/docs/examples/examples_md_default/required_properties_order.md +++ b/docs/examples/examples_md_default/required_properties_order.md @@ -7,11 +7,11 @@ **Title:** Undocumented Required Properties order -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -20,11 +20,11 @@ ## 1. Property `Undocumented Required Properties order > group1` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ### 1.1. The following properties are required * a @@ -32,11 +32,11 @@ ## 2. Property `Undocumented Required Properties order > group2` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ### 2.1. The following properties are required * b diff --git a/docs/examples/examples_md_default/single_element_allOf.md b/docs/examples/examples_md_default/single_element_allOf.md index cba60d4b..bc4ecf0f 100644 --- a/docs/examples/examples_md_default/single_element_allOf.md +++ b/docs/examples/examples_md_default/single_element_allOf.md @@ -5,11 +5,11 @@ **Title:** Schema containing a single-element allOf -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Schema containing a single-element allOf diff --git a/docs/examples/examples_md_default/top_level_combining.md b/docs/examples/examples_md_default/top_level_combining.md index 91aa369d..f9bd080c 100644 --- a/docs/examples/examples_md_default/top_level_combining.md +++ b/docs/examples/examples_md_default/top_level_combining.md @@ -7,11 +7,11 @@ **Title:** Combining at top level -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** For the combine @@ -24,39 +24,39 @@ ## 1. Property `Combining at top level > oneOf > diskDevice` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskDevice | +| | | +| ------------------------- | ------------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/diskDevice | ## 2. Property `Combining at top level > oneOf > diskUUID` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskUUID | +| | | +| ------------------------- | ---------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/diskUUID | ## 3. Property `Combining at top level > oneOf > nfs` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/nfs | +| | | +| ------------------------- | ----------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/nfs | ## 4. Property `Combining at top level > oneOf > tmpfs` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/tmpfs | +| | | +| ------------------------- | ------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/tmpfs | ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) diff --git a/docs/examples/examples_md_default/type_object_null.md b/docs/examples/examples_md_default/type_object_null.md index b4ed9c95..c155cae0 100644 --- a/docs/examples/examples_md_default/type_object_null.md +++ b/docs/examples/examples_md_default/type_object_null.md @@ -5,11 +5,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------ | ------- | -------------- | ---------- | ---------- | ----------------- | diff --git a/docs/examples/examples_md_default/with_default.md b/docs/examples/examples_md_default/with_default.md index 1ac0dac8..3714a298 100644 --- a/docs/examples/examples_md_default/with_default.md +++ b/docs/examples/examples_md_default/with_default.md @@ -7,11 +7,11 @@ **Title:** User Preference -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------ | ------- | ------------------------- | ---------- | ---------- | ----------------- | diff --git a/docs/examples/examples_md_default/with_definitions.md b/docs/examples/examples_md_default/with_definitions.md index 1cef54d1..16acca35 100644 --- a/docs/examples/examples_md_default/with_definitions.md +++ b/docs/examples/examples_md_default/with_definitions.md @@ -7,11 +7,11 @@ - [1.4. Property `root > billing_address > futureProperty`](#billing_address_futureProperty) - [2. Property `root > shipping_address`](#shipping_address) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------------- | ------- | ------ | ---------- | -------------------------------------------- | ----------------- | @@ -20,12 +20,12 @@ ## 1. Property `root > billing_address` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/address | +| | | +| ------------------------- | --------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/address | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -64,12 +64,12 @@ ## 2. Property `root > shipping_address` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [billing_address](#billing_address) | +| | | +| ------------------------- | ----------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [billing_address](#billing_address) | ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) diff --git a/docs/examples/examples_md_default/with_descriptions.md b/docs/examples/examples_md_default/with_descriptions.md index eda069a4..31b8c6c2 100644 --- a/docs/examples/examples_md_default/with_descriptions.md +++ b/docs/examples/examples_md_default/with_descriptions.md @@ -13,11 +13,11 @@ **Title:** Delivery Schema -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------------- | ------- | ------ | ---------- | ---------------------------------------------- | -------------------------------------------- | @@ -27,12 +27,12 @@ ## 1. Property `Delivery Schema > shipping_address` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/address | +| | | +| ------------------------- | --------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/address | **Description:** Exact address @@ -65,23 +65,23 @@ ## 2. Property `Delivery Schema > billing_address` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [shipping_address](#shipping_address) | +| | | +| ------------------------- | ------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [shipping_address](#shipping_address) | **Description:** Exact address ## 3. Property `Delivery Schema > delivery_info` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/delivery_info | +| | | +| ------------------------- | --------------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/delivery_info | **Description:** Delivery info depending on the delivery type @@ -92,12 +92,12 @@ ### 3.1. Property `Delivery Schema > delivery_info > oneOf > classic` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/classic | +| | | +| ------------------------- | --------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/classic | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ----------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -112,12 +112,12 @@ ### 3.2. Property `Delivery Schema > delivery_info > oneOf > gift` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/gift | +| | | +| ------------------------- | ------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/gift | **Description:** The delivery is a gift, no prices displayed diff --git a/docs/examples/examples_md_default/with_examples.md b/docs/examples/examples_md_default/with_examples.md index b158a869..d37f9b88 100644 --- a/docs/examples/examples_md_default/with_examples.md +++ b/docs/examples/examples_md_default/with_examples.md @@ -7,11 +7,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------- | ------- | ------- | ---------- | ---------- | ----------------------------------- | @@ -81,11 +81,11 @@ ## 4. Property `Person > moreInfo` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Any more info you want as an object diff --git a/docs/examples/examples_md_default/with_keywords.md b/docs/examples/examples_md_default/with_keywords.md index 2a063062..8f107e05 100644 --- a/docs/examples/examples_md_default/with_keywords.md +++ b/docs/examples/examples_md_default/with_keywords.md @@ -14,11 +14,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------ | ------- | ------ | ---------- | ---------- | ----------------- | @@ -54,91 +54,91 @@ ## 3. Property `Person > if` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** if ## 4. Property `Person > then` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** then ## 5. Property `Person > else` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** else ## 6. Property `Person > anyOf` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** anyOf ## 7. Property `Person > allOf` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** allOf ## 8. Property `Person > not` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** not ## 9. Property `Person > properties` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** properties ## 10. Property `Person > patternProperties` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** patternProperties ## 11. Property `Person > required` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** required diff --git a/docs/examples/examples_md_default/with_special_chars.md b/docs/examples/examples_md_default/with_special_chars.md index 781df3b7..decf6216 100644 --- a/docs/examples/examples_md_default/with_special_chars.md +++ b/docs/examples/examples_md_default/with_special_chars.md @@ -9,11 +9,11 @@ **Title:** Personne -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ----------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------------------------------------------- | diff --git a/docs/examples/examples_md_default/with_urlencoded_anchor.md b/docs/examples/examples_md_default/with_urlencoded_anchor.md index 910dd83d..42d77ec5 100644 --- a/docs/examples/examples_md_default/with_urlencoded_anchor.md +++ b/docs/examples/examples_md_default/with_urlencoded_anchor.md @@ -6,11 +6,11 @@ - [1.2.1. Property `root > signingTimeInfo > signingTimeBounds > lowerBound`](#signingTimeInfo_signingTimeBounds_lowerBound) - [1.2.2. Property `root > signingTimeInfo > signingTimeBounds > upperBound`](#signingTimeInfo_signingTimeBounds_upperBound) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------------------- | ------- | ------ | ---------- | ----------------------------------------- | ----------------- | @@ -18,12 +18,12 @@ ## 1. Property `root > signingTimeInfo` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/dss2-SigningTimeInfoType | +| | | +| ------------------------- | -------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/dss2-SigningTimeInfoType | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------------------------------- | ------- | ------- | ---------- | ----------------------------------------------------------------- | ----------------- | @@ -40,12 +40,12 @@ ### 1.2. Property `root > signingTimeInfo > signingTimeBounds` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/dss2-SigningTimeInfoType%3ASigningTimeBoundaries | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/dss2-SigningTimeInfoType%3ASigningTimeBoundaries | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------- | diff --git a/docs/examples/examples_md_nested_default/Configuration.md b/docs/examples/examples_md_nested_default/Configuration.md index 872b569b..fefe748c 100644 --- a/docs/examples/examples_md_nested_default/Configuration.md +++ b/docs/examples/examples_md_nested_default/Configuration.md @@ -32,11 +32,11 @@ **Title:** JSON Schema for Humans configuration file -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Choose how to generate JSON Schema for Humans documentation file. @@ -409,7 +409,7 @@ This is the old behaviour and is only needed for browsers that do not support HT | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | **Type** | `object` | | **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Additional properties** | Any type allowed | | **Default** | `{"fenced-code-blocks": {"cssclass": "highlight jumbotron"}, "tables": null, "breaks": {"on_newline": true, "on_backslash": true}}` | **Description:** (Only used with `description_is_markdown`) @@ -438,11 +438,11 @@ This is the old behaviour and is only needed for browsers that do not support HT
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** specific options to md template @@ -598,12 +598,12 @@ Must be one of:
-| | | -| -------------- | ------------ | -| **Type** | `boolean` | -| **Required** | No | -| **Deprecated** | [Deprecated] | -| **Default** | `false` | +| | | +| -------------- | --------- | +| **Type** | `boolean` | +| **Required** | No | +| **Deprecated** | +| **Default** | `false` | **Description:** [Deprecated] @@ -617,12 +617,12 @@ Must be one of:
-| | | -| -------------- | ------------ | -| **Type** | `boolean` | -| **Required** | No | -| **Deprecated** | [Deprecated] | -| **Default** | `true` | +| | | +| -------------- | --------- | +| **Type** | `boolean` | +| **Required** | No | +| **Deprecated** | +| **Default** | `true` | **Description:** [Deprecated] @@ -636,11 +636,11 @@ Must be one of:
-| | | -| -------------- | ------------ | -| **Type** | `string` | -| **Required** | No | -| **Deprecated** | [Deprecated] | +| | | +| -------------- | -------- | +| **Type** | `string` | +| **Required** | No | +| **Deprecated** | **Description:** [Deprecated] diff --git a/docs/examples/examples_md_nested_default/additional_properties.md b/docs/examples/examples_md_nested_default/additional_properties.md index e3a13628..8a6ec72c 100644 --- a/docs/examples/examples_md_nested_default/additional_properties.md +++ b/docs/examples/examples_md_nested_default/additional_properties.md @@ -10,11 +10,11 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Should-conform]](#additionalProperties "Each additional property must conform to the following schema") | +| | | +| ------------------------- | ---------------------------------------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | [Each additional property must conform to the schema](#additionalProperties) |
@@ -23,11 +23,11 @@
-| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | **Description:** A sub type with additionalProperties false. @@ -56,11 +56,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** A sub type with additionalProperties true. @@ -106,11 +106,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** additionalProperties schema. 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 53c3fbb7..97e83a8c 100644 --- a/docs/examples/examples_md_nested_default/anyOf_option_names.md +++ b/docs/examples/examples_md_nested_default/anyOf_option_names.md @@ -6,11 +6,11 @@ - [1.3. Property `root > storage > anyOf > item 2`](#storage_anyOf_i2) - [1.4. Property `root > storage > anyOf > tmpfs`](#storage_anyOf_i3) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** JSON Schema for an fstab entry @@ -21,11 +21,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | Yes | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | Yes | +| **Additional properties** | Any type allowed |
@@ -40,47 +40,47 @@ ### 1.1. Property `root > storage > anyOf > diskDevice` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskDevice | +| | | +| ------------------------- | ------------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/diskDevice |
### 1.2. Property `root > storage > anyOf > diskUUID` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskUUID | +| | | +| ------------------------- | ---------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/diskUUID |
### 1.3. Property `root > storage > anyOf > item 2` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
### 1.4. Property `root > storage > anyOf > tmpfs` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/tmpfs | +| | | +| ------------------------- | ------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/tmpfs |
diff --git a/docs/examples/examples_md_nested_default/array.md b/docs/examples/examples_md_nested_default/array.md index 597f8695..9bf145ab 100644 --- a/docs/examples/examples_md_nested_default/array.md +++ b/docs/examples/examples_md_nested_default/array.md @@ -7,11 +7,11 @@ - [2.1.1. [Required] Property root > vegetables > vegetables items > veggieName](#vegetables_items_veggieName) - [2.1.2. [Required] Property root > vegetables > vegetables items > veggieLike](#vegetables_items_veggieLike) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** A schema with an array @@ -75,12 +75,12 @@ ### 2.1. root > vegetables > veggie -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/veggie | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/veggie |
diff --git a/docs/examples/examples_md_nested_default/array_additionalItems.md b/docs/examples/examples_md_nested_default/array_additionalItems.md index 1ffe2893..273f3e5f 100644 --- a/docs/examples/examples_md_nested_default/array_additionalItems.md +++ b/docs/examples/examples_md_nested_default/array_additionalItems.md @@ -9,11 +9,11 @@ - [2.1. root > addressLines > addressLines item 0](#autogenerated_heading_6) - [3. [Optional] Property root > arrayEmpty](#arrayEmpty) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** A little food fun diff --git a/docs/examples/examples_md_nested_default/array_advanced.md b/docs/examples/examples_md_nested_default/array_advanced.md index a04ccff9..b00b7443 100644 --- a/docs/examples/examples_md_nested_default/array_advanced.md +++ b/docs/examples/examples_md_nested_default/array_advanced.md @@ -6,11 +6,11 @@ - [2.1. root > vegetables > vegetables items](#autogenerated_heading_3) - [2.2. At least one of the items must be](#autogenerated_heading_4) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** A little food fun @@ -76,11 +76,11 @@ ### 2.1. root > vegetables > vegetables items -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ### 2.2. At least one of the items must be diff --git a/docs/examples/examples_md_nested_default/array_example.md b/docs/examples/examples_md_nested_default/array_example.md index 239b165f..8bb54ac1 100644 --- a/docs/examples/examples_md_nested_default/array_example.md +++ b/docs/examples/examples_md_nested_default/array_example.md @@ -3,11 +3,11 @@ - [1. [Optional] Property root > fruits](#fruits) - [1.1. root > fruits > fruits items](#autogenerated_heading_2) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** A schema with an array diff --git a/docs/examples/examples_md_nested_default/basic.md b/docs/examples/examples_md_nested_default/basic.md index ca119a12..e74b0f0a 100644 --- a/docs/examples/examples_md_nested_default/basic.md +++ b/docs/examples/examples_md_nested_default/basic.md @@ -9,11 +9,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -83,11 +83,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed |
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 ca762fdc..dff5f6ea 100644 --- a/docs/examples/examples_md_nested_default/break_on_newline.md +++ b/docs/examples/examples_md_nested_default/break_on_newline.md @@ -4,11 +4,11 @@ **Title:** Hello -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
diff --git a/docs/examples/examples_md_nested_default/broken_ref.md b/docs/examples/examples_md_nested_default/broken_ref.md index fa0c7a42..f797798e 100644 --- a/docs/examples/examples_md_nested_default/broken_ref.md +++ b/docs/examples/examples_md_nested_default/broken_ref.md @@ -5,11 +5,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -37,12 +37,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | a_file_that_does_not_exist_and_will_never_i_hope.lol.json | +| | | +| ------------------------- | --------------------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | a_file_that_does_not_exist_and_will_never_i_hope.lol.json | **Description:** 😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️ diff --git a/docs/examples/examples_md_nested_default/circular.md b/docs/examples/examples_md_nested_default/circular.md index 8484421c..ea14cd9f 100644 --- a/docs/examples/examples_md_nested_default/circular.md +++ b/docs/examples/examples_md_nested_default/circular.md @@ -5,11 +5,11 @@ **Title:** Circular reference Schema -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -18,12 +18,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/a | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/a |
diff --git a/docs/examples/examples_md_nested_default/combining_not.md b/docs/examples/examples_md_nested_default/combining_not.md index f09d9a92..1e55c33b 100644 --- a/docs/examples/examples_md_nested_default/combining_not.md +++ b/docs/examples/examples_md_nested_default/combining_not.md @@ -3,11 +3,11 @@ - [1. [Required] Property root > not_a_string](#not_a_string) - [1.1. Must **not** be](#autogenerated_heading_2) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Test schema with a not @@ -18,11 +18,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | Yes | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | Yes | +| **Additional properties** | Any type allowed | ### 1.1. Must **not** be diff --git a/docs/examples/examples_md_nested_default/combining_oneOf.md b/docs/examples/examples_md_nested_default/combining_oneOf.md index 1ee3cb6b..717657c4 100644 --- a/docs/examples/examples_md_nested_default/combining_oneOf.md +++ b/docs/examples/examples_md_nested_default/combining_oneOf.md @@ -6,11 +6,11 @@ - [1.3. Property `root > storage > oneOf > nfs`](#storage_oneOf_i2) - [1.4. Property `root > storage > oneOf > tmpfs`](#storage_oneOf_i3) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** JSON Schema for an fstab entry @@ -21,11 +21,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | Yes | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | Yes | +| **Additional properties** | Any type allowed |
@@ -40,48 +40,48 @@ ### 1.1. Property `root > storage > oneOf > diskDevice` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskDevice | +| | | +| ------------------------- | ------------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/diskDevice |
### 1.2. Property `root > storage > oneOf > diskUUID` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskUUID | +| | | +| ------------------------- | ---------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/diskUUID |
### 1.3. Property `root > storage > oneOf > nfs` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/nfs | +| | | +| ------------------------- | ----------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/nfs |
### 1.4. Property `root > storage > oneOf > tmpfs` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/tmpfs | +| | | +| ------------------------- | ------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/tmpfs |
diff --git a/docs/examples/examples_md_nested_default/conditional_subschema.md b/docs/examples/examples_md_nested_default/conditional_subschema.md index c0ca0e85..ad8c86f9 100644 --- a/docs/examples/examples_md_nested_default/conditional_subschema.md +++ b/docs/examples/examples_md_nested_default/conditional_subschema.md @@ -7,19 +7,19 @@ - [3. [Optional] Property root > street_address](#street_address) - [4. [Optional] Property root > country](#country) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ## 1. If (country = "United States of America") -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -28,11 +28,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------------------- | @@ -43,11 +43,11 @@ ## 2. Else (i.e. country != "United States of America") -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -56,11 +56,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | 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 cd4715bf..0f0954e5 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 @@ -12,11 +12,11 @@ - [4. [Optional] Property root > street_address](#street_address) - [5. [Optional] Property root > country](#country) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -30,19 +30,19 @@ ## 1. Property `root > allOf > item 0` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ### 1.1. If (country = "United States of America") -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -51,11 +51,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------------------- | @@ -69,19 +69,19 @@ ## 2. Property `root > allOf > item 1` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ### 2.1. If (country = "Canada") -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -90,11 +90,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | @@ -108,19 +108,19 @@ ## 3. Property `root > allOf > item 2` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ### 3.1. If (country = "Netherlands") -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -129,11 +129,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------- | diff --git a/docs/examples/examples_md_nested_default/defaults.md b/docs/examples/examples_md_nested_default/defaults.md index 9b7808db..d30c3ae7 100644 --- a/docs/examples/examples_md_nested_default/defaults.md +++ b/docs/examples/examples_md_nested_default/defaults.md @@ -3,11 +3,11 @@ - [1. [Optional] Property root > a](#a) - [2. [Optional] Property root > b](#b) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -16,13 +16,13 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Default** | `"Default from a"` | -| **Defined in** | #/definitions/common | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Default** | `"Default from a"` | +| **Defined in** | #/definitions/common | **Description:** Description of a @@ -36,13 +36,13 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Default** | `"Default from b"` | -| **Defined in** | #/definitions/common | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Default** | `"Default from b"` | +| **Defined in** | #/definitions/common | **Description:** A common description diff --git a/docs/examples/examples_md_nested_default/deprecated.md b/docs/examples/examples_md_nested_default/deprecated.md index 44cc1b32..01b4cdd8 100644 --- a/docs/examples/examples_md_nested_default/deprecated.md +++ b/docs/examples/examples_md_nested_default/deprecated.md @@ -6,11 +6,11 @@ - [4. [Optional]~~ Property root > deprecated4~~](#deprecated4) - [5. [Optional] Property root > not_deprecated](#not_deprecated) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Test schema with deprecated in description @@ -21,12 +21,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Deprecated** | [Deprecated] | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Deprecated** | +| **Additional properties** | Any type allowed | **Description:** [Deprecated] @@ -40,12 +40,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Deprecated** | [Deprecated] | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Deprecated** | +| **Additional properties** | Any type allowed | **Description:** [Deprecated - Use `not_deprecated` instead] @@ -59,12 +59,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Deprecated** | [Deprecated] | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Deprecated** | +| **Additional properties** | Any type allowed | **Description:** This is [Deprecated] @@ -78,12 +78,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Deprecated** | [Deprecated] | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Deprecated** | +| **Additional properties** | Any type allowed | **Description:** This is [Deprecated - Use `not_deprecated` instead] 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 47478019..fbcf5a11 100644 --- a/docs/examples/examples_md_nested_default/description_from_ref.md +++ b/docs/examples/examples_md_nested_default/description_from_ref.md @@ -3,11 +3,11 @@ - [1. [Optional] Property root > name](#name) - [2. [Optional] Property root > alignment](#alignment) -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
diff --git a/docs/examples/examples_md_nested_default/description_markdown.md b/docs/examples/examples_md_nested_default/description_markdown.md index 242dede9..4cf9d48c 100644 --- a/docs/examples/examples_md_nested_default/description_markdown.md +++ b/docs/examples/examples_md_nested_default/description_markdown.md @@ -2,11 +2,11 @@ **Title:** Delivery Schema -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** DOC * List 1 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 05a19270..de9173d2 100644 --- a/docs/examples/examples_md_nested_default/description_with_ref.md +++ b/docs/examples/examples_md_nested_default/description_with_ref.md @@ -4,11 +4,11 @@ - [1.1. [Required] Property root > outer > inner](#outer_inner) - [2. [Optional] Property root > outer2](#outer2) -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
@@ -17,12 +17,12 @@
-| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | Yes | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/inner schema | +| | | +| ------------------------- | -------------------------- | +| **Type** | `object` | +| **Required** | Yes | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/inner schema | **Description:** We should see this @@ -53,12 +53,12 @@
-| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Same definition as** | [outer](#outer) | +| | | +| ------------------------- | --------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Same definition as** | [outer](#outer) | **Description:** We should see this too 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 4649fb97..e415604e 100644 --- a/docs/examples/examples_md_nested_default/empty_property_name.md +++ b/docs/examples/examples_md_nested_default/empty_property_name.md @@ -4,11 +4,11 @@ **Title:** Empty property name -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
diff --git a/docs/examples/examples_md_nested_default/enumofnone.md b/docs/examples/examples_md_nested_default/enumofnone.md index 9944763c..19db9d18 100644 --- a/docs/examples/examples_md_nested_default/enumofnone.md +++ b/docs/examples/examples_md_nested_default/enumofnone.md @@ -4,11 +4,11 @@ **Title:** Enum of None -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
diff --git a/docs/examples/examples_md_nested_default/geo.md b/docs/examples/examples_md_nested_default/geo.md index 2404fa06..809437a5 100644 --- a/docs/examples/examples_md_nested_default/geo.md +++ b/docs/examples/examples_md_nested_default/geo.md @@ -5,11 +5,11 @@ **Title:** Longitude and Latitude Values -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** A geographical coordinate. diff --git a/docs/examples/examples_md_nested_default/html_in_description.md b/docs/examples/examples_md_nested_default/html_in_description.md index ed09277a..e9a363f7 100644 --- a/docs/examples/examples_md_nested_default/html_in_description.md +++ b/docs/examples/examples_md_nested_default/html_in_description.md @@ -6,11 +6,11 @@ **Title:** HTML in descriptions -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
diff --git a/docs/examples/examples_md_nested_default/long_description.md b/docs/examples/examples_md_nested_default/long_description.md index 532315bf..631c951d 100644 --- a/docs/examples/examples_md_nested_default/long_description.md +++ b/docs/examples/examples_md_nested_default/long_description.md @@ -4,11 +4,11 @@ **Title:** Long description -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
diff --git a/docs/examples/examples_md_nested_default/multiple_types.md b/docs/examples/examples_md_nested_default/multiple_types.md index 7c9924bb..070c7c98 100644 --- a/docs/examples/examples_md_nested_default/multiple_types.md +++ b/docs/examples/examples_md_nested_default/multiple_types.md @@ -7,11 +7,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
diff --git a/docs/examples/examples_md_nested_default/pattern_properties.md b/docs/examples/examples_md_nested_default/pattern_properties.md index 70838a2c..3a3fdf85 100644 --- a/docs/examples/examples_md_nested_default/pattern_properties.md +++ b/docs/examples/examples_md_nested_default/pattern_properties.md @@ -8,11 +8,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -64,11 +64,11 @@ must respect the following conditions **Title:** paperSize -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Review of a paper size. 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 2244e9fb..d38a50c7 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 @@ -8,11 +8,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -21,11 +21,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -39,11 +39,11 @@ must respect the following conditions **Title:** Title 4 -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Description 4 @@ -65,11 +65,11 @@ must respect the following conditions **Title:** Title 1 -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Description 1 @@ -88,11 +88,11 @@ must respect the following conditions **Title:** Title 2 -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Description 2 @@ -111,11 +111,11 @@ must respect the following conditions **Title:** Title 3 -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Description 3 diff --git a/docs/examples/examples_md_nested_default/prefixItems.md b/docs/examples/examples_md_nested_default/prefixItems.md index b7911120..8f4d98b2 100644 --- a/docs/examples/examples_md_nested_default/prefixItems.md +++ b/docs/examples/examples_md_nested_default/prefixItems.md @@ -8,11 +8,11 @@ **Title:** Address -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
diff --git a/docs/examples/examples_md_nested_default/recursive.md b/docs/examples/examples_md_nested_default/recursive.md index 4d41f805..6abb8f91 100644 --- a/docs/examples/examples_md_nested_default/recursive.md +++ b/docs/examples/examples_md_nested_default/recursive.md @@ -6,11 +6,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -19,12 +19,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/person | **Description:** A human being @@ -56,12 +56,12 @@ #### 1.1.1. Person > person > children > person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [person](#person) | +| | | +| ------------------------- | ----------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [person](#person) | **Description:** A human being diff --git a/docs/examples/examples_md_nested_default/recursive_array.md b/docs/examples/examples_md_nested_default/recursive_array.md index 19dd1fd4..93172028 100644 --- a/docs/examples/examples_md_nested_default/recursive_array.md +++ b/docs/examples/examples_md_nested_default/recursive_array.md @@ -7,11 +7,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -41,12 +41,12 @@ ### 1.1. Person > person > person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/person | **Description:** A human being @@ -78,12 +78,12 @@ ##### 1.1.1.1. Person > person > person items > children > person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [person_items](#person_items) | +| | | +| ------------------------- | ----------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [person_items](#person_items) | **Description:** A human being 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 b077c801..5da2f1b6 100644 --- a/docs/examples/examples_md_nested_default/recursive_full_schema.md +++ b/docs/examples/examples_md_nested_default/recursive_full_schema.md @@ -10,11 +10,11 @@ **Title:** Bug -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Display the issue. @@ -65,12 +65,12 @@ **Title:** Bug -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [Bug](#root) | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Bug](#root) | **Description:** Display the issue. @@ -105,11 +105,11 @@ ### 3.1. Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -135,12 +135,12 @@ **Title:** Bug -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [Bug](#root) | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Bug](#root) | **Description:** Display the issue. 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 c71b395a..729dcf2d 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 @@ -4,11 +4,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -19,12 +19,12 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [Person](#root) | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [Person](#root) |
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 4f05e51f..51da08a4 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 @@ -7,11 +7,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -20,12 +20,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person/properties/relationships | +| | | +| ------------------------- | --------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/person/properties/relationships | **Description:** Relationships between this person and others @@ -36,12 +36,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/person | **Description:** A human being @@ -52,11 +52,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Relationships between this person and others @@ -67,12 +67,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [mother](#relationships_mother) | +| | | +| ------------------------- | ------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [mother](#relationships_mother) | **Description:** A human being 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 edbb3eed..c6101135 100644 --- a/docs/examples/examples_md_nested_default/recursive_two_files.md +++ b/docs/examples/examples_md_nested_default/recursive_two_files.md @@ -7,11 +7,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -20,12 +20,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/person | **Description:** A human being @@ -57,12 +57,12 @@ #### 1.1.1. Person > person > children > person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | recursive_two_files2.json#/definitions/person | +| | | +| ------------------------- | --------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | recursive_two_files2.json#/definitions/person | **Description:** Person definition from second file. Not the same! @@ -76,12 +76,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [person_children_items](#person_children_items) | +| | | +| ------------------------- | ----------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [person_children_items](#person_children_items) | **Description:** Person definition from second file. Not the same! diff --git a/docs/examples/examples_md_nested_default/recursive_two_files2.md b/docs/examples/examples_md_nested_default/recursive_two_files2.md index df08f56c..ddd147ae 100644 --- a/docs/examples/examples_md_nested_default/recursive_two_files2.md +++ b/docs/examples/examples_md_nested_default/recursive_two_files2.md @@ -2,11 +2,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) \ No newline at end of file diff --git a/docs/examples/examples_md_nested_default/ref_merge.md b/docs/examples/examples_md_nested_default/ref_merge.md index e7690b19..89d04eb5 100644 --- a/docs/examples/examples_md_nested_default/ref_merge.md +++ b/docs/examples/examples_md_nested_default/ref_merge.md @@ -7,11 +7,11 @@ **Title:** Test -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -45,13 +45,13 @@ Must be one of:
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Default** | `{"a": "a", "b": "b"}` | -| **Defined in** | #/definitions/aDictProperty | +| | | +| ------------------------- | --------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Default** | `{"a": "a", "b": "b"}` | +| **Defined in** | #/definitions/aDictProperty |
diff --git a/docs/examples/examples_md_nested_default/ref_with_other_elements.md b/docs/examples/examples_md_nested_default/ref_with_other_elements.md index 579003ce..050c3d47 100644 --- a/docs/examples/examples_md_nested_default/ref_with_other_elements.md +++ b/docs/examples/examples_md_nested_default/ref_with_other_elements.md @@ -6,11 +6,11 @@ **Title:** OF -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
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 0c92db03..d5d81f5c 100644 --- a/docs/examples/examples_md_nested_default/ref_with_tabs.md +++ b/docs/examples/examples_md_nested_default/ref_with_tabs.md @@ -127,11 +127,11 @@ - [2.1.3.5.1. root > objectA > signature > oneOf > item 0 > signers > Signature > excludes > excludes items](#autogenerated_heading_25) - [2.1.3.6. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > value](#objectA_signature_oneOf_i0_signers_items_value) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -140,11 +140,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -155,12 +155,12 @@ **Title:** Signature -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/signature | +| | | +| ------------------------- | ----------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/signature |
@@ -174,11 +174,11 @@ #### 1.1.1. Property `root > objectA > signature > oneOf > item 0` -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
@@ -212,12 +212,12 @@ **Title:** Signature -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/signer | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/signer |
@@ -226,11 +226,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | Yes | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | Yes | +| **Additional properties** | Any type allowed |
@@ -318,12 +318,12 @@ Must be one of: **Title:** Public key -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/publicKey | +| | | +| ------------------------- | ----------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/publicKey | **Description:** Optional. Public key object. @@ -339,19 +339,19 @@ Must be one of: ###### 1.1.1.1.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 1.1.1.1.1.3.1.1. If (kty = "EC") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
@@ -440,19 +440,19 @@ Must be one of: ###### 1.1.1.1.1.3.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 1.1.1.1.1.3.2.1. If (kty = "OKP") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
@@ -521,19 +521,19 @@ Must be one of: ###### 1.1.1.1.1.3.3. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 1.1.1.1.1.3.3.1. If (kty = "RSA") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
@@ -728,11 +728,11 @@ Must be one of: #### 1.1.2. Property `root > objectA > signature > oneOf > item 1` -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
@@ -766,12 +766,12 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Same definition as** | [Signature](#objectA_signature_oneOf_i0_signers_items) | +| | | +| ------------------------- | ------------------------------------------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Same definition as** | [Signature](#objectA_signature_oneOf_i0_signers_items) |
@@ -783,12 +783,12 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/signer | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/signer | **Description:** Unique top level property for simple signatures. (signaturecore) @@ -799,11 +799,11 @@ Must be one of:
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | Yes | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | Yes | +| **Additional properties** | Any type allowed |
@@ -891,12 +891,12 @@ Must be one of: **Title:** Public key -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/publicKey | +| | | +| ------------------------- | ----------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/publicKey | **Description:** Optional. Public key object. @@ -912,19 +912,19 @@ Must be one of: ###### 1.1.3.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 1.1.3.3.1.1. If (kty = "EC") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
@@ -1013,19 +1013,19 @@ Must be one of: ###### 1.1.3.3.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 1.1.3.3.2.1. If (kty = "OKP") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
@@ -1094,19 +1094,19 @@ Must be one of: ###### 1.1.3.3.3. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 1.1.3.3.3.1. If (kty = "RSA") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
@@ -1310,11 +1310,11 @@ Must be one of:
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -1325,12 +1325,12 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/signature | +| | | +| ------------------------- | ----------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/signature |
@@ -1344,11 +1344,11 @@ Must be one of: #### 2.1.1. Property `root > objectA > signature > oneOf > item 0` -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
@@ -1382,12 +1382,12 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/signer | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/signer |
@@ -1396,11 +1396,11 @@ Must be one of:
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | Yes | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | Yes | +| **Additional properties** | Any type allowed |
@@ -1488,12 +1488,12 @@ Must be one of: **Title:** Public key -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/publicKey | +| | | +| ------------------------- | ----------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/publicKey | **Description:** Optional. Public key object. @@ -1509,19 +1509,19 @@ Must be one of: ###### 2.1.1.1.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 2.1.1.1.1.3.1.1. If (kty = "EC") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
@@ -1610,19 +1610,19 @@ Must be one of: ###### 2.1.1.1.1.3.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 2.1.1.1.1.3.2.1. If (kty = "OKP") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
@@ -1691,19 +1691,19 @@ Must be one of: ###### 2.1.1.1.1.3.3. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 2.1.1.1.1.3.3.1. If (kty = "RSA") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
@@ -1898,11 +1898,11 @@ Must be one of: #### 2.1.2. Property `root > objectA > signature > oneOf > item 1` -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
@@ -1936,12 +1936,12 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Same definition as** | [Signature](#objectA_signature_oneOf_i0_signers_items) | +| | | +| ------------------------- | ------------------------------------------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Same definition as** | [Signature](#objectA_signature_oneOf_i0_signers_items) |
@@ -1953,12 +1953,12 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/signer | +| | | +| ------------------------- | -------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/signer | **Description:** Unique top level property for simple signatures. (signaturecore) @@ -1969,11 +1969,11 @@ Must be one of:
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | Yes | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | Yes | +| **Additional properties** | Any type allowed |
@@ -2061,12 +2061,12 @@ Must be one of: **Title:** Public key -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/publicKey | +| | | +| ------------------------- | ----------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/publicKey | **Description:** Optional. Public key object. @@ -2082,19 +2082,19 @@ Must be one of: ###### 2.1.3.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 2.1.3.3.1.1. If (kty = "EC") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
@@ -2183,19 +2183,19 @@ Must be one of: ###### 2.1.3.3.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 2.1.3.3.2.1. If (kty = "OKP") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
@@ -2264,19 +2264,19 @@ Must be one of: ###### 2.1.3.3.3. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ###### 2.1.3.3.3.1. If (kty = "RSA") -| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| | | +| ------------------------- | ----------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed |
diff --git a/docs/examples/examples_md_nested_default/reference_int.md b/docs/examples/examples_md_nested_default/reference_int.md index 062d6e15..66887238 100644 --- a/docs/examples/examples_md_nested_default/reference_int.md +++ b/docs/examples/examples_md_nested_default/reference_int.md @@ -5,11 +5,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -18,12 +18,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/extra_options/anyOf/0 | +| | | +| ------------------------- | ----------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/extra_options/anyOf/0 | **Description:** This is the one @@ -37,12 +37,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/10 | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/10 | **Description:** This is just to be annoying. The property 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 04681cb9..eb4a10aa 100644 --- a/docs/examples/examples_md_nested_default/references.md +++ b/docs/examples/examples_md_nested_default/references.md @@ -20,11 +20,11 @@ - [13. [Optional] Property root > multi_hierarchy_reference](#multi_hierarchy_reference) - [13.1. [Optional] Property root > multi_hierarchy_reference > propertyA](#multi_hierarchy_reference_propertyA) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Testing $ref @@ -71,12 +71,12 @@
-| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/object_def | +| | | +| ------------------------- | ------------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Defined in** | #/definitions/object_def |
@@ -176,12 +176,12 @@
-| | | -| ------------------------- | ------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| **Same definition as** | [anchor_with_slash](#anchor_with_slash) | +| | | +| ------------------------- | --------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Not allowed | +| **Same definition as** | [anchor_with_slash](#anchor_with_slash) |
@@ -209,12 +209,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | with_descriptions.json#/definitions/gift | +| | | +| ------------------------- | ---------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | with_descriptions.json#/definitions/gift | **Description:** The delivery is a gift, no prices displayed @@ -243,12 +243,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [other_file_anchor](#other_file_anchor) | +| | | +| ------------------------- | --------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [other_file_anchor](#other_file_anchor) | **Description:** The delivery is a gift, no prices displayed @@ -262,12 +262,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [other_file_anchor](#other_file_anchor) | +| | | +| ------------------------- | --------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [other_file_anchor](#other_file_anchor) | **Description:** The delivery is a gift, no prices displayed @@ -281,12 +281,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | combining_not.json | +| | | +| ------------------------- | ------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | combining_not.json | **Description:** Test schema with a not @@ -297,11 +297,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | Yes | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | Yes | +| **Additional properties** | Any type allowed | #### 12.1.1. Must **not** be @@ -323,12 +323,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | reference_schemas/intermediate.json#/properties/cross_file_reference | +| | | +| ------------------------- | -------------------------------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | reference_schemas/intermediate.json#/properties/cross_file_reference |
diff --git a/docs/examples/examples_md_nested_default/references_url.md b/docs/examples/examples_md_nested_default/references_url.md index 2e9a95f8..15c09d9f 100644 --- a/docs/examples/examples_md_nested_default/references_url.md +++ b/docs/examples/examples_md_nested_default/references_url.md @@ -2,11 +2,11 @@ - [1. [Optional] Property root > firstName](#firstName) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Testing $ref with URL 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 3df4ac2f..c2bcd4f1 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 @@ -4,11 +4,11 @@ - [1.1. [Optional] Property root > described > name](#described_name) - [1.2. [Optional] Property root > described > alignment](#described_alignment) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Testing $ref of a remote $ref @@ -23,7 +23,7 @@ | ------------------------- | -------------------------------------------------------------------------------------------------------------------- | | **Type** | `object` | | **Required** | No | -| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | +| **Additional properties** | Not allowed | | **Defined in** | https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/description_from_ref.json |
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 131495d7..de0d6e9b 100644 --- a/docs/examples/examples_md_nested_default/references_url_yaml.md +++ b/docs/examples/examples_md_nested_default/references_url_yaml.md @@ -5,11 +5,11 @@ - [1.2. [Required] Property root > address > city](#address_city) - [1.3. [Required] Property root > address > state](#address_state) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Testing $ref with URL with YAML destination @@ -24,7 +24,7 @@ | ------------------------- | ------------------------------------------------------------------------------------------------------------------------- | | **Type** | `object` | | **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Additional properties** | Any type allowed | | **Defined in** | https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/yaml.yaml#/definitions/address |
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 ee406fbf..6ea6a24b 100644 --- a/docs/examples/examples_md_nested_default/required_properties_order.md +++ b/docs/examples/examples_md_nested_default/required_properties_order.md @@ -7,11 +7,11 @@ **Title:** Undocumented Required Properties order -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -20,11 +20,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ### 1.1. The following properties are required * a @@ -40,11 +40,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | ### 2.1. The following properties are required * b 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 1244bf32..b38cf919 100644 --- a/docs/examples/examples_md_nested_default/single_element_allOf.md +++ b/docs/examples/examples_md_nested_default/single_element_allOf.md @@ -5,11 +5,11 @@ **Title:** Schema containing a single-element allOf -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Schema containing a single-element allOf diff --git a/docs/examples/examples_md_nested_default/top_level_combining.md b/docs/examples/examples_md_nested_default/top_level_combining.md index 3739766c..906fe20f 100644 --- a/docs/examples/examples_md_nested_default/top_level_combining.md +++ b/docs/examples/examples_md_nested_default/top_level_combining.md @@ -7,11 +7,11 @@ **Title:** Combining at top level -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** For the combine @@ -28,48 +28,48 @@ ## 1. Property `Combining at top level > oneOf > diskDevice` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskDevice | +| | | +| ------------------------- | ------------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/diskDevice |
## 2. Property `Combining at top level > oneOf > diskUUID` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskUUID | +| | | +| ------------------------- | ---------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/diskUUID |
## 3. Property `Combining at top level > oneOf > nfs` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/nfs | +| | | +| ------------------------- | ----------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/nfs |
## 4. Property `Combining at top level > oneOf > tmpfs` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/tmpfs | +| | | +| ------------------------- | ------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/tmpfs |
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 eb22a78c..8c42f6c8 100644 --- a/docs/examples/examples_md_nested_default/type_object_null.md +++ b/docs/examples/examples_md_nested_default/type_object_null.md @@ -5,11 +5,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
diff --git a/docs/examples/examples_md_nested_default/with_default.md b/docs/examples/examples_md_nested_default/with_default.md index 3495147f..2ab5649f 100644 --- a/docs/examples/examples_md_nested_default/with_default.md +++ b/docs/examples/examples_md_nested_default/with_default.md @@ -7,11 +7,11 @@ **Title:** User Preference -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
diff --git a/docs/examples/examples_md_nested_default/with_definitions.md b/docs/examples/examples_md_nested_default/with_definitions.md index 42926780..edf1decc 100644 --- a/docs/examples/examples_md_nested_default/with_definitions.md +++ b/docs/examples/examples_md_nested_default/with_definitions.md @@ -7,11 +7,11 @@ - [1.4. [Optional] Property root > billing_address > futureProperty](#billing_address_futureProperty) - [2. [Optional] Property root > shipping_address](#shipping_address) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -20,12 +20,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/address | +| | | +| ------------------------- | --------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/address |
@@ -97,12 +97,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [billing_address](#billing_address) | +| | | +| ------------------------- | ----------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [billing_address](#billing_address) |
diff --git a/docs/examples/examples_md_nested_default/with_descriptions.md b/docs/examples/examples_md_nested_default/with_descriptions.md index 649bde7b..700081bc 100644 --- a/docs/examples/examples_md_nested_default/with_descriptions.md +++ b/docs/examples/examples_md_nested_default/with_descriptions.md @@ -13,11 +13,11 @@ **Title:** Delivery Schema -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -26,12 +26,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/address | +| | | +| ------------------------- | --------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/address | **Description:** Exact address @@ -90,12 +90,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [shipping_address](#shipping_address) | +| | | +| ------------------------- | ------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Same definition as** | [shipping_address](#shipping_address) | **Description:** Exact address @@ -109,12 +109,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/delivery_info | +| | | +| ------------------------- | --------------------------- | +| **Type** | `combining` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/delivery_info | **Description:** Delivery info depending on the delivery type @@ -129,12 +129,12 @@ ### 3.1. Property `Delivery Schema > delivery_info > oneOf > classic` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/classic | +| | | +| ------------------------- | --------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/classic |
@@ -156,12 +156,12 @@ ### 3.2. Property `Delivery Schema > delivery_info > oneOf > gift` -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/gift | +| | | +| ------------------------- | ------------------ | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/gift | **Description:** The delivery is a gift, no prices displayed diff --git a/docs/examples/examples_md_nested_default/with_examples.md b/docs/examples/examples_md_nested_default/with_examples.md index 85833ae4..88e820a5 100644 --- a/docs/examples/examples_md_nested_default/with_examples.md +++ b/docs/examples/examples_md_nested_default/with_examples.md @@ -7,11 +7,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -102,11 +102,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** Any more info you want as an object diff --git a/docs/examples/examples_md_nested_default/with_keywords.md b/docs/examples/examples_md_nested_default/with_keywords.md index 0f6779ae..4f52779c 100644 --- a/docs/examples/examples_md_nested_default/with_keywords.md +++ b/docs/examples/examples_md_nested_default/with_keywords.md @@ -14,11 +14,11 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -61,11 +61,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** if @@ -79,11 +79,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** then @@ -97,11 +97,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** else @@ -115,11 +115,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** anyOf @@ -133,11 +133,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** allOf @@ -151,11 +151,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** not @@ -169,11 +169,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** properties @@ -187,11 +187,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** patternProperties @@ -205,11 +205,11 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | **Description:** 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 a7d0a6b9..a21aa6cf 100644 --- a/docs/examples/examples_md_nested_default/with_special_chars.md +++ b/docs/examples/examples_md_nested_default/with_special_chars.md @@ -9,11 +9,11 @@ **Title:** Personne -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
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 273d047e..46136ab0 100644 --- a/docs/examples/examples_md_nested_default/with_urlencoded_anchor.md +++ b/docs/examples/examples_md_nested_default/with_urlencoded_anchor.md @@ -6,11 +6,11 @@ - [1.2.1. [Optional] Property root > signingTimeInfo > signingTimeBounds > lowerBound](#signingTimeInfo_signingTimeBounds_lowerBound) - [1.2.2. [Optional] Property root > signingTimeInfo > signingTimeBounds > upperBound](#signingTimeInfo_signingTimeBounds_upperBound) -| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | ---------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed |
@@ -19,12 +19,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/dss2-SigningTimeInfoType | +| | | +| ------------------------- | -------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/dss2-SigningTimeInfoType |
@@ -49,12 +49,12 @@
-| | | -| ------------------------- | ------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/dss2-SigningTimeInfoType%3ASigningTimeBoundaries | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | Any type allowed | +| **Defined in** | #/definitions/dss2-SigningTimeInfoType%3ASigningTimeBoundaries |
diff --git a/docs/examples/examples_md_nested_with_badges/Configuration.md b/docs/examples/examples_md_nested_with_badges/Configuration.md index 5196c998..41f99028 100644 --- a/docs/examples/examples_md_nested_with_badges/Configuration.md +++ b/docs/examples/examples_md_nested_with_badges/Configuration.md @@ -32,10 +32,10 @@ **Title:** JSON Schema for Humans configuration file -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Choose how to generate JSON Schema for Humans documentation file. @@ -390,7 +390,7 @@ This is the old behaviour and is only needed for browsers that do not support HT | | | | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | **Default** | `{"fenced-code-blocks": {"cssclass": "highlight jumbotron"}, "tables": null, "breaks": {"on_newline": true, "on_backslash": true}}` | **Description:** (Only used with `description_is_markdown`) @@ -419,10 +419,10 @@ This is the old behaviour and is only needed for browsers that do not support HT
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** specific options to md template @@ -571,11 +571,12 @@ Must be one of:
-| | | -| -------------- | ---------------------------------------------------------- | -| **Type** | `boolean` | -| **Deprecated** | ![Deprecated](https://img.shields.io/badge/Deprecated-red) | -| **Default** | `false` | +| | | +| -------------- | --------- | +| **Type** | `boolean` | +| **Deprecated** | +| ! | [ | D | e | p | r | e | c | a | t | e | d | ] | ( | h | t | t | p | s | : | / | / | i | m | g | . | s | h | i | e | l | d | s | . | i | o | / | b | a | d | g | e | / | D | e | p | r | e | c | a | t | e | d | - | r | e | d | ) | +| **Default** | `false` | **Description:** [Deprecated] @@ -589,11 +590,12 @@ Must be one of:
-| | | -| -------------- | ---------------------------------------------------------- | -| **Type** | `boolean` | -| **Deprecated** | ![Deprecated](https://img.shields.io/badge/Deprecated-red) | -| **Default** | `true` | +| | | +| -------------- | --------- | +| **Type** | `boolean` | +| **Deprecated** | +| ! | [ | D | e | p | r | e | c | a | t | e | d | ] | ( | h | t | t | p | s | : | / | / | i | m | g | . | s | h | i | e | l | d | s | . | i | o | / | b | a | d | g | e | / | D | e | p | r | e | c | a | t | e | d | - | r | e | d | ) | +| **Default** | `true` | **Description:** [Deprecated] @@ -607,10 +609,11 @@ Must be one of:
-| | | -| -------------- | ---------------------------------------------------------- | -| **Type** | `string` | -| **Deprecated** | ![Deprecated](https://img.shields.io/badge/Deprecated-red) | +| | | +| -------------- | -------- | +| **Type** | `string` | +| **Deprecated** | +| ! | [ | D | e | p | r | e | c | a | t | e | d | ] | ( | h | t | t | p | s | : | / | / | i | m | g | . | s | h | i | e | l | d | s | . | i | o | / | b | a | d | g | e | / | D | e | p | r | e | c | a | t | e | d | - | r | e | d | ) | **Description:** [Deprecated] 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 e1f49d3a..4f2346a7 100644 --- a/docs/examples/examples_md_nested_with_badges/additional_properties.md +++ b/docs/examples/examples_md_nested_with_badges/additional_properties.md @@ -10,10 +10,10 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| **Type** | `object` | -| **Additional properties** | [![Should-conform](https://img.shields.io/badge/Should-conform-blue)](#additionalProperties "Each additional property must conform to the following schema") | +| | | +| ------------------------- | -------------------------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | [![Should-conform](https://img.shields.io/badge/Should-conform-blue)](#additionalProperties) |
@@ -22,10 +22,10 @@
-| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | **Description:** A sub type with additionalProperties false. @@ -53,10 +53,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** A sub type with additionalProperties true. @@ -100,10 +100,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** additionalProperties schema. 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 5b926ee5..e2070857 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 @@ -6,10 +6,10 @@ - [1.3. Property `root > storage > anyOf > item 2`](#storage_anyOf_i2) - [1.4. Property `root > storage > anyOf > tmpfs`](#storage_anyOf_i3) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** JSON Schema for an fstab entry @@ -20,10 +20,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -38,43 +38,43 @@ ### 1.1. Property `root > storage > anyOf > diskDevice` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskDevice | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/diskDevice |
### 1.2. Property `root > storage > anyOf > diskUUID` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskUUID | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/diskUUID |
### 1.3. Property `root > storage > anyOf > item 2` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
### 1.4. Property `root > storage > anyOf > tmpfs` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/tmpfs | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/tmpfs |
diff --git a/docs/examples/examples_md_nested_with_badges/array.md b/docs/examples/examples_md_nested_with_badges/array.md index 8d6d16a8..ae5f4a62 100644 --- a/docs/examples/examples_md_nested_with_badges/array.md +++ b/docs/examples/examples_md_nested_with_badges/array.md @@ -7,10 +7,10 @@ - [2.1.1. [Required] Property root > vegetables > vegetables items > veggieName](#vegetables_items_veggieName) - [2.1.2. [Required] Property root > vegetables > vegetables items > veggieLike](#vegetables_items_veggieLike) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** A schema with an array @@ -71,11 +71,11 @@ ### 2.1. root > vegetables > veggie -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/veggie | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/veggie |
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 f1ed454a..33b7bd52 100644 --- a/docs/examples/examples_md_nested_with_badges/array_additionalItems.md +++ b/docs/examples/examples_md_nested_with_badges/array_additionalItems.md @@ -9,10 +9,10 @@ - [2.1. root > addressLines > addressLines item 0](#autogenerated_heading_6) - [3. [Optional] Property root > arrayEmpty](#arrayEmpty) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** A little food fun 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 dd384252..3e9c860b 100644 --- a/docs/examples/examples_md_nested_with_badges/array_advanced.md +++ b/docs/examples/examples_md_nested_with_badges/array_advanced.md @@ -6,10 +6,10 @@ - [2.1. root > vegetables > vegetables items](#autogenerated_heading_3) - [2.2. At least one of the items must be](#autogenerated_heading_4) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** A little food fun @@ -72,10 +72,10 @@ ### 2.1. root > vegetables > vegetables items -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ### 2.2. At least one of the items must be 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 15ad636b..41faf946 100644 --- a/docs/examples/examples_md_nested_with_badges/array_example.md +++ b/docs/examples/examples_md_nested_with_badges/array_example.md @@ -3,10 +3,10 @@ - [1. [Optional] Property root > fruits](#fruits) - [1.1. root > fruits > fruits items](#autogenerated_heading_2) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** A schema with an array diff --git a/docs/examples/examples_md_nested_with_badges/basic.md b/docs/examples/examples_md_nested_with_badges/basic.md index 038bca45..bf871d45 100644 --- a/docs/examples/examples_md_nested_with_badges/basic.md +++ b/docs/examples/examples_md_nested_with_badges/basic.md @@ -9,10 +9,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -79,10 +79,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
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 c57b85d9..b7cbb874 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 @@ -4,10 +4,10 @@ **Title:** Hello -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
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 feeb50a8..3c7e5d95 100644 --- a/docs/examples/examples_md_nested_with_badges/broken_ref.md +++ b/docs/examples/examples_md_nested_with_badges/broken_ref.md @@ -5,10 +5,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -35,11 +35,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | a_file_that_does_not_exist_and_will_never_i_hope.lol.json | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | a_file_that_does_not_exist_and_will_never_i_hope.lol.json | **Description:** 😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️ diff --git a/docs/examples/examples_md_nested_with_badges/circular.md b/docs/examples/examples_md_nested_with_badges/circular.md index 3f13b668..fc22ce67 100644 --- a/docs/examples/examples_md_nested_with_badges/circular.md +++ b/docs/examples/examples_md_nested_with_badges/circular.md @@ -5,10 +5,10 @@ **Title:** Circular reference Schema -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -17,11 +17,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/a | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/a |
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 9b56f6b1..6832e6ac 100644 --- a/docs/examples/examples_md_nested_with_badges/combining_not.md +++ b/docs/examples/examples_md_nested_with_badges/combining_not.md @@ -3,10 +3,10 @@ - [1. [Required] Property root > not_a_string](#not_a_string) - [1.1. Must **not** be](#autogenerated_heading_2) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Test schema with a not @@ -17,10 +17,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ### 1.1. Must **not** be 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 da1e1ac5..ce46d9fc 100644 --- a/docs/examples/examples_md_nested_with_badges/combining_oneOf.md +++ b/docs/examples/examples_md_nested_with_badges/combining_oneOf.md @@ -6,10 +6,10 @@ - [1.3. Property `root > storage > oneOf > nfs`](#storage_oneOf_i2) - [1.4. Property `root > storage > oneOf > tmpfs`](#storage_oneOf_i3) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** JSON Schema for an fstab entry @@ -20,10 +20,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -38,44 +38,44 @@ ### 1.1. Property `root > storage > oneOf > diskDevice` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskDevice | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/diskDevice |
### 1.2. Property `root > storage > oneOf > diskUUID` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskUUID | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/diskUUID |
### 1.3. Property `root > storage > oneOf > nfs` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/nfs | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/nfs |
### 1.4. Property `root > storage > oneOf > tmpfs` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/tmpfs | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/tmpfs |
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 40008cc6..639a8fab 100644 --- a/docs/examples/examples_md_nested_with_badges/conditional_subschema.md +++ b/docs/examples/examples_md_nested_with_badges/conditional_subschema.md @@ -7,17 +7,17 @@ - [3. [Optional] Property root > street_address](#street_address) - [4. [Optional] Property root > country](#country) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ## 1. If (country = "United States of America") -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -26,10 +26,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------------------- | @@ -40,10 +40,10 @@ ## 2. Else (i.e. country != "United States of America") -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -52,10 +52,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | 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 e168051c..187ddcb9 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 @@ -12,10 +12,10 @@ - [4. [Optional] Property root > street_address](#street_address) - [5. [Optional] Property root > country](#country) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -29,17 +29,17 @@ ## 1. Property `root > allOf > item 0` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ### 1.1. If (country = "United States of America") -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -48,10 +48,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------------------- | @@ -65,17 +65,17 @@ ## 2. Property `root > allOf > item 1` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ### 2.1. If (country = "Canada") -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -84,10 +84,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | @@ -101,17 +101,17 @@ ## 3. Property `root > allOf > item 2` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ### 3.1. If (country = "Netherlands") -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -120,10 +120,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------- | diff --git a/docs/examples/examples_md_nested_with_badges/defaults.md b/docs/examples/examples_md_nested_with_badges/defaults.md index f206ae02..43deb129 100644 --- a/docs/examples/examples_md_nested_with_badges/defaults.md +++ b/docs/examples/examples_md_nested_with_badges/defaults.md @@ -3,10 +3,10 @@ - [1. [Optional] Property root > a](#a) - [2. [Optional] Property root > b](#b) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -15,12 +15,12 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Default** | `"Default from a"` | -| **Defined in** | #/definitions/common | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Default** | `"Default from a"` | +| **Defined in** | #/definitions/common | **Description:** Description of a @@ -34,12 +34,12 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Default** | `"Default from b"` | -| **Defined in** | #/definitions/common | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Default** | `"Default from b"` | +| **Defined in** | #/definitions/common | **Description:** A common description diff --git a/docs/examples/examples_md_nested_with_badges/deprecated.md b/docs/examples/examples_md_nested_with_badges/deprecated.md index e1c6c92e..868c77fb 100644 --- a/docs/examples/examples_md_nested_with_badges/deprecated.md +++ b/docs/examples/examples_md_nested_with_badges/deprecated.md @@ -6,10 +6,10 @@ - [4. [Optional]~~ Property root > deprecated4~~](#deprecated4) - [5. [Optional] Property root > not_deprecated](#not_deprecated) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Test schema with deprecated in description @@ -20,11 +20,12 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Deprecated** | ![Deprecated](https://img.shields.io/badge/Deprecated-red) | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Deprecated** | +| ! | [ | D | e | p | r | e | c | a | t | e | d | ] | ( | h | t | t | p | s | : | / | / | i | m | g | . | s | h | i | e | l | d | s | . | i | o | / | b | a | d | g | e | / | D | e | p | r | e | c | a | t | e | d | - | r | e | d | ) | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** [Deprecated] @@ -38,11 +39,12 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Deprecated** | ![Deprecated](https://img.shields.io/badge/Deprecated-red) | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Deprecated** | +| ! | [ | D | e | p | r | e | c | a | t | e | d | ] | ( | h | t | t | p | s | : | / | / | i | m | g | . | s | h | i | e | l | d | s | . | i | o | / | b | a | d | g | e | / | D | e | p | r | e | c | a | t | e | d | - | r | e | d | ) | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** [Deprecated - Use `not_deprecated` instead] @@ -56,11 +58,12 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Deprecated** | ![Deprecated](https://img.shields.io/badge/Deprecated-red) | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Deprecated** | +| ! | [ | D | e | p | r | e | c | a | t | e | d | ] | ( | h | t | t | p | s | : | / | / | i | m | g | . | s | h | i | e | l | d | s | . | i | o | / | b | a | d | g | e | / | D | e | p | r | e | c | a | t | e | d | - | r | e | d | ) | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** This is [Deprecated] @@ -74,11 +77,12 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Deprecated** | ![Deprecated](https://img.shields.io/badge/Deprecated-red) | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Deprecated** | +| ! | [ | D | e | p | r | e | c | a | t | e | d | ] | ( | h | t | t | p | s | : | / | / | i | m | g | . | s | h | i | e | l | d | s | . | i | o | / | b | a | d | g | e | / | D | e | p | r | e | c | a | t | e | d | - | r | e | d | ) | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** This is [Deprecated - Use `not_deprecated` instead] 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 aa26fde2..fc4bce00 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 @@ -3,10 +3,10 @@ - [1. [Optional] Property root > name](#name) - [2. [Optional] Property root > alignment](#alignment) -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
diff --git a/docs/examples/examples_md_nested_with_badges/description_markdown.md b/docs/examples/examples_md_nested_with_badges/description_markdown.md index 4ed62f8a..4ff1bc76 100644 --- a/docs/examples/examples_md_nested_with_badges/description_markdown.md +++ b/docs/examples/examples_md_nested_with_badges/description_markdown.md @@ -2,10 +2,10 @@ **Title:** Delivery Schema -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** DOC * List 1 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 bf6b6b49..74a57ef4 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 @@ -4,10 +4,10 @@ - [1.1. [Required] Property root > outer > inner](#outer_inner) - [2. [Optional] Property root > outer2](#outer2) -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
@@ -16,11 +16,11 @@
-| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/inner schema | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Defined in** | #/definitions/inner schema | **Description:** We should see this @@ -50,11 +50,11 @@
-| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Same definition as** | [outer](#outer) | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Same definition as** | [outer](#outer) | **Description:** We should see this too 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 3223c6b7..ae4ab4db 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 @@ -4,10 +4,10 @@ **Title:** Empty property name -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
diff --git a/docs/examples/examples_md_nested_with_badges/enumofnone.md b/docs/examples/examples_md_nested_with_badges/enumofnone.md index 82e18503..f0fce777 100644 --- a/docs/examples/examples_md_nested_with_badges/enumofnone.md +++ b/docs/examples/examples_md_nested_with_badges/enumofnone.md @@ -4,10 +4,10 @@ **Title:** Enum of None -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
diff --git a/docs/examples/examples_md_nested_with_badges/geo.md b/docs/examples/examples_md_nested_with_badges/geo.md index 1f41f4f3..5c002534 100644 --- a/docs/examples/examples_md_nested_with_badges/geo.md +++ b/docs/examples/examples_md_nested_with_badges/geo.md @@ -5,10 +5,10 @@ **Title:** Longitude and Latitude Values -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** A geographical coordinate. diff --git a/docs/examples/examples_md_nested_with_badges/html_in_description.md b/docs/examples/examples_md_nested_with_badges/html_in_description.md index 90d7c297..f0c9b639 100644 --- a/docs/examples/examples_md_nested_with_badges/html_in_description.md +++ b/docs/examples/examples_md_nested_with_badges/html_in_description.md @@ -6,10 +6,10 @@ **Title:** HTML in descriptions -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
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 f11529f3..1910f66b 100644 --- a/docs/examples/examples_md_nested_with_badges/long_description.md +++ b/docs/examples/examples_md_nested_with_badges/long_description.md @@ -4,10 +4,10 @@ **Title:** Long description -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
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 6b284f06..4f7f83e8 100644 --- a/docs/examples/examples_md_nested_with_badges/multiple_types.md +++ b/docs/examples/examples_md_nested_with_badges/multiple_types.md @@ -7,10 +7,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
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 70c19903..f107dde9 100644 --- a/docs/examples/examples_md_nested_with_badges/pattern_properties.md +++ b/docs/examples/examples_md_nested_with_badges/pattern_properties.md @@ -8,10 +8,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -61,10 +61,10 @@ must respect the following conditions **Title:** paperSize -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Review of a paper size. 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 18a79b09..3f5426f2 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 @@ -8,10 +8,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -20,10 +20,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -37,10 +37,10 @@ must respect the following conditions **Title:** Title 4 -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Description 4 @@ -62,10 +62,10 @@ must respect the following conditions **Title:** Title 1 -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Description 1 @@ -84,10 +84,10 @@ must respect the following conditions **Title:** Title 2 -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Description 2 @@ -106,10 +106,10 @@ must respect the following conditions **Title:** Title 3 -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Description 3 diff --git a/docs/examples/examples_md_nested_with_badges/prefixItems.md b/docs/examples/examples_md_nested_with_badges/prefixItems.md index b8609252..612654e4 100644 --- a/docs/examples/examples_md_nested_with_badges/prefixItems.md +++ b/docs/examples/examples_md_nested_with_badges/prefixItems.md @@ -8,10 +8,10 @@ **Title:** Address -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
diff --git a/docs/examples/examples_md_nested_with_badges/recursive.md b/docs/examples/examples_md_nested_with_badges/recursive.md index 1c5fbc4a..83d987bd 100644 --- a/docs/examples/examples_md_nested_with_badges/recursive.md +++ b/docs/examples/examples_md_nested_with_badges/recursive.md @@ -6,10 +6,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -18,11 +18,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/person | **Description:** A human being @@ -53,11 +53,11 @@ #### 1.1.1. Person > person > children > person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [person](#person) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [person](#person) | **Description:** A human being 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 08c7e6db..db5eba82 100644 --- a/docs/examples/examples_md_nested_with_badges/recursive_array.md +++ b/docs/examples/examples_md_nested_with_badges/recursive_array.md @@ -7,10 +7,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -39,11 +39,11 @@ ### 1.1. Person > person > person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/person | **Description:** A human being @@ -74,11 +74,11 @@ ##### 1.1.1.1. Person > person > person items > children > person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [person_items](#person_items) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [person_items](#person_items) | **Description:** A human being 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 081ac774..ad10d57e 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 @@ -10,10 +10,10 @@ **Title:** Bug -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Display the issue. @@ -62,11 +62,11 @@ **Title:** Bug -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [Bug](#root) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [Bug](#root) | **Description:** Display the issue. @@ -100,10 +100,10 @@ ### 3.1. Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -128,11 +128,11 @@ **Title:** Bug -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [Bug](#root) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [Bug](#root) | **Description:** Display the issue. 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 968dbf62..8cddbd32 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 @@ -4,10 +4,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -18,11 +18,11 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [Person](#root) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [Person](#root) |
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 b62b4233..f5ffc4cf 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 @@ -7,10 +7,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -19,11 +19,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person/properties/relationships | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/person/properties/relationships | **Description:** Relationships between this person and others @@ -34,11 +34,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/person | **Description:** A human being @@ -49,10 +49,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Relationships between this person and others @@ -63,11 +63,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [mother](#relationships_mother) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [mother](#relationships_mother) | **Description:** A human being 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 e9c1e5aa..f5e9645e 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 @@ -7,10 +7,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -19,11 +19,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/person | **Description:** A human being @@ -54,11 +54,11 @@ #### 1.1.1. Person > person > children > person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | recursive_two_files2.json#/definitions/person | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | recursive_two_files2.json#/definitions/person | **Description:** Person definition from second file. Not the same! @@ -72,11 +72,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [person_children_items](#person_children_items) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [person_children_items](#person_children_items) | **Description:** Person definition from second file. Not the same! diff --git a/docs/examples/examples_md_nested_with_badges/recursive_two_files2.md b/docs/examples/examples_md_nested_with_badges/recursive_two_files2.md index 325f67d6..23b91e33 100644 --- a/docs/examples/examples_md_nested_with_badges/recursive_two_files2.md +++ b/docs/examples/examples_md_nested_with_badges/recursive_two_files2.md @@ -2,10 +2,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) \ No newline at end of file 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 145e7f54..aa9b021d 100644 --- a/docs/examples/examples_md_nested_with_badges/ref_merge.md +++ b/docs/examples/examples_md_nested_with_badges/ref_merge.md @@ -7,10 +7,10 @@ **Title:** Test -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -43,12 +43,12 @@ Must be one of:
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Default** | `{"a": "a", "b": "b"}` | -| **Defined in** | #/definitions/aDictProperty | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Default** | `{"a": "a", "b": "b"}` | +| **Defined in** | #/definitions/aDictProperty |
diff --git a/docs/examples/examples_md_nested_with_badges/ref_with_other_elements.md b/docs/examples/examples_md_nested_with_badges/ref_with_other_elements.md index 346de696..0b42d34e 100644 --- a/docs/examples/examples_md_nested_with_badges/ref_with_other_elements.md +++ b/docs/examples/examples_md_nested_with_badges/ref_with_other_elements.md @@ -6,10 +6,10 @@ **Title:** OF -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
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 0ed58b27..721fe379 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 @@ -127,10 +127,10 @@ - [2.1.3.5.1. root > objectA > signature > oneOf > item 0 > signers > Signature > excludes > excludes items](#autogenerated_heading_25) - [2.1.3.6. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > value](#objectA_signature_oneOf_i0_signers_items_value) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -139,10 +139,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -153,11 +153,11 @@ **Title:** Signature -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/signature | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/signature |
@@ -171,10 +171,10 @@ #### 1.1.1. Property `root > objectA > signature > oneOf > item 0` -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
@@ -207,11 +207,11 @@ **Title:** Signature -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/signer | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Defined in** | #/definitions/signer |
@@ -220,10 +220,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -308,11 +308,11 @@ Must be one of: **Title:** Public key -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/publicKey | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/publicKey | **Description:** Optional. Public key object. @@ -328,17 +328,17 @@ Must be one of: ###### 1.1.1.1.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 1.1.1.1.1.3.1.1. If (kty = "EC") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
@@ -423,17 +423,17 @@ Must be one of: ###### 1.1.1.1.1.3.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 1.1.1.1.1.3.2.1. If (kty = "OKP") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
@@ -499,17 +499,17 @@ Must be one of: ###### 1.1.1.1.1.3.3. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 1.1.1.1.1.3.3.1. If (kty = "RSA") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
@@ -695,10 +695,10 @@ Must be one of: #### 1.1.2. Property `root > objectA > signature > oneOf > item 1` -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
@@ -731,11 +731,11 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Same definition as** | [Signature](#objectA_signature_oneOf_i0_signers_items) | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Same definition as** | [Signature](#objectA_signature_oneOf_i0_signers_items) |
@@ -747,11 +747,11 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/signer | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Defined in** | #/definitions/signer | **Description:** Unique top level property for simple signatures. (signaturecore) @@ -762,10 +762,10 @@ Must be one of:
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -850,11 +850,11 @@ Must be one of: **Title:** Public key -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/publicKey | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/publicKey | **Description:** Optional. Public key object. @@ -870,17 +870,17 @@ Must be one of: ###### 1.1.3.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 1.1.3.3.1.1. If (kty = "EC") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
@@ -965,17 +965,17 @@ Must be one of: ###### 1.1.3.3.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 1.1.3.3.2.1. If (kty = "OKP") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
@@ -1041,17 +1041,17 @@ Must be one of: ###### 1.1.3.3.3. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 1.1.3.3.3.1. If (kty = "RSA") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
@@ -1246,10 +1246,10 @@ Must be one of:
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -1260,11 +1260,11 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/signature | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/signature |
@@ -1278,10 +1278,10 @@ Must be one of: #### 2.1.1. Property `root > objectA > signature > oneOf > item 0` -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
@@ -1314,11 +1314,11 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/signer | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Defined in** | #/definitions/signer |
@@ -1327,10 +1327,10 @@ Must be one of:
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -1415,11 +1415,11 @@ Must be one of: **Title:** Public key -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/publicKey | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/publicKey | **Description:** Optional. Public key object. @@ -1435,17 +1435,17 @@ Must be one of: ###### 2.1.1.1.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 2.1.1.1.1.3.1.1. If (kty = "EC") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
@@ -1530,17 +1530,17 @@ Must be one of: ###### 2.1.1.1.1.3.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 2.1.1.1.1.3.2.1. If (kty = "OKP") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
@@ -1606,17 +1606,17 @@ Must be one of: ###### 2.1.1.1.1.3.3. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 2.1.1.1.1.3.3.1. If (kty = "RSA") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
@@ -1802,10 +1802,10 @@ Must be one of: #### 2.1.2. Property `root > objectA > signature > oneOf > item 1` -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
@@ -1838,11 +1838,11 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Same definition as** | [Signature](#objectA_signature_oneOf_i0_signers_items) | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Same definition as** | [Signature](#objectA_signature_oneOf_i0_signers_items) |
@@ -1854,11 +1854,11 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/signer | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Defined in** | #/definitions/signer | **Description:** Unique top level property for simple signatures. (signaturecore) @@ -1869,10 +1869,10 @@ Must be one of:
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -1957,11 +1957,11 @@ Must be one of: **Title:** Public key -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/publicKey | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/publicKey | **Description:** Optional. Public key object. @@ -1977,17 +1977,17 @@ Must be one of: ###### 2.1.3.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 2.1.3.3.1.1. If (kty = "EC") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
@@ -2072,17 +2072,17 @@ Must be one of: ###### 2.1.3.3.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 2.1.3.3.2.1. If (kty = "OKP") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
@@ -2148,17 +2148,17 @@ Must be one of: ###### 2.1.3.3.3. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 2.1.3.3.3.1. If (kty = "RSA") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) |
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 a463e52d..78d494a8 100644 --- a/docs/examples/examples_md_nested_with_badges/reference_int.md +++ b/docs/examples/examples_md_nested_with_badges/reference_int.md @@ -5,10 +5,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -17,11 +17,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/extra_options/anyOf/0 | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/extra_options/anyOf/0 | **Description:** This is the one @@ -35,11 +35,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/10 | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/10 | **Description:** This is just to be annoying. The property 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 fe312e34..eac13221 100644 --- a/docs/examples/examples_md_nested_with_badges/references.md +++ b/docs/examples/examples_md_nested_with_badges/references.md @@ -20,10 +20,10 @@ - [13. [Optional] Property root > multi_hierarchy_reference](#multi_hierarchy_reference) - [13.1. [Optional] Property root > multi_hierarchy_reference > propertyA](#multi_hierarchy_reference_propertyA) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Testing $ref @@ -68,11 +68,11 @@
-| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/object_def | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Defined in** | #/definitions/object_def |
@@ -167,11 +167,11 @@
-| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Same definition as** | [anchor_with_slash](#anchor_with_slash) | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Same definition as** | [anchor_with_slash](#anchor_with_slash) |
@@ -198,11 +198,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | with_descriptions.json#/definitions/gift | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | with_descriptions.json#/definitions/gift | **Description:** The delivery is a gift, no prices displayed @@ -230,11 +230,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [other_file_anchor](#other_file_anchor) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [other_file_anchor](#other_file_anchor) | **Description:** The delivery is a gift, no prices displayed @@ -248,11 +248,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [other_file_anchor](#other_file_anchor) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [other_file_anchor](#other_file_anchor) | **Description:** The delivery is a gift, no prices displayed @@ -266,11 +266,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | combining_not.json | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | combining_not.json | **Description:** Test schema with a not @@ -281,10 +281,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | #### 12.1.1. Must **not** be @@ -305,11 +305,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | reference_schemas/intermediate.json#/properties/cross_file_reference | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | reference_schemas/intermediate.json#/properties/cross_file_reference |
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 e865b7f5..72edcd05 100644 --- a/docs/examples/examples_md_nested_with_badges/references_url.md +++ b/docs/examples/examples_md_nested_with_badges/references_url.md @@ -2,10 +2,10 @@ - [1. [Optional] Property root > firstName](#firstName) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Testing $ref with URL 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 e7cee37e..8486b655 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 @@ -4,10 +4,10 @@ - [1.1. [Optional] Property root > described > name](#described_name) - [1.2. [Optional] Property root > described > alignment](#described_alignment) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Testing $ref of a remote $ref @@ -21,7 +21,7 @@ | | | | ------------------------- | -------------------------------------------------------------------------------------------------------------------- | | **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | **Defined in** | https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/description_from_ref.json |
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 677b8dfb..20ee0a0f 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 @@ -5,10 +5,10 @@ - [1.2. [Required] Property root > address > city](#address_city) - [1.3. [Required] Property root > address > state](#address_state) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Testing $ref with URL with YAML destination @@ -19,11 +19,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/yaml.yaml#/definitions/address | +| | | +| ------------------------- | ------------------------------------------------------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/yaml.yaml#/definitions/address |
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 fb7c515b..1ba3df1d 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 @@ -7,10 +7,10 @@ **Title:** Undocumented Required Properties order -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -19,10 +19,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ### 1.1. The following properties are required * a @@ -38,10 +38,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ### 2.1. The following properties are required * b 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 da7a59c2..6c341ae5 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 @@ -5,10 +5,10 @@ **Title:** Schema containing a single-element allOf -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Schema containing a single-element allOf diff --git a/docs/examples/examples_md_nested_with_badges/top_level_combining.md b/docs/examples/examples_md_nested_with_badges/top_level_combining.md index 9d4fb24a..dc1b3a4c 100644 --- a/docs/examples/examples_md_nested_with_badges/top_level_combining.md +++ b/docs/examples/examples_md_nested_with_badges/top_level_combining.md @@ -7,10 +7,10 @@ **Title:** Combining at top level -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** For the combine @@ -27,44 +27,44 @@ ## 1. Property `Combining at top level > oneOf > diskDevice` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskDevice | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/diskDevice |
## 2. Property `Combining at top level > oneOf > diskUUID` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskUUID | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/diskUUID |
## 3. Property `Combining at top level > oneOf > nfs` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/nfs | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/nfs |
## 4. Property `Combining at top level > oneOf > tmpfs` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/tmpfs | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/tmpfs |
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 b47f5755..abc448c4 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 @@ -5,10 +5,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
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 fecedd22..132c79b3 100644 --- a/docs/examples/examples_md_nested_with_badges/with_default.md +++ b/docs/examples/examples_md_nested_with_badges/with_default.md @@ -7,10 +7,10 @@ **Title:** User Preference -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
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 a90142f1..3ef7ecb0 100644 --- a/docs/examples/examples_md_nested_with_badges/with_definitions.md +++ b/docs/examples/examples_md_nested_with_badges/with_definitions.md @@ -7,10 +7,10 @@ - [1.4. [Optional] Property root > billing_address > futureProperty](#billing_address_futureProperty) - [2. [Optional] Property root > shipping_address](#shipping_address) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -19,11 +19,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/address | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/address |
@@ -91,11 +91,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [billing_address](#billing_address) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [billing_address](#billing_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 975f1288..5562ec6c 100644 --- a/docs/examples/examples_md_nested_with_badges/with_descriptions.md +++ b/docs/examples/examples_md_nested_with_badges/with_descriptions.md @@ -13,10 +13,10 @@ **Title:** Delivery Schema -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -25,11 +25,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/address | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/address | **Description:** Exact address @@ -85,11 +85,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [shipping_address](#shipping_address) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [shipping_address](#shipping_address) | **Description:** Exact address @@ -103,11 +103,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/delivery_info | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/delivery_info | **Description:** Delivery info depending on the delivery type @@ -122,11 +122,11 @@ ### 3.1. Property `Delivery Schema > delivery_info > oneOf > classic` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/classic | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/classic |
@@ -147,11 +147,11 @@ ### 3.2. Property `Delivery Schema > delivery_info > oneOf > gift` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/gift | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/gift | **Description:** The delivery is a gift, no prices displayed 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 205a1c42..1cd893cf 100644 --- a/docs/examples/examples_md_nested_with_badges/with_examples.md +++ b/docs/examples/examples_md_nested_with_badges/with_examples.md @@ -7,10 +7,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -98,10 +98,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Any more info you want as an object 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 52473f79..b4850860 100644 --- a/docs/examples/examples_md_nested_with_badges/with_keywords.md +++ b/docs/examples/examples_md_nested_with_badges/with_keywords.md @@ -14,10 +14,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -58,10 +58,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** if @@ -75,10 +75,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** then @@ -92,10 +92,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** else @@ -109,10 +109,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** anyOf @@ -126,10 +126,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** allOf @@ -143,10 +143,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** not @@ -160,10 +160,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** properties @@ -177,10 +177,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** patternProperties @@ -194,10 +194,10 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** 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 402e6e22..da0f9e6a 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 @@ -9,10 +9,10 @@ **Title:** Personne -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
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 388f8c5f..d27667b3 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 @@ -6,10 +6,10 @@ - [1.2.1. [Optional] Property root > signingTimeInfo > signingTimeBounds > lowerBound](#signingTimeInfo_signingTimeBounds_lowerBound) - [1.2.2. [Optional] Property root > signingTimeInfo > signingTimeBounds > upperBound](#signingTimeInfo_signingTimeBounds_upperBound) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) |
@@ -18,11 +18,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/dss2-SigningTimeInfoType | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/dss2-SigningTimeInfoType |
@@ -46,11 +46,11 @@
-| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/dss2-SigningTimeInfoType%3ASigningTimeBoundaries | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/dss2-SigningTimeInfoType%3ASigningTimeBoundaries |
diff --git a/docs/examples/examples_md_with_badges/Configuration.md b/docs/examples/examples_md_with_badges/Configuration.md index e21d608b..c4880c3e 100644 --- a/docs/examples/examples_md_with_badges/Configuration.md +++ b/docs/examples/examples_md_with_badges/Configuration.md @@ -32,10 +32,10 @@ **Title:** JSON Schema for Humans configuration file -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Choose how to generate JSON Schema for Humans documentation file. @@ -276,7 +276,7 @@ This is the old behaviour and is only needed for browsers that do not support HT | | | | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | **Default** | `{"fenced-code-blocks": {"cssclass": "highlight jumbotron"}, "tables": null, "breaks": {"on_newline": true, "on_backslash": true}}` | **Description:** (Only used with `description_is_markdown`) @@ -297,10 +297,10 @@ This is the old behaviour and is only needed for browsers that do not support HT ## 19. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `JSON Schema for Humans configuration file > template_md_options` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** specific options to md template @@ -400,30 +400,33 @@ Must be one of: ## 22. ![Optional](https://img.shields.io/badge/Optional-yellow)~~ Property `JSON Schema for Humans configuration file > allow_html_description`~~ -| | | -| -------------- | ---------------------------------------------------------- | -| **Type** | `boolean` | -| **Deprecated** | ![Deprecated](https://img.shields.io/badge/Deprecated-red) | -| **Default** | `false` | +| | | +| -------------- | --------- | +| **Type** | `boolean` | +| **Deprecated** | +| ! | [ | D | e | p | r | e | c | a | t | e | d | ] | ( | h | t | t | p | s | : | / | / | i | m | g | . | s | h | i | e | l | d | s | . | i | o | / | b | a | d | g | e | / | D | e | p | r | e | c | a | t | e | d | - | r | e | d | ) | +| **Default** | `false` | **Description:** [Deprecated] ## 23. ![Optional](https://img.shields.io/badge/Optional-yellow)~~ Property `JSON Schema for Humans configuration file > minify`~~ -| | | -| -------------- | ---------------------------------------------------------- | -| **Type** | `boolean` | -| **Deprecated** | ![Deprecated](https://img.shields.io/badge/Deprecated-red) | -| **Default** | `true` | +| | | +| -------------- | --------- | +| **Type** | `boolean` | +| **Deprecated** | +| ! | [ | D | e | p | r | e | c | a | t | e | d | ] | ( | h | t | t | p | s | : | / | / | i | m | g | . | s | h | i | e | l | d | s | . | i | o | / | b | a | d | g | e | / | D | e | p | r | e | c | a | t | e | d | - | r | e | d | ) | +| **Default** | `true` | **Description:** [Deprecated] ## 24. ![Optional](https://img.shields.io/badge/Optional-yellow)~~ Property `JSON Schema for Humans configuration file > templates_directory`~~ -| | | -| -------------- | ---------------------------------------------------------- | -| **Type** | `string` | -| **Deprecated** | ![Deprecated](https://img.shields.io/badge/Deprecated-red) | +| | | +| -------------- | -------- | +| **Type** | `string` | +| **Deprecated** | +| ! | [ | D | e | p | r | e | c | a | t | e | d | ] | ( | h | t | t | p | s | : | / | / | i | m | g | . | s | h | i | e | l | d | s | . | i | o | / | b | a | d | g | e | / | D | e | p | r | e | c | a | t | e | d | - | r | e | d | ) | **Description:** [Deprecated] diff --git a/docs/examples/examples_md_with_badges/additional_properties.md b/docs/examples/examples_md_with_badges/additional_properties.md index 8a346d00..b7e6fa49 100644 --- a/docs/examples/examples_md_with_badges/additional_properties.md +++ b/docs/examples/examples_md_with_badges/additional_properties.md @@ -10,10 +10,10 @@ **Title:** Person -| | | -| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| **Type** | `object` | -| **Additional properties** | [![Should-conform](https://img.shields.io/badge/Should-conform-blue)](#additionalProperties "Each additional property must conform to the following schema") | +| | | +| ------------------------- | -------------------------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | [![Should-conform](https://img.shields.io/badge/Should-conform-blue)](#additionalProperties) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------- | ------- | ------- | ---------- | ---------- | -------------------------------------------------------------------------- | @@ -24,10 +24,10 @@ ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > subType1` -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | **Description:** A sub type with additionalProperties false. @@ -43,10 +43,10 @@ ## 2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > subType2` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** A sub type with additionalProperties true. @@ -71,10 +71,10 @@ ## 4. Property `Person > additionalProperties` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** additionalProperties schema. diff --git a/docs/examples/examples_md_with_badges/anyOf_option_names.md b/docs/examples/examples_md_with_badges/anyOf_option_names.md index e6e8b268..5f4c2d5e 100644 --- a/docs/examples/examples_md_with_badges/anyOf_option_names.md +++ b/docs/examples/examples_md_with_badges/anyOf_option_names.md @@ -6,10 +6,10 @@ - [1.3. Property `root > storage > anyOf > item 2`](#storage_anyOf_i2) - [1.4. Property `root > storage > anyOf > tmpfs`](#storage_anyOf_i3) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** JSON Schema for an fstab entry @@ -19,10 +19,10 @@ ## 1. ![Required](https://img.shields.io/badge/Required-blue) Property `root > storage` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Any of(Option) | | ------------------------------- | @@ -33,34 +33,34 @@ ### 1.1. Property `root > storage > anyOf > diskDevice` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskDevice | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/diskDevice | ### 1.2. Property `root > storage > anyOf > diskUUID` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskUUID | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/diskUUID | ### 1.3. Property `root > storage > anyOf > item 2` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ### 1.4. Property `root > storage > anyOf > tmpfs` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/tmpfs | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/tmpfs | ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) diff --git a/docs/examples/examples_md_with_badges/array.md b/docs/examples/examples_md_with_badges/array.md index 434e9f4e..30c3a26e 100644 --- a/docs/examples/examples_md_with_badges/array.md +++ b/docs/examples/examples_md_with_badges/array.md @@ -7,10 +7,10 @@ - [2.1.1. Property `root > vegetables > vegetables items > veggieName`](#vegetables_items_veggieName) - [2.1.2. Property `root > vegetables > vegetables items > veggieLike`](#vegetables_items_veggieLike) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** A schema with an array @@ -63,11 +63,11 @@ ### 2.1. root > vegetables > veggie -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/veggie | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/veggie | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | --------------------------------------------- | ------- | ------- | ---------- | ---------- | -------------------------- | diff --git a/docs/examples/examples_md_with_badges/array_additionalItems.md b/docs/examples/examples_md_with_badges/array_additionalItems.md index 8db3e7f4..3d9d5874 100644 --- a/docs/examples/examples_md_with_badges/array_additionalItems.md +++ b/docs/examples/examples_md_with_badges/array_additionalItems.md @@ -9,10 +9,10 @@ - [2.1. root > addressLines > addressLines item 0](#autogenerated_heading_6) - [3. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > arrayEmpty`](#arrayEmpty) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** A little food fun diff --git a/docs/examples/examples_md_with_badges/array_advanced.md b/docs/examples/examples_md_with_badges/array_advanced.md index cafd56b6..f09af08d 100644 --- a/docs/examples/examples_md_with_badges/array_advanced.md +++ b/docs/examples/examples_md_with_badges/array_advanced.md @@ -6,10 +6,10 @@ - [2.1. root > vegetables > vegetables items](#vegetables_items) - [2.2. At least one of the items must be](#autogenerated_heading_2) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** A little food fun @@ -64,10 +64,10 @@ ### 2.1. root > vegetables > vegetables items -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ### 2.2. At least one of the items must be diff --git a/docs/examples/examples_md_with_badges/array_example.md b/docs/examples/examples_md_with_badges/array_example.md index 39d7e0b8..b27b2de8 100644 --- a/docs/examples/examples_md_with_badges/array_example.md +++ b/docs/examples/examples_md_with_badges/array_example.md @@ -3,10 +3,10 @@ - [1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > fruits`](#fruits) - [1.1. root > fruits > fruits items](#fruits_items) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** A schema with an array diff --git a/docs/examples/examples_md_with_badges/basic.md b/docs/examples/examples_md_with_badges/basic.md index 822baab4..9395b4d6 100644 --- a/docs/examples/examples_md_with_badges/basic.md +++ b/docs/examples/examples_md_with_badges/basic.md @@ -9,10 +9,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------- | @@ -57,10 +57,10 @@ ## 4. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > driverLicenseId` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | All of(Requirement) | | ---------------------------------------------- | diff --git a/docs/examples/examples_md_with_badges/break_on_newline.md b/docs/examples/examples_md_with_badges/break_on_newline.md index fab7ccb9..4c429ceb 100644 --- a/docs/examples/examples_md_with_badges/break_on_newline.md +++ b/docs/examples/examples_md_with_badges/break_on_newline.md @@ -4,10 +4,10 @@ **Title:** Hello -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | diff --git a/docs/examples/examples_md_with_badges/broken_ref.md b/docs/examples/examples_md_with_badges/broken_ref.md index bdbd0f92..105974ef 100644 --- a/docs/examples/examples_md_with_badges/broken_ref.md +++ b/docs/examples/examples_md_with_badges/broken_ref.md @@ -5,10 +5,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------- | ------- | ------ | ---------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- | @@ -27,11 +27,11 @@ ## 2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > lastName` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | a_file_that_does_not_exist_and_will_never_i_hope.lol.json | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | a_file_that_does_not_exist_and_will_never_i_hope.lol.json | **Description:** 😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️ diff --git a/docs/examples/examples_md_with_badges/circular.md b/docs/examples/examples_md_with_badges/circular.md index b3df54d7..79661ebc 100644 --- a/docs/examples/examples_md_with_badges/circular.md +++ b/docs/examples/examples_md_with_badges/circular.md @@ -5,10 +5,10 @@ **Title:** Circular reference Schema -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------- | ------- | ------ | ---------- | ------------------ | ----------------- | @@ -16,11 +16,11 @@ ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Circular reference Schema > person` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/a | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/a | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------- | ------- | ------ | ---------- | ------------------ | ------------------ | diff --git a/docs/examples/examples_md_with_badges/combining_not.md b/docs/examples/examples_md_with_badges/combining_not.md index 9b015506..a859b03e 100644 --- a/docs/examples/examples_md_with_badges/combining_not.md +++ b/docs/examples/examples_md_with_badges/combining_not.md @@ -3,10 +3,10 @@ - [1. ![Required](https://img.shields.io/badge/Required-blue) Property `root > not_a_string`](#not_a_string) - [1.1. Must **not** be](#autogenerated_heading_2) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Test schema with a not @@ -16,10 +16,10 @@ ## 1. ![Required](https://img.shields.io/badge/Required-blue) Property `root > not_a_string` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ### 1.1. Must **not** be diff --git a/docs/examples/examples_md_with_badges/combining_oneOf.md b/docs/examples/examples_md_with_badges/combining_oneOf.md index 78c8dcbe..36266842 100644 --- a/docs/examples/examples_md_with_badges/combining_oneOf.md +++ b/docs/examples/examples_md_with_badges/combining_oneOf.md @@ -6,10 +6,10 @@ - [1.3. Property `root > storage > oneOf > nfs`](#storage_oneOf_i2) - [1.4. Property `root > storage > oneOf > tmpfs`](#storage_oneOf_i3) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** JSON Schema for an fstab entry @@ -19,10 +19,10 @@ ## 1. ![Required](https://img.shields.io/badge/Required-blue) Property `root > storage` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | One of(Option) | | ------------------------------- | @@ -33,35 +33,35 @@ ### 1.1. Property `root > storage > oneOf > diskDevice` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskDevice | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/diskDevice | ### 1.2. Property `root > storage > oneOf > diskUUID` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskUUID | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/diskUUID | ### 1.3. Property `root > storage > oneOf > nfs` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/nfs | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/nfs | ### 1.4. Property `root > storage > oneOf > tmpfs` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/tmpfs | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/tmpfs | ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) diff --git a/docs/examples/examples_md_with_badges/conditional_subschema.md b/docs/examples/examples_md_with_badges/conditional_subschema.md index bef16969..9d8447dd 100644 --- a/docs/examples/examples_md_with_badges/conditional_subschema.md +++ b/docs/examples/examples_md_with_badges/conditional_subschema.md @@ -7,10 +7,10 @@ - [3. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > street_address`](#street_address) - [4. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > country`](#country) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------ | ------- | ---------------- | ---------- | ---------- | ----------------- | @@ -19,10 +19,10 @@ ## 1. If (country = "United States of America") -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ----------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -30,10 +30,10 @@ ### 1.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > then > postal_code` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------------------- | @@ -41,10 +41,10 @@ ## 2. Else (i.e. country != "United States of America") -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ----------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -52,10 +52,10 @@ ### 2.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > else > postal_code` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/examples/examples_md_with_badges/conditional_subschema_no_else.md b/docs/examples/examples_md_with_badges/conditional_subschema_no_else.md index df9f0ac5..5c6ebf4e 100644 --- a/docs/examples/examples_md_with_badges/conditional_subschema_no_else.md +++ b/docs/examples/examples_md_with_badges/conditional_subschema_no_else.md @@ -12,10 +12,10 @@ - [4. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > street_address`](#street_address) - [5. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > country`](#country) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------ | ------- | ---------------- | ---------- | ---------- | ----------------- | @@ -30,17 +30,17 @@ ## 1. Property `root > allOf > item 0` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ### 1.1. If (country = "United States of America") -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -48,10 +48,10 @@ #### 1.1.1. Property `root > allOf > item 0 > then > postal_code` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------------------- | @@ -59,17 +59,17 @@ ## 2. Property `root > allOf > item 1` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ### 2.1. If (country = "Canada") -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -77,10 +77,10 @@ #### 2.1.1. Property `root > allOf > item 1 > then > postal_code` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | @@ -88,17 +88,17 @@ ## 3. Property `root > allOf > item 2` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ### 3.1. If (country = "Netherlands") -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -106,10 +106,10 @@ #### 3.1.1. Property `root > allOf > item 2 > then > postal_code` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Restrictions | | | --------------------------------- | --------------------------------------------------------------------------------------------- | diff --git a/docs/examples/examples_md_with_badges/defaults.md b/docs/examples/examples_md_with_badges/defaults.md index 95d79d4f..068e7af4 100644 --- a/docs/examples/examples_md_with_badges/defaults.md +++ b/docs/examples/examples_md_with_badges/defaults.md @@ -3,10 +3,10 @@ - [1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > a`](#a) - [2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > b`](#b) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------- | ------- | ------ | ---------- | ----------------------- | -------------------- | @@ -15,23 +15,23 @@ ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > a` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Default** | `"Default from a"` | -| **Defined in** | #/definitions/common | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Default** | `"Default from a"` | +| **Defined in** | #/definitions/common | **Description:** Description of a ## 2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > b` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Default** | `"Default from b"` | -| **Defined in** | #/definitions/common | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Default** | `"Default from b"` | +| **Defined in** | #/definitions/common | **Description:** A common description diff --git a/docs/examples/examples_md_with_badges/deprecated.md b/docs/examples/examples_md_with_badges/deprecated.md index b4cc4c4b..b17cd78e 100644 --- a/docs/examples/examples_md_with_badges/deprecated.md +++ b/docs/examples/examples_md_with_badges/deprecated.md @@ -6,10 +6,10 @@ - [4. ![Optional](https://img.shields.io/badge/Optional-yellow)~~ Property `root > deprecated4`~~](#deprecated4) - [5. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > not_deprecated`](#not_deprecated) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Test schema with deprecated in description @@ -23,41 +23,45 @@ ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow)~~ Property `root > deprecated1`~~ -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Deprecated** | ![Deprecated](https://img.shields.io/badge/Deprecated-red) | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Deprecated** | +| ! | [ | D | e | p | r | e | c | a | t | e | d | ] | ( | h | t | t | p | s | : | / | / | i | m | g | . | s | h | i | e | l | d | s | . | i | o | / | b | a | d | g | e | / | D | e | p | r | e | c | a | t | e | d | - | r | e | d | ) | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** [Deprecated] ## 2. ![Optional](https://img.shields.io/badge/Optional-yellow)~~ Property `root > deprecated2`~~ -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Deprecated** | ![Deprecated](https://img.shields.io/badge/Deprecated-red) | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Deprecated** | +| ! | [ | D | e | p | r | e | c | a | t | e | d | ] | ( | h | t | t | p | s | : | / | / | i | m | g | . | s | h | i | e | l | d | s | . | i | o | / | b | a | d | g | e | / | D | e | p | r | e | c | a | t | e | d | - | r | e | d | ) | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** [Deprecated - Use `not_deprecated` instead] ## 3. ![Optional](https://img.shields.io/badge/Optional-yellow)~~ Property `root > deprecated3`~~ -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Deprecated** | ![Deprecated](https://img.shields.io/badge/Deprecated-red) | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Deprecated** | +| ! | [ | D | e | p | r | e | c | a | t | e | d | ] | ( | h | t | t | p | s | : | / | / | i | m | g | . | s | h | i | e | l | d | s | . | i | o | / | b | a | d | g | e | / | D | e | p | r | e | c | a | t | e | d | - | r | e | d | ) | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** This is [Deprecated] ## 4. ![Optional](https://img.shields.io/badge/Optional-yellow)~~ Property `root > deprecated4`~~ -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Deprecated** | ![Deprecated](https://img.shields.io/badge/Deprecated-red) | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Deprecated** | +| ! | [ | D | e | p | r | e | c | a | t | e | d | ] | ( | h | t | t | p | s | : | / | / | i | m | g | . | s | h | i | e | l | d | s | . | i | o | / | b | a | d | g | e | / | D | e | p | r | e | c | a | t | e | d | - | r | e | d | ) | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** This is [Deprecated - Use `not_deprecated` instead] diff --git a/docs/examples/examples_md_with_badges/description_from_ref.md b/docs/examples/examples_md_with_badges/description_from_ref.md index bf7396b3..5d93378b 100644 --- a/docs/examples/examples_md_with_badges/description_from_ref.md +++ b/docs/examples/examples_md_with_badges/description_from_ref.md @@ -3,10 +3,10 @@ - [1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > name`](#name) - [2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > alignment`](#alignment) -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------- | ------- | ------ | ---------- | ------------------------------ | ----------------- | diff --git a/docs/examples/examples_md_with_badges/description_markdown.md b/docs/examples/examples_md_with_badges/description_markdown.md index 8f8c1619..2d7aeb91 100644 --- a/docs/examples/examples_md_with_badges/description_markdown.md +++ b/docs/examples/examples_md_with_badges/description_markdown.md @@ -2,10 +2,10 @@ **Title:** Delivery Schema -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** DOC * List 1 diff --git a/docs/examples/examples_md_with_badges/description_with_ref.md b/docs/examples/examples_md_with_badges/description_with_ref.md index 866d6752..b0e736d4 100644 --- a/docs/examples/examples_md_with_badges/description_with_ref.md +++ b/docs/examples/examples_md_with_badges/description_with_ref.md @@ -4,10 +4,10 @@ - [1.1. ![Required](https://img.shields.io/badge/Required-blue) Property `root > outer > inner`](#outer_inner) - [2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > outer2`](#outer2) -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------- | ------- | ------ | ---------- | ----------------------------- | ---------------------- | @@ -16,11 +16,11 @@ ## 1. ![Required](https://img.shields.io/badge/Required-blue) Property `root > outer` -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/inner schema | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Defined in** | #/definitions/inner schema | **Description:** We should see this @@ -38,11 +38,11 @@ ## 2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > outer2` -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Same definition as** | [outer](#outer) | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Same definition as** | [outer](#outer) | **Description:** We should see this too diff --git a/docs/examples/examples_md_with_badges/empty_property_name.md b/docs/examples/examples_md_with_badges/empty_property_name.md index 0c96dea2..47b5edd7 100644 --- a/docs/examples/examples_md_with_badges/empty_property_name.md +++ b/docs/examples/examples_md_with_badges/empty_property_name.md @@ -4,10 +4,10 @@ **Title:** Empty property name -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------ | ------- | ------ | ---------- | ---------- | --------------------------------------------------- | diff --git a/docs/examples/examples_md_with_badges/enumofnone.md b/docs/examples/examples_md_with_badges/enumofnone.md index 6e035863..49971877 100644 --- a/docs/examples/examples_md_with_badges/enumofnone.md +++ b/docs/examples/examples_md_with_badges/enumofnone.md @@ -4,10 +4,10 @@ **Title:** Enum of None -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------- | ------- | -------------- | ---------- | ---------- | ----------------- | diff --git a/docs/examples/examples_md_with_badges/geo.md b/docs/examples/examples_md_with_badges/geo.md index 72ca34a8..e7ccc6f4 100644 --- a/docs/examples/examples_md_with_badges/geo.md +++ b/docs/examples/examples_md_with_badges/geo.md @@ -5,10 +5,10 @@ **Title:** Longitude and Latitude Values -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** A geographical coordinate. diff --git a/docs/examples/examples_md_with_badges/html_in_description.md b/docs/examples/examples_md_with_badges/html_in_description.md index 157e2d89..64b0dd8b 100644 --- a/docs/examples/examples_md_with_badges/html_in_description.md +++ b/docs/examples/examples_md_with_badges/html_in_description.md @@ -6,10 +6,10 @@ **Title:** HTML in descriptions -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------- | diff --git a/docs/examples/examples_md_with_badges/long_description.md b/docs/examples/examples_md_with_badges/long_description.md index 0dd22078..2117af6e 100644 --- a/docs/examples/examples_md_with_badges/long_description.md +++ b/docs/examples/examples_md_with_badges/long_description.md @@ -4,10 +4,10 @@ **Title:** Long description -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------ | ------- | ------ | ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/examples/examples_md_with_badges/multiple_types.md b/docs/examples/examples_md_with_badges/multiple_types.md index 8b37e27a..90f905b1 100644 --- a/docs/examples/examples_md_with_badges/multiple_types.md +++ b/docs/examples/examples_md_with_badges/multiple_types.md @@ -7,10 +7,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------- | ------- | ------------------------------- | ---------- | ---------- | --------------------------------------------------------- | diff --git a/docs/examples/examples_md_with_badges/pattern_properties.md b/docs/examples/examples_md_with_badges/pattern_properties.md index 941396c4..e0e417ab 100644 --- a/docs/examples/examples_md_with_badges/pattern_properties.md +++ b/docs/examples/examples_md_with_badges/pattern_properties.md @@ -8,10 +8,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -46,10 +46,10 @@ must respect the following conditions **Title:** paperSize -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Review of a paper size. diff --git a/docs/examples/examples_md_with_badges/pattern_properties_html_id.md b/docs/examples/examples_md_with_badges/pattern_properties_html_id.md index 9adb0a4a..a574418e 100644 --- a/docs/examples/examples_md_with_badges/pattern_properties_html_id.md +++ b/docs/examples/examples_md_with_badges/pattern_properties_html_id.md @@ -8,10 +8,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -22,10 +22,10 @@ ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > not_a_pattern` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -38,10 +38,10 @@ must respect the following conditions **Title:** Title 4 -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Description 4 @@ -52,10 +52,10 @@ must respect the following conditions **Title:** Title 1 -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Description 1 @@ -66,10 +66,10 @@ must respect the following conditions **Title:** Title 2 -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Description 2 @@ -80,10 +80,10 @@ must respect the following conditions **Title:** Title 3 -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Description 3 diff --git a/docs/examples/examples_md_with_badges/prefixItems.md b/docs/examples/examples_md_with_badges/prefixItems.md index 51aab641..dcec4c95 100644 --- a/docs/examples/examples_md_with_badges/prefixItems.md +++ b/docs/examples/examples_md_with_badges/prefixItems.md @@ -8,10 +8,10 @@ **Title:** Address -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------- | ------- | ----- | ---------- | ---------- | ----------------- | diff --git a/docs/examples/examples_md_with_badges/recursive.md b/docs/examples/examples_md_with_badges/recursive.md index cfe1bdfa..1210919f 100644 --- a/docs/examples/examples_md_with_badges/recursive.md +++ b/docs/examples/examples_md_with_badges/recursive.md @@ -6,10 +6,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------- | ------- | ------ | ---------- | ----------------------- | ----------------- | @@ -17,11 +17,11 @@ ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > person` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/person | **Description:** A human being @@ -51,11 +51,11 @@ #### 1.1.1. Person > person > children > person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [person](#person) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [person](#person) | **Description:** A human being diff --git a/docs/examples/examples_md_with_badges/recursive_array.md b/docs/examples/examples_md_with_badges/recursive_array.md index 0a11beb7..b986965b 100644 --- a/docs/examples/examples_md_with_badges/recursive_array.md +++ b/docs/examples/examples_md_with_badges/recursive_array.md @@ -7,10 +7,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------- | ------- | ----- | ---------- | ---------- | ----------------- | @@ -38,11 +38,11 @@ ### 1.1. Person > person > person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/person | **Description:** A human being @@ -72,11 +72,11 @@ ##### 1.1.1.1. Person > person > person items > children > person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [person_items](#person_items) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [person_items](#person_items) | **Description:** A human being diff --git a/docs/examples/examples_md_with_badges/recursive_full_schema.md b/docs/examples/examples_md_with_badges/recursive_full_schema.md index 45ecb19e..5b807182 100644 --- a/docs/examples/examples_md_with_badges/recursive_full_schema.md +++ b/docs/examples/examples_md_with_badges/recursive_full_schema.md @@ -10,10 +10,10 @@ **Title:** Bug -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Display the issue. @@ -55,11 +55,11 @@ **Title:** Bug -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [Bug](#root) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [Bug](#root) | **Description:** Display the issue. @@ -85,10 +85,10 @@ ### 3.1. Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------ | ------- | ------ | ---------- | --------------------- | ----------------- | @@ -105,11 +105,11 @@ **Title:** Bug -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [Bug](#root) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [Bug](#root) | **Description:** Display the issue. diff --git a/docs/examples/examples_md_with_badges/recursive_full_schema_simple.md b/docs/examples/examples_md_with_badges/recursive_full_schema_simple.md index 6f9dac6a..7309a217 100644 --- a/docs/examples/examples_md_with_badges/recursive_full_schema_simple.md +++ b/docs/examples/examples_md_with_badges/recursive_full_schema_simple.md @@ -4,10 +4,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------- | ------- | ------ | ---------- | ------------------------ | ----------------- | @@ -17,11 +17,11 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [Person](#root) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [Person](#root) | ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) diff --git a/docs/examples/examples_md_with_badges/recursive_parent_in_definition.md b/docs/examples/examples_md_with_badges/recursive_parent_in_definition.md index cf7a0c97..37cef77f 100644 --- a/docs/examples/examples_md_with_badges/recursive_parent_in_definition.md +++ b/docs/examples/examples_md_with_badges/recursive_parent_in_definition.md @@ -7,10 +7,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------- | ------- | ------ | ---------- | ------------------------------------------------ | -------------------------------------------- | @@ -18,11 +18,11 @@ ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > relationships` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person/properties/relationships | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/person/properties/relationships | **Description:** Relationships between this person and others @@ -32,11 +32,11 @@ ### 1.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > relationships > mother` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/person | **Description:** A human being @@ -46,10 +46,10 @@ #### 1.1.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > relationships > mother > relationships` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Relationships between this person and others @@ -59,11 +59,11 @@ ##### 1.1.1.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > relationships > mother > relationships > mother` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [mother](#relationships_mother) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [mother](#relationships_mother) | **Description:** A human being diff --git a/docs/examples/examples_md_with_badges/recursive_two_files.md b/docs/examples/examples_md_with_badges/recursive_two_files.md index 304bcf68..f141dc03 100644 --- a/docs/examples/examples_md_with_badges/recursive_two_files.md +++ b/docs/examples/examples_md_with_badges/recursive_two_files.md @@ -7,10 +7,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------- | ------- | ------ | ---------- | ----------------------- | ----------------- | @@ -18,11 +18,11 @@ ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > person` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/person | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/person | **Description:** A human being @@ -53,21 +53,21 @@ #### 1.1.1. Person > person > children > person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | recursive_two_files2.json#/definitions/person | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | recursive_two_files2.json#/definitions/person | **Description:** Person definition from second file. Not the same! ### 1.2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > person > siblings` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [person_children_items](#person_children_items) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [person_children_items](#person_children_items) | **Description:** Person definition from second file. Not the same! diff --git a/docs/examples/examples_md_with_badges/recursive_two_files2.md b/docs/examples/examples_md_with_badges/recursive_two_files2.md index b2eaf3f0..ea1e519b 100644 --- a/docs/examples/examples_md_with_badges/recursive_two_files2.md +++ b/docs/examples/examples_md_with_badges/recursive_two_files2.md @@ -2,10 +2,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) diff --git a/docs/examples/examples_md_with_badges/ref_merge.md b/docs/examples/examples_md_with_badges/ref_merge.md index ff6935af..948463f9 100644 --- a/docs/examples/examples_md_with_badges/ref_merge.md +++ b/docs/examples/examples_md_with_badges/ref_merge.md @@ -7,10 +7,10 @@ **Title:** Test -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------------ | --------------------- | @@ -35,12 +35,12 @@ Must be one of: ## 2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Test > aDictPropertyARequired` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Default** | `{"a": "a", "b": "b"}` | -| **Defined in** | #/definitions/aDictProperty | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Default** | `{"a": "a", "b": "b"}` | +| **Defined in** | #/definitions/aDictProperty | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | --------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | diff --git a/docs/examples/examples_md_with_badges/ref_with_other_elements.md b/docs/examples/examples_md_with_badges/ref_with_other_elements.md index 16d0fd17..8d3cedc6 100644 --- a/docs/examples/examples_md_with_badges/ref_with_other_elements.md +++ b/docs/examples/examples_md_with_badges/ref_with_other_elements.md @@ -6,10 +6,10 @@ **Title:** OF -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------- | ------- | ------ | ---------- | ------------------- | ----------------- | diff --git a/docs/examples/examples_md_with_badges/ref_with_tabs.md b/docs/examples/examples_md_with_badges/ref_with_tabs.md index fc88429a..62bed704 100644 --- a/docs/examples/examples_md_with_badges/ref_with_tabs.md +++ b/docs/examples/examples_md_with_badges/ref_with_tabs.md @@ -127,10 +127,10 @@ - [2.1.3.5.1. root > objectA > signature > oneOf > item 0 > signers > Signature > excludes > excludes items](#objectA_signature_oneOf_i0_signers_items_excludes_items) - [2.1.3.6. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > value`](#objectA_signature_oneOf_i0_signers_items_value) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -139,10 +139,10 @@ ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > objectA` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------- | ------- | ------ | ---------- | -------------------------- | ----------------- | @@ -152,11 +152,11 @@ **Title:** Signature -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/signature | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/signature | | One of(Option) | | ---------------------------------------- | @@ -166,10 +166,10 @@ #### 1.1.1. Property `root > objectA > signature > oneOf > item 0` -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- | @@ -201,11 +201,11 @@ **Title:** Signature -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/signer | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Defined in** | #/definitions/signer | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------- | @@ -218,10 +218,10 @@ ###### 1.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | One of(Option) | | ------------------------------------------------------------------------- | @@ -279,11 +279,11 @@ Must be one of: **Title:** Public key -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/publicKey | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/publicKey | **Description:** Optional. Public key object. @@ -300,17 +300,17 @@ Must be one of: ###### 1.1.1.1.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 1.1.1.1.1.3.1.1. If (kty = "EC") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -367,17 +367,17 @@ Must be one of: ###### 1.1.1.1.1.3.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 1.1.1.1.1.3.2.1. If (kty = "OKP") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -422,17 +422,17 @@ Must be one of: ###### 1.1.1.1.1.3.3. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 1.1.1.1.1.3.3.1. If (kty = "RSA") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -555,10 +555,10 @@ Must be one of: #### 1.1.2. Property `root > objectA > signature > oneOf > item 1` -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | --------------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- | @@ -590,21 +590,21 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Same definition as** | [Signature](#objectA_signature_oneOf_i0_signers_items) | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Same definition as** | [Signature](#objectA_signature_oneOf_i0_signers_items) | #### 1.1.3. Property `root > objectA > signature > oneOf > Signature` **Title:** Signature -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/signer | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Defined in** | #/definitions/signer | **Description:** Unique top level property for simple signatures. (signaturecore) @@ -619,10 +619,10 @@ Must be one of: ##### 1.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | One of(Option) | | ------------------------------------------------------------------------- | @@ -680,11 +680,11 @@ Must be one of: **Title:** Public key -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/publicKey | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/publicKey | **Description:** Optional. Public key object. @@ -701,17 +701,17 @@ Must be one of: ###### 1.1.3.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 1.1.3.3.1.1. If (kty = "EC") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -768,17 +768,17 @@ Must be one of: ###### 1.1.3.3.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 1.1.3.3.2.1. If (kty = "OKP") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -823,17 +823,17 @@ Must be one of: ###### 1.1.3.3.3. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 1.1.3.3.3.1. If (kty = "RSA") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -956,10 +956,10 @@ Must be one of: ## 2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > objectB` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------- | ------- | ------ | ---------- | -------------------------- | ----------------- | @@ -969,11 +969,11 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/signature | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/signature | | One of(Option) | | ---------------------------------------- | @@ -983,10 +983,10 @@ Must be one of: #### 2.1.1. Property `root > objectA > signature > oneOf > item 0` -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- | @@ -1018,11 +1018,11 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/signer | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Defined in** | #/definitions/signer | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------- | @@ -1035,10 +1035,10 @@ Must be one of: ###### 2.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | One of(Option) | | ------------------------------------------------------------------------- | @@ -1096,11 +1096,11 @@ Must be one of: **Title:** Public key -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/publicKey | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/publicKey | **Description:** Optional. Public key object. @@ -1117,17 +1117,17 @@ Must be one of: ###### 2.1.1.1.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 2.1.1.1.1.3.1.1. If (kty = "EC") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -1184,17 +1184,17 @@ Must be one of: ###### 2.1.1.1.1.3.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 2.1.1.1.1.3.2.1. If (kty = "OKP") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -1239,17 +1239,17 @@ Must be one of: ###### 2.1.1.1.1.3.3. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 2.1.1.1.1.3.3.1. If (kty = "RSA") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -1372,10 +1372,10 @@ Must be one of: #### 2.1.2. Property `root > objectA > signature > oneOf > item 1` -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | --------------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- | @@ -1407,21 +1407,21 @@ Must be one of: **Title:** Signature -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Same definition as** | [Signature](#objectA_signature_oneOf_i0_signers_items) | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Same definition as** | [Signature](#objectA_signature_oneOf_i0_signers_items) | #### 2.1.3. Property `root > objectA > signature > oneOf > Signature` **Title:** Signature -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/signer | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Defined in** | #/definitions/signer | **Description:** Unique top level property for simple signatures. (signaturecore) @@ -1436,10 +1436,10 @@ Must be one of: ##### 2.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | One of(Option) | | ------------------------------------------------------------------------- | @@ -1497,11 +1497,11 @@ Must be one of: **Title:** Public key -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/publicKey | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/publicKey | **Description:** Optional. Public key object. @@ -1518,17 +1518,17 @@ Must be one of: ###### 2.1.3.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 2.1.3.3.1.1. If (kty = "EC") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -1585,17 +1585,17 @@ Must be one of: ###### 2.1.3.3.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 2.1.3.3.2.1. If (kty = "OKP") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | @@ -1640,17 +1640,17 @@ Must be one of: ###### 2.1.3.3.3. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ###### 2.1.3.3.3.1. If (kty = "RSA") -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | diff --git a/docs/examples/examples_md_with_badges/reference_int.md b/docs/examples/examples_md_with_badges/reference_int.md index 8613564e..f25951fb 100644 --- a/docs/examples/examples_md_with_badges/reference_int.md +++ b/docs/examples/examples_md_with_badges/reference_int.md @@ -5,10 +5,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------------------------- | ------- | ------ | ---------- | -------------------------------------- | ---------------------------------------------------------------- | @@ -17,21 +17,21 @@ ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > extra_options_object` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/extra_options/anyOf/0 | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/extra_options/anyOf/0 | **Description:** This is the one ## 2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > name_looks_like_an_int` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/10 | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/10 | **Description:** This is just to be annoying. The property name looks like an int diff --git a/docs/examples/examples_md_with_badges/references.md b/docs/examples/examples_md_with_badges/references.md index eddbaf4a..1ff1f545 100644 --- a/docs/examples/examples_md_with_badges/references.md +++ b/docs/examples/examples_md_with_badges/references.md @@ -20,10 +20,10 @@ - [13. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > multi_hierarchy_reference`](#multi_hierarchy_reference) - [13.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > multi_hierarchy_reference > propertyA`](#multi_hierarchy_reference_propertyA) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Testing $ref @@ -63,11 +63,11 @@ ## 3. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > anchor_with_slash` -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Defined in** | #/definitions/object_def | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Defined in** | #/definitions/object_def | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------ | @@ -126,11 +126,11 @@ ## 7. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > same_file_anchor_no_slash` -| | | -| ------------------------- | -------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| **Same definition as** | [anchor_with_slash](#anchor_with_slash) | +| | | +| ------------------------- | -------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | +| **Same definition as** | [anchor_with_slash](#anchor_with_slash) | ## 8. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > same_file_nested_reference` @@ -141,11 +141,11 @@ ## 9. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > other_file_anchor` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | with_descriptions.json#/definitions/gift | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | with_descriptions.json#/definitions/gift | **Description:** The delivery is a gift, no prices displayed @@ -161,31 +161,31 @@ ## 10. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > other_file_dot_anchor` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [other_file_anchor](#other_file_anchor) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [other_file_anchor](#other_file_anchor) | **Description:** The delivery is a gift, no prices displayed ## 11. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > other_file_dot_dot_anchor` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [other_file_anchor](#other_file_anchor) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [other_file_anchor](#other_file_anchor) | **Description:** The delivery is a gift, no prices displayed ## 12. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > other_file_only` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | combining_not.json | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | combining_not.json | **Description:** Test schema with a not @@ -195,10 +195,10 @@ ### 12.1. ![Required](https://img.shields.io/badge/Required-blue) Property `root > other_file_only > not_a_string` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | #### 12.1.1. Must **not** be @@ -208,11 +208,11 @@ ## 13. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > multi_hierarchy_reference` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | reference_schemas/intermediate.json#/properties/cross_file_reference | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | reference_schemas/intermediate.json#/properties/cross_file_reference | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------------------------- | diff --git a/docs/examples/examples_md_with_badges/references_url.md b/docs/examples/examples_md_with_badges/references_url.md index ca270419..6f3bea7e 100644 --- a/docs/examples/examples_md_with_badges/references_url.md +++ b/docs/examples/examples_md_with_badges/references_url.md @@ -2,10 +2,10 @@ - [1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > firstName`](#firstName) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Testing $ref with URL diff --git a/docs/examples/examples_md_with_badges/references_url_two_levels.md b/docs/examples/examples_md_with_badges/references_url_two_levels.md index 717aa7af..67b36a57 100644 --- a/docs/examples/examples_md_with_badges/references_url_two_levels.md +++ b/docs/examples/examples_md_with_badges/references_url_two_levels.md @@ -4,10 +4,10 @@ - [1.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > described > name`](#described_name) - [1.2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > described > alignment`](#described_alignment) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Testing $ref of a remote $ref @@ -20,7 +20,7 @@ | | | | ------------------------- | -------------------------------------------------------------------------------------------------------------------- | | **Type** | `object` | -| **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | +| **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | **Defined in** | https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/description_from_ref.json | | Property | Pattern | Type | Deprecated | Definition | Title/Description | diff --git a/docs/examples/examples_md_with_badges/references_url_yaml.md b/docs/examples/examples_md_with_badges/references_url_yaml.md index 69f94761..5486270c 100644 --- a/docs/examples/examples_md_with_badges/references_url_yaml.md +++ b/docs/examples/examples_md_with_badges/references_url_yaml.md @@ -5,10 +5,10 @@ - [1.2. ![Required](https://img.shields.io/badge/Required-blue) Property `root > address > city`](#address_city) - [1.3. ![Required](https://img.shields.io/badge/Required-blue) Property `root > address > state`](#address_state) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Testing $ref with URL with YAML destination @@ -18,11 +18,11 @@ ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > address` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/yaml.yaml#/definitions/address | +| | | +| ------------------------- | ------------------------------------------------------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/yaml.yaml#/definitions/address | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | diff --git a/docs/examples/examples_md_with_badges/required_properties_order.md b/docs/examples/examples_md_with_badges/required_properties_order.md index 8f796ea2..fb7c959a 100644 --- a/docs/examples/examples_md_with_badges/required_properties_order.md +++ b/docs/examples/examples_md_with_badges/required_properties_order.md @@ -7,10 +7,10 @@ **Title:** Undocumented Required Properties order -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -19,10 +19,10 @@ ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Undocumented Required Properties order > group1` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ### 1.1. The following properties are required * a @@ -30,10 +30,10 @@ ## 2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Undocumented Required Properties order > group2` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | ### 2.1. The following properties are required * b diff --git a/docs/examples/examples_md_with_badges/single_element_allOf.md b/docs/examples/examples_md_with_badges/single_element_allOf.md index b33e79c9..1e391f35 100644 --- a/docs/examples/examples_md_with_badges/single_element_allOf.md +++ b/docs/examples/examples_md_with_badges/single_element_allOf.md @@ -5,10 +5,10 @@ **Title:** Schema containing a single-element allOf -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Schema containing a single-element allOf diff --git a/docs/examples/examples_md_with_badges/top_level_combining.md b/docs/examples/examples_md_with_badges/top_level_combining.md index c8437007..60719382 100644 --- a/docs/examples/examples_md_with_badges/top_level_combining.md +++ b/docs/examples/examples_md_with_badges/top_level_combining.md @@ -7,10 +7,10 @@ **Title:** Combining at top level -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** For the combine @@ -23,35 +23,35 @@ ## 1. Property `Combining at top level > oneOf > diskDevice` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskDevice | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/diskDevice | ## 2. Property `Combining at top level > oneOf > diskUUID` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/diskUUID | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/diskUUID | ## 3. Property `Combining at top level > oneOf > nfs` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/nfs | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/nfs | ## 4. Property `Combining at top level > oneOf > tmpfs` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/tmpfs | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/tmpfs | ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) diff --git a/docs/examples/examples_md_with_badges/type_object_null.md b/docs/examples/examples_md_with_badges/type_object_null.md index 431cdc84..91050351 100644 --- a/docs/examples/examples_md_with_badges/type_object_null.md +++ b/docs/examples/examples_md_with_badges/type_object_null.md @@ -5,10 +5,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------ | ------- | -------------- | ---------- | ---------- | ----------------- | diff --git a/docs/examples/examples_md_with_badges/with_default.md b/docs/examples/examples_md_with_badges/with_default.md index e136702d..6279a893 100644 --- a/docs/examples/examples_md_with_badges/with_default.md +++ b/docs/examples/examples_md_with_badges/with_default.md @@ -7,10 +7,10 @@ **Title:** User Preference -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------------------ | ------- | ------------------------- | ---------- | ---------- | ----------------- | diff --git a/docs/examples/examples_md_with_badges/with_definitions.md b/docs/examples/examples_md_with_badges/with_definitions.md index 8aa193c1..834659ba 100644 --- a/docs/examples/examples_md_with_badges/with_definitions.md +++ b/docs/examples/examples_md_with_badges/with_definitions.md @@ -7,10 +7,10 @@ - [1.4. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > billing_address > futureProperty`](#billing_address_futureProperty) - [2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > shipping_address`](#shipping_address) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------------- | ------- | ------ | ---------- | -------------------------------------------- | ----------------- | @@ -19,11 +19,11 @@ ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > billing_address` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/address | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/address | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -58,11 +58,11 @@ ## 2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > shipping_address` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [billing_address](#billing_address) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [billing_address](#billing_address) | ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) diff --git a/docs/examples/examples_md_with_badges/with_descriptions.md b/docs/examples/examples_md_with_badges/with_descriptions.md index 7a9ac6f7..52bc2b6b 100644 --- a/docs/examples/examples_md_with_badges/with_descriptions.md +++ b/docs/examples/examples_md_with_badges/with_descriptions.md @@ -13,10 +13,10 @@ **Title:** Delivery Schema -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------------- | ------- | ------ | ---------- | ---------------------------------------------- | -------------------------------------------- | @@ -26,11 +26,11 @@ ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Delivery Schema > shipping_address` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/address | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/address | **Description:** Exact address @@ -60,21 +60,21 @@ ## 2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Delivery Schema > billing_address` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Same definition as** | [shipping_address](#shipping_address) | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Same definition as** | [shipping_address](#shipping_address) | **Description:** Exact address ## 3. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Delivery Schema > delivery_info` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `combining` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/delivery_info | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `combining` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/delivery_info | **Description:** Delivery info depending on the delivery type @@ -85,11 +85,11 @@ ### 3.1. Property `Delivery Schema > delivery_info > oneOf > classic` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/classic | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/classic | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ----------------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | @@ -103,11 +103,11 @@ ### 3.2. Property `Delivery Schema > delivery_info > oneOf > gift` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/gift | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/gift | **Description:** The delivery is a gift, no prices displayed diff --git a/docs/examples/examples_md_with_badges/with_examples.md b/docs/examples/examples_md_with_badges/with_examples.md index dd081d37..55a4d02b 100644 --- a/docs/examples/examples_md_with_badges/with_examples.md +++ b/docs/examples/examples_md_with_badges/with_examples.md @@ -7,10 +7,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------- | ------- | ------- | ---------- | ---------- | ----------------------------------- | @@ -77,10 +77,10 @@ ## 4. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > moreInfo` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** Any more info you want as an object diff --git a/docs/examples/examples_md_with_badges/with_keywords.md b/docs/examples/examples_md_with_badges/with_keywords.md index cc7d282f..337f1b3a 100644 --- a/docs/examples/examples_md_with_badges/with_keywords.md +++ b/docs/examples/examples_md_with_badges/with_keywords.md @@ -14,10 +14,10 @@ **Title:** Person -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ------------------------------------------ | ------- | ------ | ---------- | ---------- | ----------------- | @@ -51,82 +51,82 @@ ## 3. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > if` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** if ## 4. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > then` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** then ## 5. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > else` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** else ## 6. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > anyOf` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** anyOf ## 7. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > allOf` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** allOf ## 8. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > not` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** not ## 9. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > properties` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** properties ## 10. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > patternProperties` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** patternProperties ## 11. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > required` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | **Description:** required diff --git a/docs/examples/examples_md_with_badges/with_special_chars.md b/docs/examples/examples_md_with_badges/with_special_chars.md index 6329ca1a..2e522d9a 100644 --- a/docs/examples/examples_md_with_badges/with_special_chars.md +++ b/docs/examples/examples_md_with_badges/with_special_chars.md @@ -9,10 +9,10 @@ **Title:** Personne -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ----------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------------------------------------------- | diff --git a/docs/examples/examples_md_with_badges/with_urlencoded_anchor.md b/docs/examples/examples_md_with_badges/with_urlencoded_anchor.md index 4b3081cc..8fe99f9d 100644 --- a/docs/examples/examples_md_with_badges/with_urlencoded_anchor.md +++ b/docs/examples/examples_md_with_badges/with_urlencoded_anchor.md @@ -6,10 +6,10 @@ - [1.2.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > signingTimeInfo > signingTimeBounds > lowerBound`](#signingTimeInfo_signingTimeBounds_lowerBound) - [1.2.2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > signingTimeInfo > signingTimeBounds > upperBound`](#signingTimeInfo_signingTimeBounds_upperBound) -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------------------- | ------- | ------ | ---------- | ----------------------------------------- | ----------------- | @@ -17,11 +17,11 @@ ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > signingTimeInfo` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/dss2-SigningTimeInfoType | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/dss2-SigningTimeInfoType | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | ---------------------------------------------------------- | ------- | ------- | ---------- | ----------------------------------------------------------------- | ----------------- | @@ -37,11 +37,11 @@ ### 1.2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > signingTimeInfo > signingTimeBounds` -| | | -| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| **Defined in** | #/definitions/dss2-SigningTimeInfoType%3ASigningTimeBoundaries | +| | | +| ------------------------- | --------------------------------------------------------------------------- | +| **Type** | `object` | +| **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | +| **Defined in** | #/definitions/dss2-SigningTimeInfoType%3ASigningTimeBoundaries | | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------------------------------------------- | ------- | ------- | ---------- | ---------- | ----------------- | diff --git a/json_schema_for_humans/generation_configuration.py b/json_schema_for_humans/generation_configuration.py index 1031eede..40896d13 100644 --- a/json_schema_for_humans/generation_configuration.py +++ b/json_schema_for_humans/generation_configuration.py @@ -132,6 +132,10 @@ def template_path(self) -> Path: / f"base.{DocumentationTemplate(self.template_name).result_extension}" ) + @property + def md_badge_as_image(self) -> bool: + return (self.template_md_options or {}).get("badge_as_image") is True + CONFIG_DEPRECATION_MESSAGE = ( "JSON Schema for humans: Please supply a GenerationConfiguration object instead of individual options" diff --git a/json_schema_for_humans/md_template.py b/json_schema_for_humans/md_template.py index f98ed26f..e751e90b 100644 --- a/json_schema_for_humans/md_template.py +++ b/json_schema_for_humans/md_template.py @@ -30,7 +30,7 @@ def get_numeric_maximum_restriction(schema_node: SchemaNode, default: str = "N/A def escape_for_table(example_text: Optional[str]) -> str: - """Filter. escape characters('|', '`') in string to be inserted into markdown table""" + """Filter. escape characters('|', '`') in string to be inserted into Markdown table""" if example_text is None: return "" return example_text.translate(str.maketrans({"|": "\\|", "`": "\\`", "\n": "
"})) # type:ignore[arg-type] @@ -181,6 +181,20 @@ def __init__(self, config): self.toc = {} self.config = config + self.should_conform_badge = self.badge("Should-conform", "blue") + if self.config.md_badge_as_image: + self.badge_not_allowed = self.badge("Not allowed", "red") + self.badge_allowed = self.badge("Any type", "green", "allowed") + self.deprecated_badge = self.badge("Deprecated", "red") + self.required_badge = self.badge("Required", "blue") + self.optional_badge = self.badge("Optional", "yellow") + else: + self.badge_not_allowed = "Not allowed" + self.badge_allowed = "Any type allowed" + self.deprecated_badge = "Deprecated" + self.required_badge = "" + self.optional_badge = "" + def register_jinja(self, env: jinja2.Environment): env.filters["md_get_numeric_minimum_restriction"] = get_numeric_minimum_restriction env.filters["md_get_numeric_maximum_restriction"] = get_numeric_maximum_restriction @@ -194,7 +208,8 @@ def register_jinja(self, env: jinja2.Environment): env.filters["md_restrictions_table"] = restrictions_table env.filters["md_generate_table"] = generate_table - env.globals["md_badge"] = self.badge + env.globals["required_badge"] = self.required_badge + env.globals["optional_badge"] = self.optional_badge env.globals["md_get_toc"] = self.get_toc def heading(self, title: str, depth: int, html_id: Union[bool, str] = False, nested: bool = False) -> str: @@ -285,30 +300,21 @@ def format_link(title: str, link: str, tooltip: str = "") -> str: """Format a Markdown link""" return f"[{title}](#{link} {tooltip})" - def badge(self, name: str, color: str, value: str = "", show_text: bool = False, fallback: bool = True) -> str: + def badge(self, name: str, color: str, value: str = "") -> str: """ - Badge as markdown image link if badge_as_image option set otherwise Badge as text. - - If fallback is False, nothing will be returned if badge_as_image is false. + Badge as markdown image link """ - show_image = self.config.template_md_options.get("badge_as_image") - if not show_image and not fallback: - return "" - if value: text_badge = f"{name}: {value}" else: text_badge = name - if show_image and not show_text: - value_str = "" - if value: - value_str = "-" + quote(value) - name = quote(name) - color = quote(color) - return f"![{text_badge}](https://img.shields.io/badge/{name}{value_str}-{color})" - else: - return f"[{text_badge}]" + value_str = "" + if value: + value_str = "-" + quote(value) + name = quote(name) + color = quote(color) + return f"![{text_badge}](https://img.shields.io/badge/{name}{value_str}-{color})" def properties_table(self, schema: SchemaNode) -> List[List]: """ @@ -337,9 +343,7 @@ def properties_table(self, schema: SchemaNode) -> List[List]: ) elif field == "Deprecated": # Deprecated - line.append( - self.badge("Deprecated", "red") if jinja_filters.deprecated(self.config, sub_property) else "No" - ) + line.append(self.deprecated_badge if jinja_filters.deprecated(self.config, sub_property) else "No") elif field == "Definition": # Link if sub_property.should_be_a_link(self.config): @@ -392,10 +396,12 @@ def type_info_table(self, schema: SchemaNode) -> List[List]: type_info.append( ["**Type**", "`combining`" if jinja_filters.is_combining(merged_schema) else f"`{schema_type}`"] ) - if not self.config.template_md_options.get("badge_as_image"): + if not self.config.md_badge_as_image: type_info.append(["**Required**", "Yes" if schema.is_required_property else "No"]) if jinja_filters.deprecated(self.config, merged_schema): - type_info.append(["**Deprecated**", self.badge("Deprecated", "red")]) + type_info.append(["**Deprecated**"]) + if self.config.md_badge_as_image: + type_info.append(self.deprecated_badge) if schema_format: type_info.append(["**Format**", f"`{schema_format}`"]) @@ -416,25 +422,25 @@ def type_info_table(self, schema: SchemaNode) -> List[List]: def additional_properties(self, schema: SchemaNode) -> str: """additional properties badge generation""" additional_properties = "" + for sub_property in schema.iterate_properties: if sub_property.is_additional_properties: if sub_property.is_additional_properties_schema: html_id = sub_property.html_id - should_conform_badge = self.badge("Should-conform", "blue") - additional_properties = f'[{should_conform_badge}](#{html_id} "Each additional property must conform to the following schema")' + if self.config.md_badge_as_image: + additional_properties = f"[{self.should_conform_badge}](#{html_id})" + else: + additional_properties = f"[Each additional property must conform to the schema](#{html_id})" break else: - badge_any_type = self.badge("Any type", "green", "allowed") - additional_properties = f'[{badge_any_type}](# "Additional Properties of any type are allowed.")' + additional_properties = self.badge_allowed break if not additional_properties: if schema.explicit_no_additional_properties: - badge_not_allowed = self.badge("Not allowed", "red") - additional_properties = f'[{badge_not_allowed}](# "Additional Properties not allowed.")' + additional_properties = self.badge_not_allowed else: - badge_allowed = self.badge("Any type", "green", "allowed") - additional_properties = f'[{badge_allowed}](# "Additional Properties of any type are allowed.")' + additional_properties = self.badge_allowed return additional_properties diff --git a/json_schema_for_humans/templates/md/section_properties_details.md b/json_schema_for_humans/templates/md/section_properties_details.md index f5554d1c..84468297 100644 --- a/json_schema_for_humans/templates/md/section_properties_details.md +++ b/json_schema_for_humans/templates/md/section_properties_details.md @@ -9,12 +9,12 @@ {% filter md_heading(depth + 1, html_id) -%} {%- filter replace('\n', '') -%} - {%- if not skip_required and sub_property.property_name -%} - {{ md_badge("Required", "blue", fallback=False) if sub_property.is_required_property else md_badge("Optional", "yellow", fallback=False) -}} - {%- endif -%} - {%- if sub_property is deprecated -%}~~{%- endif -%} - {%- if sub_property.is_pattern_property %} Pattern{% endif %} Property `{% with schema=sub_property %}{%- include "breadcrumbs.md" %}{% endwith %}` - {%- if sub_property is deprecated -%}~~{%- endif -%} + {%- if not skip_required and sub_property.property_name -%} + {{ required_badge if sub_property.is_required_property else optional_badge -}} + {%- endif -%} + {%- if sub_property is deprecated -%}~~{%- endif -%} + {%- if sub_property.is_pattern_property %} Pattern{% endif %} Property `{% with schema=sub_property %}{%- include "breadcrumbs.md" %}{% endwith %}` + {%- if sub_property is deprecated -%}~~{%- endif -%} {%- endfilter %} {%- endfilter %} 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 6143144e..2fa96fff 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 @@ -8,14 +8,14 @@ {% set description = sub_property | get_description %}
- {% 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) -}} - {%- endif -%} - {%- if sub_property is deprecated -%}~~{%- endif -%} - {%- if sub_property.is_pattern_property %}Pattern{% endif %} Property {% with schema=sub_property %}{%- include "breadcrumbs.md" %}{% endwith %} - {%- if sub_property is deprecated -%}~~{%- endif -%} + {% filter md_heading(depth + 1, html_id, True) -%} + {%- filter replace('\n', '') -%} + {%- if not skip_required and sub_property.property_name -%} + {{ "[Required]" if sub_property.is_required_property else "[Optional]" -}} + {%- endif -%} + {%- if sub_property is deprecated -%}~~{%- endif -%} + {%- if sub_property.is_pattern_property %}Pattern{% endif %} Property {% with schema=sub_property %}{%- include "breadcrumbs.md" %}{% endwith %} + {%- if sub_property is deprecated -%}~~{%- endif -%} {%- endfilter %} {%- endfilter %}