From b1b2bbc0aa563c74b54851b7f2e05262925feba4 Mon Sep 17 00:00:00 2001 From: Elvis Stansvik Date: Fri, 29 Nov 2024 16:02:42 +0100 Subject: [PATCH 1/2] Look up property title by following references Closes #278 --- docs/examples/cases/ref_merge.json | 1 + .../examples_flat_default/Configuration.html | 2 +- .../recursive_full_schema.html | 2 +- .../examples_flat_default/ref_with_tabs.html | 8 +- .../examples_js_default/Configuration.html | 2 +- .../recursive_full_schema.html | 4 +- .../recursive_full_schema_simple.html | 2 +- .../examples_js_default/ref_merge.html | 2 +- .../examples_js_default/ref_with_tabs.html | 40 +-- .../examples_js_default/references_url.html | 2 +- .../Configuration.html | 2 +- .../recursive_full_schema.html | 4 +- .../recursive_full_schema_simple.html | 2 +- .../ref_merge.html | 2 +- .../ref_with_tabs.html | 40 +-- .../references_url.html | 2 +- .../examples_md_default/Configuration.md | 12 +- .../recursive_full_schema.md | 18 +- .../recursive_full_schema_simple.md | 4 +- .../examples/examples_md_default/ref_merge.md | 10 +- .../examples_md_default/ref_with_tabs.md | 240 ++++++++++-------- .../examples_md_default/references_url.md | 8 +- .../Configuration.md | 12 +- .../recursive_full_schema.md | 10 +- .../recursive_full_schema_simple.md | 2 + .../examples_md_nested_default/ref_merge.md | 2 + .../ref_with_tabs.md | 80 ++++-- .../references_url.md | 2 + .../Configuration.md | 2 +- .../recursive_full_schema.md | 10 +- .../recursive_full_schema_simple.md | 2 + .../ref_merge.md | 2 + .../ref_with_tabs.md | 80 ++++-- .../references_url.md | 2 + .../examples_md_with_badges/Configuration.md | 2 +- .../recursive_full_schema.md | 18 +- .../recursive_full_schema_simple.md | 4 +- .../examples_md_with_badges/ref_merge.md | 10 +- .../examples_md_with_badges/ref_with_tabs.md | 240 ++++++++++-------- .../examples_md_with_badges/references_url.md | 8 +- json_schema_for_humans/schema/schema_node.py | 27 +- json_schema_for_humans/templating_utils.py | 25 ++ tests/generate_test.py | 1 + tests/html_schema_doc_asserts.py | 10 + 44 files changed, 589 insertions(+), 371 deletions(-) diff --git a/docs/examples/cases/ref_merge.json b/docs/examples/cases/ref_merge.json index d55868c3..868f95ed 100644 --- a/docs/examples/cases/ref_merge.json +++ b/docs/examples/cases/ref_merge.json @@ -21,6 +21,7 @@ }, "definitions": { "aProperty": { + "title": "Title from definition", "default": "Default from definition", "type": "string", "enum": [ diff --git a/docs/examples/examples_flat_default/Configuration.html b/docs/examples/examples_flat_default/Configuration.html index a80b412b..42270103 100644 --- a/docs/examples/examples_flat_default/Configuration.html +++ b/docs/examples/examples_flat_default/Configuration.html @@ -771,7 +771,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - markdown_optionsType: object Default: {"fenced-code-blocks": {"break-on-newline": true, "cssclass": "highlight jumbotron", "tables": null}, "tables": null}
+ markdown_optionsType: object Default: {"fenced-code-blocks": {"cssclass": "highlight jumbotron"}, "tables": null, "break-on-newline": true}
diff --git a/docs/examples/examples_flat_default/recursive_full_schema.html b/docs/examples/examples_flat_default/recursive_full_schema.html index 37d99f6e..a04a2978 100644 --- a/docs/examples/examples_flat_default/recursive_full_schema.html +++ b/docs/examples/examples_flat_default/recursive_full_schema.html @@ -125,7 +125,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - #Type: object
+ BugType: object
diff --git a/docs/examples/examples_flat_default/ref_with_tabs.html b/docs/examples/examples_flat_default/ref_with_tabs.html index 4f628168..af87bae1 100644 --- a/docs/examples/examples_flat_default/ref_with_tabs.html +++ b/docs/examples/examples_flat_default/ref_with_tabs.html @@ -268,7 +268,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - signerType: object
+ SignatureType: object
@@ -3758,7 +3758,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - signerType: object
+ SignatureType: object
@@ -7383,7 +7383,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - signerType: object
+ SignatureType: object
@@ -10873,7 +10873,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - signerType: object
+ SignatureType: object
diff --git a/docs/examples/examples_js_default/Configuration.html b/docs/examples/examples_js_default/Configuration.html index 44544bd6..13ac7569 100644 --- a/docs/examples/examples_js_default/Configuration.html +++ b/docs/examples/examples_js_default/Configuration.html @@ -735,7 +735,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - markdown_optionsType: object Default: {"fenced-code-blocks": {"break-on-newline": true, "cssclass": "highlight jumbotron", "tables": null}, "tables": null}
+ markdown_optionsType: object Default: {"fenced-code-blocks": {"cssclass": "highlight jumbotron"}, "tables": null, "break-on-newline": true}

Markdown 2 options for the descriptions. description_is_markdown must be true for this to have any effect.

diff --git a/docs/examples/examples_js_default/recursive_full_schema.html b/docs/examples/examples_js_default/recursive_full_schema.html index 3063e2cc..22a953c8 100644 --- a/docs/examples/examples_js_default/recursive_full_schema.html +++ b/docs/examples/examples_js_default/recursive_full_schema.html @@ -111,7 +111,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - #

Type: object
+ Bug

Bug

Type: object

Display the issue.

Same definition as Bug @@ -258,7 +258,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - TheThingType: object
+ TheThing

Bug

Type: object

Display the issue.

Same definition as Bug diff --git a/docs/examples/examples_js_default/recursive_full_schema_simple.html b/docs/examples/examples_js_default/recursive_full_schema_simple.html index 484658ae..fd55a91e 100644 --- a/docs/examples/examples_js_default/recursive_full_schema_simple.html +++ b/docs/examples/examples_js_default/recursive_full_schema_simple.html @@ -49,7 +49,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - itselfType: object
+ itself

Person

Type: object
Same definition as Person diff --git a/docs/examples/examples_js_default/ref_merge.html b/docs/examples/examples_js_default/ref_merge.html index 326ab53d..b389d447 100644 --- a/docs/examples/examples_js_default/ref_merge.html +++ b/docs/examples/examples_js_default/ref_merge.html @@ -49,7 +49,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - aPropertyType: enum (of string) Default: "Default from property"
+ aProperty

Title from definition

Type: enum (of string) Default: "Default from property"

This is the description from the definition

diff --git a/docs/examples/examples_js_default/ref_with_tabs.html b/docs/examples/examples_js_default/ref_with_tabs.html index 3ff957e1..fb997869 100644 --- a/docs/examples/examples_js_default/ref_with_tabs.html +++ b/docs/examples/examples_js_default/ref_with_tabs.html @@ -248,7 +248,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - signerType: object
+ Signature

Signature

Type: object
No Additional Properties @@ -1117,7 +1117,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -1901,7 +1901,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -2581,7 +2581,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -2880,7 +2880,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

@@ -3502,7 +3502,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - signerType: object
+ Signature

Signature

Type: object
Same definition as Signature @@ -4412,7 +4412,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -5196,7 +5196,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -5876,7 +5876,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -6175,7 +6175,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

@@ -6884,7 +6884,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - signerType: object
+ Signature

Signature

Type: object
No Additional Properties @@ -7753,7 +7753,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -8537,7 +8537,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -9217,7 +9217,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -9516,7 +9516,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

@@ -10138,7 +10138,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - signerType: object
+ Signature

Signature

Type: object
Same definition as Signature @@ -11048,7 +11048,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -11832,7 +11832,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -12512,7 +12512,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -12811,7 +12811,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

diff --git a/docs/examples/examples_js_default/references_url.html b/docs/examples/examples_js_default/references_url.html index b194fd23..3d52ee10 100644 --- a/docs/examples/examples_js_default/references_url.html +++ b/docs/examples/examples_js_default/references_url.html @@ -48,7 +48,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - firstNameType: string
+ firstName

Person

Type: string

The person's first name.

diff --git a/docs/examples/examples_js_offline_default/Configuration.html b/docs/examples/examples_js_offline_default/Configuration.html index cd52d516..d6682a62 100644 --- a/docs/examples/examples_js_offline_default/Configuration.html +++ b/docs/examples/examples_js_offline_default/Configuration.html @@ -735,7 +735,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - markdown_optionsType: object Default: {"fenced-code-blocks": {"break-on-newline": true, "cssclass": "highlight jumbotron", "tables": null}, "tables": null}
+ markdown_optionsType: object Default: {"fenced-code-blocks": {"cssclass": "highlight jumbotron"}, "tables": null, "break-on-newline": true}

Markdown 2 options for the descriptions. description_is_markdown must be true for this to have any effect.

diff --git a/docs/examples/examples_js_offline_default/recursive_full_schema.html b/docs/examples/examples_js_offline_default/recursive_full_schema.html index 5a92e4bd..cf3a923d 100644 --- a/docs/examples/examples_js_offline_default/recursive_full_schema.html +++ b/docs/examples/examples_js_offline_default/recursive_full_schema.html @@ -111,7 +111,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - #

Type: object
+ Bug

Bug

Type: object

Display the issue.

Same definition as Bug @@ -258,7 +258,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - TheThingType: object
+ TheThing

Bug

Type: object

Display the issue.

Same definition as Bug diff --git a/docs/examples/examples_js_offline_default/recursive_full_schema_simple.html b/docs/examples/examples_js_offline_default/recursive_full_schema_simple.html index cfc01262..28fd6e42 100644 --- a/docs/examples/examples_js_offline_default/recursive_full_schema_simple.html +++ b/docs/examples/examples_js_offline_default/recursive_full_schema_simple.html @@ -49,7 +49,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - itselfType: object
+ itself

Person

Type: object
Same definition as Person diff --git a/docs/examples/examples_js_offline_default/ref_merge.html b/docs/examples/examples_js_offline_default/ref_merge.html index e6152c0c..e5b779a5 100644 --- a/docs/examples/examples_js_offline_default/ref_merge.html +++ b/docs/examples/examples_js_offline_default/ref_merge.html @@ -49,7 +49,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - aPropertyType: enum (of string) Default: "Default from property"
+ aProperty

Title from definition

Type: enum (of string) Default: "Default from property"

This is the description from the definition

diff --git a/docs/examples/examples_js_offline_default/ref_with_tabs.html b/docs/examples/examples_js_offline_default/ref_with_tabs.html index 90a4a5cf..910ae8bc 100644 --- a/docs/examples/examples_js_offline_default/ref_with_tabs.html +++ b/docs/examples/examples_js_offline_default/ref_with_tabs.html @@ -248,7 +248,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - signerType: object
+ Signature

Signature

Type: object
No Additional Properties @@ -1117,7 +1117,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -1901,7 +1901,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -2581,7 +2581,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -2880,7 +2880,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

@@ -3502,7 +3502,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - signerType: object
+ Signature

Signature

Type: object
Same definition as Signature @@ -4412,7 +4412,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -5196,7 +5196,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -5876,7 +5876,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -6175,7 +6175,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

@@ -6884,7 +6884,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - signerType: object
+ Signature

Signature

Type: object
No Additional Properties @@ -7753,7 +7753,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -8537,7 +8537,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -9217,7 +9217,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -9516,7 +9516,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

@@ -10138,7 +10138,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - signerType: object
+ Signature

Signature

Type: object
Same definition as Signature @@ -11048,7 +11048,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -11832,7 +11832,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -12512,7 +12512,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

Same definition as kty @@ -12811,7 +12811,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - ktyType: enum (of string)
+ kty

Key type

Type: enum (of string)

Key type indicator.

diff --git a/docs/examples/examples_js_offline_default/references_url.html b/docs/examples/examples_js_offline_default/references_url.html index 3c81aec2..484bc349 100644 --- a/docs/examples/examples_js_offline_default/references_url.html +++ b/docs/examples/examples_js_offline_default/references_url.html @@ -48,7 +48,7 @@

d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z" /> - firstNameType: string
+ firstName

Person

Type: string

The person's first name.

diff --git a/docs/examples/examples_md_default/Configuration.md b/docs/examples/examples_md_default/Configuration.md index 094df877..af25c532 100644 --- a/docs/examples/examples_md_default/Configuration.md +++ b/docs/examples/examples_md_default/Configuration.md @@ -286,12 +286,12 @@ This is the old behaviour and is only needed for browsers that do not support HT ## 19. Property `JSON Schema for Humans configuration file > markdown_options` -| | | -| ------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| **Type** | `object` | -| **Required** | No | -| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| **Default** | `{"fenced-code-blocks": {"break-on-newline": true, "cssclass": "highlight jumbotron", "tables": null}, "tables": null}` | +| | | +| ------------------------- | ------------------------------------------------------------------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `{"fenced-code-blocks": {"cssclass": "highlight jumbotron"}, "tables": null, "break-on-newline": true}` | **Description:** [Markdown 2 options](https://github.com/trentm/python-markdown2/wiki/Extras) for the descriptions. `description_is_markdown` must be true for this to have any effect. diff --git a/docs/examples/examples_md_default/recursive_full_schema.md b/docs/examples/examples_md_default/recursive_full_schema.md index 5e576114..0d98cb87 100644 --- a/docs/examples/examples_md_default/recursive_full_schema.md +++ b/docs/examples/examples_md_default/recursive_full_schema.md @@ -2,7 +2,7 @@ - [1. Property `Bug > Code`](#Code) - [2. Property `Bug > RecursiveArray`](#RecursiveArray) - - [2.1. Bug > RecursiveArray > #](#RecursiveArray_items) + - [2.1. Bug > RecursiveArray > Bug](#RecursiveArray_items) - [3. Property `Bug > DecoratedRecursiveArray`](#DecoratedRecursiveArray) - [3.1. Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items](#DecoratedRecursiveArray_items) - [3.1.1. Property `Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > SomeName`](#DecoratedRecursiveArray_items_SomeName) @@ -52,9 +52,11 @@ | Each item of this array must be | Description | | ------------------------------- | ------------------ | -| [#](#RecursiveArray_items) | Display the issue. | +| [Bug](#RecursiveArray_items) | Display the issue. | -### 2.1. Bug > RecursiveArray > # +### 2.1. Bug > RecursiveArray > Bug + +**Title:** Bug | | | | ------------------------- | ------------------------------------------------------------------------- | @@ -94,10 +96,10 @@ | **Required** | No | | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------ | ------- | ------ | ---------- | --------------------- | ------------------ | -| - [SomeName](#DecoratedRecursiveArray_items_SomeName ) | No | string | No | - | - | -| - [TheThing](#DecoratedRecursiveArray_items_TheThing ) | No | object | No | Same as [Bug](#root ) | Display the issue. | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------ | ------- | ------ | ---------- | --------------------- | ----------------- | +| - [SomeName](#DecoratedRecursiveArray_items_SomeName ) | No | string | No | - | - | +| - [TheThing](#DecoratedRecursiveArray_items_TheThing ) | No | object | No | Same as [Bug](#root ) | Bug | #### 3.1.1. Property `Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > SomeName` @@ -108,6 +110,8 @@ #### 3.1.2. Property `Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > TheThing` +**Title:** Bug + | | | | ------------------------- | ------------------------------------------------------------------------- | | **Type** | `object` | 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 ffab04af..8a17d655 100644 --- a/docs/examples/examples_md_default/recursive_full_schema_simple.md +++ b/docs/examples/examples_md_default/recursive_full_schema_simple.md @@ -12,10 +12,12 @@ | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------- | ------- | ------ | ---------- | ------------------------ | ----------------- | -| - [itself](#itself ) | No | object | No | Same as [Person](#root ) | - | +| - [itself](#itself ) | No | object | No | Same as [Person](#root ) | Person | ## 1. Property `Person > itself` +**Title:** Person + | | | | ------------------------- | ------------------------------------------------------------------------- | | **Type** | `object` | diff --git a/docs/examples/examples_md_default/ref_merge.md b/docs/examples/examples_md_default/ref_merge.md index bb103cc3..b0dbc301 100644 --- a/docs/examples/examples_md_default/ref_merge.md +++ b/docs/examples/examples_md_default/ref_merge.md @@ -13,13 +13,15 @@ | **Required** | No | | **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------------ | ------------------------------------------- | -| - [aProperty](#aProperty ) | No | enum (of string) | No | In #/definitions/aProperty | This is the description from the definition | -| - [aDictPropertyARequired](#aDictPropertyARequired ) | No | object | No | In #/definitions/aDictProperty | - | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------------ | --------------------- | +| - [aProperty](#aProperty ) | No | enum (of string) | No | In #/definitions/aProperty | Title from definition | +| - [aDictPropertyARequired](#aDictPropertyARequired ) | No | object | No | In #/definitions/aDictProperty | - | ## 1. Property `Test > aProperty` +**Title:** Title from definition + | | | | -------------- | ------------------------- | | **Type** | `enum (of string)` | diff --git a/docs/examples/examples_md_default/ref_with_tabs.md b/docs/examples/examples_md_default/ref_with_tabs.md index 0fd40cb2..8c47ccf5 100644 --- a/docs/examples/examples_md_default/ref_with_tabs.md +++ b/docs/examples/examples_md_default/ref_with_tabs.md @@ -4,7 +4,7 @@ - [1.1. Property `root > objectA > signature`](#objectA_signature) - [1.1.1. Property `root > objectA > signature > oneOf > item 0`](#objectA_signature_oneOf_i0) - [1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers`](#objectA_signature_oneOf_i0_signers) - - [1.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > signer](#objectA_signature_oneOf_i0_signers_items) + - [1.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > Signature](#objectA_signature_oneOf_i0_signers_items) - [1.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm) - [1.1.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i0) - [1.1.1.1.1.1.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i1) @@ -34,7 +34,7 @@ - [1.1.1.1.1.6. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > value`](#objectA_signature_oneOf_i0_signers_items_value) - [1.1.2. Property `root > objectA > signature > oneOf > item 1`](#objectA_signature_oneOf_i1) - [1.1.2.1. Property `root > objectA > signature > oneOf > item 1 > chain`](#objectA_signature_oneOf_i1_chain) - - [1.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > signer](#objectA_signature_oneOf_i1_chain_items) + - [1.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > Signature](#objectA_signature_oneOf_i1_chain_items) - [1.1.3. Property `root > objectA > signature > oneOf > Signature`](#objectA_signature_oneOf_i2) - [1.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm) - [1.1.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i0) @@ -67,7 +67,7 @@ - [2.1. Property `root > objectB > signature`](#objectB_signature) - [2.1.1. Property `root > objectA > signature > oneOf > item 0`](#objectA_signature_oneOf_i0) - [2.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers`](#objectA_signature_oneOf_i0_signers) - - [2.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > signer](#objectA_signature_oneOf_i0_signers_items) + - [2.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > Signature](#objectA_signature_oneOf_i0_signers_items) - [2.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm) - [2.1.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i0) - [2.1.1.1.1.1.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i1) @@ -97,7 +97,7 @@ - [2.1.1.1.1.6. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > value`](#objectA_signature_oneOf_i0_signers_items_value) - [2.1.2. Property `root > objectA > signature > oneOf > item 1`](#objectA_signature_oneOf_i1) - [2.1.2.1. Property `root > objectA > signature > oneOf > item 1 > chain`](#objectA_signature_oneOf_i1_chain) - - [2.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > signer](#objectA_signature_oneOf_i1_chain_items) + - [2.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > Signature](#objectA_signature_oneOf_i1_chain_items) - [2.1.3. Property `root > objectA > signature > oneOf > Signature`](#objectA_signature_oneOf_i2) - [2.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm) - [2.1.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i0) @@ -198,11 +198,13 @@ | **Additional items** | False | | **Tuple validation** | See below | -| Each item of this array must be | Description | -| --------------------------------------------------- | ----------- | -| [signer](#objectA_signature_oneOf_i0_signers_items) | - | +| Each item of this array must be | Description | +| ------------------------------------------------------ | ----------- | +| [Signature](#objectA_signature_oneOf_i0_signers_items) | - | -###### 1.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > signer +###### 1.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > Signature + +**Title:** Signature | | | | ------------------------- | ------------------------------------------------------- | @@ -296,10 +298,10 @@ Must be one of: **Description:** Optional. Public key object. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------ | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | No | enum (of string) | No | In #/definitions/keyType | Key type indicator. | -| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------ | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | No | enum (of string) | No | In #/definitions/keyType | Key type | +| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | | All of(Requirement) | | ---------------------------------------------------------------------- | @@ -323,15 +325,17 @@ Must be one of: | **Required** | No | | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name | -| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate | -| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate | +| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate | ###### 1.1.1.1.1.3.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -394,14 +398,16 @@ Must be one of: | **Required** | No | | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name | -| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate | ###### 1.1.1.1.1.3.2.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -452,14 +458,16 @@ Must be one of: | **Required** | No | | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus | -| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus | +| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent | ###### 1.1.1.1.1.3.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -492,6 +500,8 @@ Must be one of: ###### 1.1.1.1.1.3.4. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > kty` +**Title:** Key type + | | | | -------------- | --------------------- | | **Type** | `enum (of string)` | @@ -607,11 +617,13 @@ Must be one of: | **Additional items** | False | | **Tuple validation** | See below | -| Each item of this array must be | Description | -| ------------------------------------------------- | ----------- | -| [signer](#objectA_signature_oneOf_i1_chain_items) | - | +| Each item of this array must be | Description | +| ---------------------------------------------------- | ----------- | +| [Signature](#objectA_signature_oneOf_i1_chain_items) | - | -###### 1.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > signer +###### 1.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > Signature + +**Title:** Signature | | | | ------------------------- | ------------------------------------------------------- | @@ -718,10 +730,10 @@ Must be one of: **Description:** Optional. Public key object. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------ | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | No | enum (of string) | No | In #/definitions/keyType | Key type indicator. | -| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------ | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | No | enum (of string) | No | In #/definitions/keyType | Key type | +| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | | All of(Requirement) | | ---------------------------------------------------------------------- | @@ -745,15 +757,17 @@ Must be one of: | **Required** | No | | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name | -| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate | -| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate | +| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate | ###### 1.1.3.3.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -816,14 +830,16 @@ Must be one of: | **Required** | No | | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name | -| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate | ###### 1.1.3.3.2.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -874,14 +890,16 @@ Must be one of: | **Required** | No | | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus | -| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus | +| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent | ###### 1.1.3.3.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -914,6 +932,8 @@ Must be one of: ###### 1.1.3.3.4. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > kty` +**Title:** Key type + | | | | -------------- | --------------------- | | **Type** | `enum (of string)` | @@ -1058,11 +1078,13 @@ Must be one of: | **Additional items** | False | | **Tuple validation** | See below | -| Each item of this array must be | Description | -| --------------------------------------------------- | ----------- | -| [signer](#objectA_signature_oneOf_i0_signers_items) | - | +| Each item of this array must be | Description | +| ------------------------------------------------------ | ----------- | +| [Signature](#objectA_signature_oneOf_i0_signers_items) | - | -###### 2.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > signer +###### 2.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > Signature + +**Title:** Signature | | | | ------------------------- | ------------------------------------------------------- | @@ -1156,10 +1178,10 @@ Must be one of: **Description:** Optional. Public key object. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------ | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | No | enum (of string) | No | In #/definitions/keyType | Key type indicator. | -| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------ | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | No | enum (of string) | No | In #/definitions/keyType | Key type | +| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | | All of(Requirement) | | ---------------------------------------------------------------------- | @@ -1183,15 +1205,17 @@ Must be one of: | **Required** | No | | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name | -| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate | -| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate | +| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate | ###### 2.1.1.1.1.3.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1254,14 +1278,16 @@ Must be one of: | **Required** | No | | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name | -| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate | ###### 2.1.1.1.1.3.2.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1312,14 +1338,16 @@ Must be one of: | **Required** | No | | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus | -| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus | +| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent | ###### 2.1.1.1.1.3.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1352,6 +1380,8 @@ Must be one of: ###### 2.1.1.1.1.3.4. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > kty` +**Title:** Key type + | | | | -------------- | --------------------- | | **Type** | `enum (of string)` | @@ -1467,11 +1497,13 @@ Must be one of: | **Additional items** | False | | **Tuple validation** | See below | -| Each item of this array must be | Description | -| ------------------------------------------------- | ----------- | -| [signer](#objectA_signature_oneOf_i1_chain_items) | - | +| Each item of this array must be | Description | +| ---------------------------------------------------- | ----------- | +| [Signature](#objectA_signature_oneOf_i1_chain_items) | - | -###### 2.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > signer +###### 2.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > Signature + +**Title:** Signature | | | | ------------------------- | ------------------------------------------------------- | @@ -1578,10 +1610,10 @@ Must be one of: **Description:** Optional. Public key object. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------ | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | No | enum (of string) | No | In #/definitions/keyType | Key type indicator. | -| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------ | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | No | enum (of string) | No | In #/definitions/keyType | Key type | +| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | | All of(Requirement) | | ---------------------------------------------------------------------- | @@ -1605,15 +1637,17 @@ Must be one of: | **Required** | No | | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name | -| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate | -| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate | +| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate | ###### 2.1.3.3.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1676,14 +1710,16 @@ Must be one of: | **Required** | No | | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name | -| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate | ###### 2.1.3.3.2.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1734,14 +1770,16 @@ Must be one of: | **Required** | No | | **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus | -| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus | +| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent | ###### 2.1.3.3.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1774,6 +1812,8 @@ Must be one of: ###### 2.1.3.3.4. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > kty` +**Title:** Key type + | | | | -------------- | --------------------- | | **Type** | `enum (of string)` | diff --git a/docs/examples/examples_md_default/references_url.md b/docs/examples/examples_md_default/references_url.md index 9e6032f8..defd8b12 100644 --- a/docs/examples/examples_md_default/references_url.md +++ b/docs/examples/examples_md_default/references_url.md @@ -10,12 +10,14 @@ **Description:** Testing $ref with URL -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------- | ------- | ------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------ | -| - [firstName](#firstName ) | No | string | No | In https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/basic.json#/properties/firstName | The person's first name. | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------- | ------- | ------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------ | ----------------- | +| - [firstName](#firstName ) | No | string | No | In https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/basic.json#/properties/firstName | Person | ## 1. Property `root > firstName` +**Title:** Person + | | | | -------------- | --------------------------------------------------------------------------------------------------------------------------- | | **Type** | `string` | diff --git a/docs/examples/examples_md_nested_default/Configuration.md b/docs/examples/examples_md_nested_default/Configuration.md index 35fc0e59..cd5682f6 100644 --- a/docs/examples/examples_md_nested_default/Configuration.md +++ b/docs/examples/examples_md_nested_default/Configuration.md @@ -410,12 +410,12 @@ 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.") | -| **Default** | `{"fenced-code-blocks": {"break-on-newline": true, "cssclass": "highlight jumbotron", "tables": null}, "tables": null}` | +| | | +| ------------------------- | ------------------------------------------------------------------------------------------------------- | +| **Type** | `object` | +| **Required** | No | +| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") | +| **Default** | `{"fenced-code-blocks": {"cssclass": "highlight jumbotron"}, "tables": null, "break-on-newline": true}` | **Description:** [Markdown 2 options](https://github.com/trentm/python-markdown2/wiki/Extras) for the descriptions. `description_is_markdown` must be true for this to have any effect. 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 9ead5e84..b077c801 100644 --- a/docs/examples/examples_md_nested_default/recursive_full_schema.md +++ b/docs/examples/examples_md_nested_default/recursive_full_schema.md @@ -2,7 +2,7 @@ - [1. [Optional] Property Bug > Code](#Code) - [2. [Optional] Property Bug > RecursiveArray](#RecursiveArray) - - [2.1. Bug > RecursiveArray > #](#autogenerated_heading_2) + - [2.1. Bug > RecursiveArray > Bug](#autogenerated_heading_2) - [3. [Optional] Property Bug > DecoratedRecursiveArray](#DecoratedRecursiveArray) - [3.1. Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items](#autogenerated_heading_3) - [3.1.1. [Optional] Property Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > SomeName](#DecoratedRecursiveArray_items_SomeName) @@ -59,9 +59,11 @@ | Each item of this array must be | Description | | ------------------------------- | ------------------ | -| [#](#RecursiveArray_items) | Display the issue. | +| [Bug](#RecursiveArray_items) | Display the issue. | -### 2.1. Bug > RecursiveArray > # +### 2.1. Bug > RecursiveArray > Bug + +**Title:** Bug | | | | ------------------------- | ------------------------------------------------------------------------- | @@ -131,6 +133,8 @@
+**Title:** Bug + | | | | ------------------------- | ------------------------------------------------------------------------- | | **Type** | `object` | 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 d3131c2a..c71b395a 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 @@ -17,6 +17,8 @@
+**Title:** Person + | | | | ------------------------- | ------------------------------------------------------------------------- | | **Type** | `object` | diff --git a/docs/examples/examples_md_nested_default/ref_merge.md b/docs/examples/examples_md_nested_default/ref_merge.md index 86981e08..e7690b19 100644 --- a/docs/examples/examples_md_nested_default/ref_merge.md +++ b/docs/examples/examples_md_nested_default/ref_merge.md @@ -20,6 +20,8 @@
+**Title:** Title from definition + | | | | -------------- | ------------------------- | | **Type** | `enum (of string)` | 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 23fd4cda..0c92db03 100644 --- a/docs/examples/examples_md_nested_default/ref_with_tabs.md +++ b/docs/examples/examples_md_nested_default/ref_with_tabs.md @@ -4,7 +4,7 @@ - [1.1. [Optional] Property root > objectA > signature](#objectA_signature) - [1.1.1. Property `root > objectA > signature > oneOf > item 0`](#objectA_signature_oneOf_i0) - [1.1.1.1. [Optional] Property root > objectA > signature > oneOf > item 0 > signers](#objectA_signature_oneOf_i0_signers) - - [1.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > signer](#autogenerated_heading_2) + - [1.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > Signature](#autogenerated_heading_2) - [1.1.1.1.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm) - [1.1.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i0) - [1.1.1.1.1.1.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i1) @@ -34,7 +34,7 @@ - [1.1.1.1.1.6. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > value](#objectA_signature_oneOf_i0_signers_items_value) - [1.1.2. Property `root > objectA > signature > oneOf > item 1`](#objectA_signature_oneOf_i1) - [1.1.2.1. [Optional] Property root > objectA > signature > oneOf > item 1 > chain](#objectA_signature_oneOf_i1_chain) - - [1.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > signer](#autogenerated_heading_8) + - [1.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > Signature](#autogenerated_heading_8) - [1.1.3. Property `root > objectA > signature > oneOf > Signature`](#objectA_signature_oneOf_i2) - [1.1.3.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm) - [1.1.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i0) @@ -67,7 +67,7 @@ - [2.1. [Optional] Property root > objectB > signature](#objectB_signature) - [2.1.1. Property `root > objectA > signature > oneOf > item 0`](#objectA_signature_oneOf_i0) - [2.1.1.1. [Optional] Property root > objectA > signature > oneOf > item 0 > signers](#objectA_signature_oneOf_i0_signers) - - [2.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > signer](#autogenerated_heading_14) + - [2.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > Signature](#autogenerated_heading_14) - [2.1.1.1.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm) - [2.1.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i0) - [2.1.1.1.1.1.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i1) @@ -97,7 +97,7 @@ - [2.1.1.1.1.6. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > value](#objectA_signature_oneOf_i0_signers_items_value) - [2.1.2. Property `root > objectA > signature > oneOf > item 1`](#objectA_signature_oneOf_i1) - [2.1.2.1. [Optional] Property root > objectA > signature > oneOf > item 1 > chain](#objectA_signature_oneOf_i1_chain) - - [2.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > signer](#autogenerated_heading_20) + - [2.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > Signature](#autogenerated_heading_20) - [2.1.3. Property `root > objectA > signature > oneOf > Signature`](#objectA_signature_oneOf_i2) - [2.1.3.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm) - [2.1.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i0) @@ -204,11 +204,13 @@ | **Additional items** | False | | **Tuple validation** | See below | -| Each item of this array must be | Description | -| --------------------------------------------------- | ----------- | -| [signer](#objectA_signature_oneOf_i0_signers_items) | - | +| Each item of this array must be | Description | +| ------------------------------------------------------ | ----------- | +| [Signature](#objectA_signature_oneOf_i0_signers_items) | - | -###### 1.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > signer +###### 1.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > Signature + +**Title:** Signature | | | | ------------------------- | ------------------------------------------------------- | @@ -358,6 +360,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -457,6 +461,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -536,6 +542,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -596,6 +604,8 @@ Must be one of:
+**Title:** Key type + | | | | -------------- | --------------------- | | **Type** | `enum (of string)` | @@ -748,11 +758,13 @@ Must be one of: | **Additional items** | False | | **Tuple validation** | See below | -| Each item of this array must be | Description | -| ------------------------------------------------- | ----------- | -| [signer](#objectA_signature_oneOf_i1_chain_items) | - | +| Each item of this array must be | Description | +| ---------------------------------------------------- | ----------- | +| [Signature](#objectA_signature_oneOf_i1_chain_items) | - | -###### 1.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > signer +###### 1.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > Signature + +**Title:** Signature | | | | ------------------------- | ------------------------------------------------------- | @@ -921,6 +933,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1020,6 +1034,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1099,6 +1115,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1159,6 +1177,8 @@ Must be one of:
+**Title:** Key type + | | | | -------------- | --------------------- | | **Type** | `enum (of string)` | @@ -1354,11 +1374,13 @@ Must be one of: | **Additional items** | False | | **Tuple validation** | See below | -| Each item of this array must be | Description | -| --------------------------------------------------- | ----------- | -| [signer](#objectA_signature_oneOf_i0_signers_items) | - | +| Each item of this array must be | Description | +| ------------------------------------------------------ | ----------- | +| [Signature](#objectA_signature_oneOf_i0_signers_items) | - | -###### 2.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > signer +###### 2.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > Signature + +**Title:** Signature | | | | ------------------------- | ------------------------------------------------------- | @@ -1508,6 +1530,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1607,6 +1631,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1686,6 +1712,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1746,6 +1774,8 @@ Must be one of:
+**Title:** Key type + | | | | -------------- | --------------------- | | **Type** | `enum (of string)` | @@ -1898,11 +1928,13 @@ Must be one of: | **Additional items** | False | | **Tuple validation** | See below | -| Each item of this array must be | Description | -| ------------------------------------------------- | ----------- | -| [signer](#objectA_signature_oneOf_i1_chain_items) | - | +| Each item of this array must be | Description | +| ---------------------------------------------------- | ----------- | +| [Signature](#objectA_signature_oneOf_i1_chain_items) | - | -###### 2.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > signer +###### 2.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > Signature + +**Title:** Signature | | | | ------------------------- | ------------------------------------------------------- | @@ -2071,6 +2103,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -2170,6 +2204,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -2249,6 +2285,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -2309,6 +2347,8 @@ Must be one of:
+**Title:** Key type + | | | | -------------- | --------------------- | | **Type** | `enum (of string)` | diff --git a/docs/examples/examples_md_nested_default/references_url.md b/docs/examples/examples_md_nested_default/references_url.md index 4717d138..2e9a95f8 100644 --- a/docs/examples/examples_md_nested_default/references_url.md +++ b/docs/examples/examples_md_nested_default/references_url.md @@ -17,6 +17,8 @@
+**Title:** Person + | | | | -------------- | --------------------------------------------------------------------------------------------------------------------------- | | **Type** | `string` | diff --git a/docs/examples/examples_md_nested_with_badges/Configuration.md b/docs/examples/examples_md_nested_with_badges/Configuration.md index 714bb560..5f7957c7 100644 --- a/docs/examples/examples_md_nested_with_badges/Configuration.md +++ b/docs/examples/examples_md_nested_with_badges/Configuration.md @@ -395,7 +395,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.") | -| **Default** | `{"fenced-code-blocks": {"break-on-newline": true, "cssclass": "highlight jumbotron", "tables": null}, "tables": null}` | +| **Default** | `{"fenced-code-blocks": {"cssclass": "highlight jumbotron"}, "tables": null, "break-on-newline": true}` | **Description:** [Markdown 2 options](https://github.com/trentm/python-markdown2/wiki/Extras) for the descriptions. `description_is_markdown` must be true for this to have any effect. 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 86bbc56d..081ac774 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 @@ -2,7 +2,7 @@ - [1. [Optional] Property Bug > Code](#Code) - [2. [Optional] Property Bug > RecursiveArray](#RecursiveArray) - - [2.1. Bug > RecursiveArray > #](#autogenerated_heading_2) + - [2.1. Bug > RecursiveArray > Bug](#autogenerated_heading_2) - [3. [Optional] Property Bug > DecoratedRecursiveArray](#DecoratedRecursiveArray) - [3.1. Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items](#autogenerated_heading_3) - [3.1.1. [Optional] Property Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > SomeName](#DecoratedRecursiveArray_items_SomeName) @@ -56,9 +56,11 @@ | Each item of this array must be | Description | | ------------------------------- | ------------------ | -| [#](#RecursiveArray_items) | Display the issue. | +| [Bug](#RecursiveArray_items) | Display the issue. | -### 2.1. Bug > RecursiveArray > # +### 2.1. Bug > RecursiveArray > Bug + +**Title:** Bug | | | | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | @@ -124,6 +126,8 @@
+**Title:** Bug + | | | | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | **Type** | `object` | 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 bb3668f3..968dbf62 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 @@ -16,6 +16,8 @@
+**Title:** Person + | | | | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | **Type** | `object` | 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 46ddfc10..145e7f54 100644 --- a/docs/examples/examples_md_nested_with_badges/ref_merge.md +++ b/docs/examples/examples_md_nested_with_badges/ref_merge.md @@ -19,6 +19,8 @@
+**Title:** Title from definition + | | | | -------------- | ------------------------- | | **Type** | `enum (of string)` | 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 8a71dd39..0ed58b27 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 @@ -4,7 +4,7 @@ - [1.1. [Optional] Property root > objectA > signature](#objectA_signature) - [1.1.1. Property `root > objectA > signature > oneOf > item 0`](#objectA_signature_oneOf_i0) - [1.1.1.1. [Optional] Property root > objectA > signature > oneOf > item 0 > signers](#objectA_signature_oneOf_i0_signers) - - [1.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > signer](#autogenerated_heading_2) + - [1.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > Signature](#autogenerated_heading_2) - [1.1.1.1.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm) - [1.1.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i0) - [1.1.1.1.1.1.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i1) @@ -34,7 +34,7 @@ - [1.1.1.1.1.6. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > value](#objectA_signature_oneOf_i0_signers_items_value) - [1.1.2. Property `root > objectA > signature > oneOf > item 1`](#objectA_signature_oneOf_i1) - [1.1.2.1. [Optional] Property root > objectA > signature > oneOf > item 1 > chain](#objectA_signature_oneOf_i1_chain) - - [1.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > signer](#autogenerated_heading_8) + - [1.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > Signature](#autogenerated_heading_8) - [1.1.3. Property `root > objectA > signature > oneOf > Signature`](#objectA_signature_oneOf_i2) - [1.1.3.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm) - [1.1.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i0) @@ -67,7 +67,7 @@ - [2.1. [Optional] Property root > objectB > signature](#objectB_signature) - [2.1.1. Property `root > objectA > signature > oneOf > item 0`](#objectA_signature_oneOf_i0) - [2.1.1.1. [Optional] Property root > objectA > signature > oneOf > item 0 > signers](#objectA_signature_oneOf_i0_signers) - - [2.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > signer](#autogenerated_heading_14) + - [2.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > Signature](#autogenerated_heading_14) - [2.1.1.1.1.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm) - [2.1.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i0) - [2.1.1.1.1.1.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i1) @@ -97,7 +97,7 @@ - [2.1.1.1.1.6. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > value](#objectA_signature_oneOf_i0_signers_items_value) - [2.1.2. Property `root > objectA > signature > oneOf > item 1`](#objectA_signature_oneOf_i1) - [2.1.2.1. [Optional] Property root > objectA > signature > oneOf > item 1 > chain](#objectA_signature_oneOf_i1_chain) - - [2.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > signer](#autogenerated_heading_20) + - [2.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > Signature](#autogenerated_heading_20) - [2.1.3. Property `root > objectA > signature > oneOf > Signature`](#objectA_signature_oneOf_i2) - [2.1.3.1. [Required] Property root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm) - [2.1.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i0) @@ -199,11 +199,13 @@ | **Additional items** | False | | **Tuple validation** | See below | -| Each item of this array must be | Description | -| --------------------------------------------------- | ----------- | -| [signer](#objectA_signature_oneOf_i0_signers_items) | - | +| Each item of this array must be | Description | +| ------------------------------------------------------ | ----------- | +| [Signature](#objectA_signature_oneOf_i0_signers_items) | - | -###### 1.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > signer +###### 1.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > Signature + +**Title:** Signature | | | | ------------------------- | -------------------------------------------------------------------------------------------------------- | @@ -345,6 +347,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -438,6 +442,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -512,6 +518,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -569,6 +577,8 @@ Must be one of:
+**Title:** Key type + | | | | -------------- | --------------------- | | **Type** | `enum (of string)` | @@ -713,11 +723,13 @@ Must be one of: | **Additional items** | False | | **Tuple validation** | See below | -| Each item of this array must be | Description | -| ------------------------------------------------- | ----------- | -| [signer](#objectA_signature_oneOf_i1_chain_items) | - | +| Each item of this array must be | Description | +| ---------------------------------------------------- | ----------- | +| [Signature](#objectA_signature_oneOf_i1_chain_items) | - | -###### 1.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > signer +###### 1.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > Signature + +**Title:** Signature | | | | ------------------------- | -------------------------------------------------------------------------------------------------------- | @@ -877,6 +889,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -970,6 +984,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1044,6 +1060,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1101,6 +1119,8 @@ Must be one of:
+**Title:** Key type + | | | | -------------- | --------------------- | | **Type** | `enum (of string)` | @@ -1286,11 +1306,13 @@ Must be one of: | **Additional items** | False | | **Tuple validation** | See below | -| Each item of this array must be | Description | -| --------------------------------------------------- | ----------- | -| [signer](#objectA_signature_oneOf_i0_signers_items) | - | +| Each item of this array must be | Description | +| ------------------------------------------------------ | ----------- | +| [Signature](#objectA_signature_oneOf_i0_signers_items) | - | -###### 2.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > signer +###### 2.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > Signature + +**Title:** Signature | | | | ------------------------- | -------------------------------------------------------------------------------------------------------- | @@ -1432,6 +1454,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1525,6 +1549,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1599,6 +1625,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1656,6 +1684,8 @@ Must be one of:
+**Title:** Key type + | | | | -------------- | --------------------- | | **Type** | `enum (of string)` | @@ -1800,11 +1830,13 @@ Must be one of: | **Additional items** | False | | **Tuple validation** | See below | -| Each item of this array must be | Description | -| ------------------------------------------------- | ----------- | -| [signer](#objectA_signature_oneOf_i1_chain_items) | - | +| Each item of this array must be | Description | +| ---------------------------------------------------- | ----------- | +| [Signature](#objectA_signature_oneOf_i1_chain_items) | - | -###### 2.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > signer +###### 2.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > Signature + +**Title:** Signature | | | | ------------------------- | -------------------------------------------------------------------------------------------------------- | @@ -1964,6 +1996,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -2057,6 +2091,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -2131,6 +2167,8 @@ Must be one of:
+**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -2188,6 +2226,8 @@ Must be one of:
+**Title:** Key type + | | | | -------------- | --------------------- | | **Type** | `enum (of string)` | 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 2cef7ae4..e865b7f5 100644 --- a/docs/examples/examples_md_nested_with_badges/references_url.md +++ b/docs/examples/examples_md_nested_with_badges/references_url.md @@ -16,6 +16,8 @@
+**Title:** Person + | | | | -------------- | --------------------------------------------------------------------------------------------------------------------------- | | **Type** | `string` | diff --git a/docs/examples/examples_md_with_badges/Configuration.md b/docs/examples/examples_md_with_badges/Configuration.md index ac193d86..84b238f8 100644 --- a/docs/examples/examples_md_with_badges/Configuration.md +++ b/docs/examples/examples_md_with_badges/Configuration.md @@ -271,7 +271,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.") | -| **Default** | `{"fenced-code-blocks": {"break-on-newline": true, "cssclass": "highlight jumbotron", "tables": null}, "tables": null}` | +| **Default** | `{"fenced-code-blocks": {"cssclass": "highlight jumbotron"}, "tables": null, "break-on-newline": true}` | **Description:** [Markdown 2 options](https://github.com/trentm/python-markdown2/wiki/Extras) for the descriptions. `description_is_markdown` must be true for this to have any effect. 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 a75d616d..45ecb19e 100644 --- a/docs/examples/examples_md_with_badges/recursive_full_schema.md +++ b/docs/examples/examples_md_with_badges/recursive_full_schema.md @@ -2,7 +2,7 @@ - [1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Bug > Code`](#Code) - [2. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Bug > RecursiveArray`](#RecursiveArray) - - [2.1. Bug > RecursiveArray > #](#RecursiveArray_items) + - [2.1. Bug > RecursiveArray > Bug](#RecursiveArray_items) - [3. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Bug > DecoratedRecursiveArray`](#DecoratedRecursiveArray) - [3.1. Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items](#DecoratedRecursiveArray_items) - [3.1.1. Property `Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > SomeName`](#DecoratedRecursiveArray_items_SomeName) @@ -49,9 +49,11 @@ | Each item of this array must be | Description | | ------------------------------- | ------------------ | -| [#](#RecursiveArray_items) | Display the issue. | +| [Bug](#RecursiveArray_items) | Display the issue. | -### 2.1. Bug > RecursiveArray > # +### 2.1. Bug > RecursiveArray > Bug + +**Title:** Bug | | | | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | @@ -88,10 +90,10 @@ | **Type** | `object` | | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------ | ------- | ------ | ---------- | --------------------- | ------------------ | -| - [SomeName](#DecoratedRecursiveArray_items_SomeName ) | No | string | No | - | - | -| - [TheThing](#DecoratedRecursiveArray_items_TheThing ) | No | object | No | Same as [Bug](#root ) | Display the issue. | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------ | ------- | ------ | ---------- | --------------------- | ----------------- | +| - [SomeName](#DecoratedRecursiveArray_items_SomeName ) | No | string | No | - | - | +| - [TheThing](#DecoratedRecursiveArray_items_TheThing ) | No | object | No | Same as [Bug](#root ) | Bug | #### 3.1.1. Property `Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > SomeName` @@ -101,6 +103,8 @@ #### 3.1.2. Property `Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > TheThing` +**Title:** Bug + | | | | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | **Type** | `object` | 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 c47f2f12..6f9dac6a 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 @@ -11,10 +11,12 @@ | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------- | ------- | ------ | ---------- | ------------------------ | ----------------- | -| - [itself](#itself ) | No | object | No | Same as [Person](#root ) | - | +| - [itself](#itself ) | No | object | No | Same as [Person](#root ) | Person | ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > itself` +**Title:** Person + | | | | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | **Type** | `object` | diff --git a/docs/examples/examples_md_with_badges/ref_merge.md b/docs/examples/examples_md_with_badges/ref_merge.md index 01678dee..ff6935af 100644 --- a/docs/examples/examples_md_with_badges/ref_merge.md +++ b/docs/examples/examples_md_with_badges/ref_merge.md @@ -12,13 +12,15 @@ | **Type** | `object` | | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------------ | ------------------------------------------- | -| - [aProperty](#aProperty ) | No | enum (of string) | No | In #/definitions/aProperty | This is the description from the definition | -| - [aDictPropertyARequired](#aDictPropertyARequired ) | No | object | No | In #/definitions/aDictProperty | - | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------------ | --------------------- | +| - [aProperty](#aProperty ) | No | enum (of string) | No | In #/definitions/aProperty | Title from definition | +| - [aDictPropertyARequired](#aDictPropertyARequired ) | No | object | No | In #/definitions/aDictProperty | - | ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Test > aProperty` +**Title:** Title from definition + | | | | -------------- | ------------------------- | | **Type** | `enum (of string)` | 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 b5a1c399..fc88429a 100644 --- a/docs/examples/examples_md_with_badges/ref_with_tabs.md +++ b/docs/examples/examples_md_with_badges/ref_with_tabs.md @@ -4,7 +4,7 @@ - [1.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > objectA > signature`](#objectA_signature) - [1.1.1. Property `root > objectA > signature > oneOf > item 0`](#objectA_signature_oneOf_i0) - [1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers`](#objectA_signature_oneOf_i0_signers) - - [1.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > signer](#objectA_signature_oneOf_i0_signers_items) + - [1.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > Signature](#objectA_signature_oneOf_i0_signers_items) - [1.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm) - [1.1.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i0) - [1.1.1.1.1.1.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i1) @@ -34,7 +34,7 @@ - [1.1.1.1.1.6. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > value`](#objectA_signature_oneOf_i0_signers_items_value) - [1.1.2. Property `root > objectA > signature > oneOf > item 1`](#objectA_signature_oneOf_i1) - [1.1.2.1. Property `root > objectA > signature > oneOf > item 1 > chain`](#objectA_signature_oneOf_i1_chain) - - [1.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > signer](#objectA_signature_oneOf_i1_chain_items) + - [1.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > Signature](#objectA_signature_oneOf_i1_chain_items) - [1.1.3. Property `root > objectA > signature > oneOf > Signature`](#objectA_signature_oneOf_i2) - [1.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm) - [1.1.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i0) @@ -67,7 +67,7 @@ - [2.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > objectB > signature`](#objectB_signature) - [2.1.1. Property `root > objectA > signature > oneOf > item 0`](#objectA_signature_oneOf_i0) - [2.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers`](#objectA_signature_oneOf_i0_signers) - - [2.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > signer](#objectA_signature_oneOf_i0_signers_items) + - [2.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > Signature](#objectA_signature_oneOf_i0_signers_items) - [2.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm) - [2.1.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i0) - [2.1.1.1.1.1.2. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i1) @@ -97,7 +97,7 @@ - [2.1.1.1.1.6. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > value`](#objectA_signature_oneOf_i0_signers_items_value) - [2.1.2. Property `root > objectA > signature > oneOf > item 1`](#objectA_signature_oneOf_i1) - [2.1.2.1. Property `root > objectA > signature > oneOf > item 1 > chain`](#objectA_signature_oneOf_i1_chain) - - [2.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > signer](#objectA_signature_oneOf_i1_chain_items) + - [2.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > Signature](#objectA_signature_oneOf_i1_chain_items) - [2.1.3. Property `root > objectA > signature > oneOf > Signature`](#objectA_signature_oneOf_i2) - [2.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm) - [2.1.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm > oneOf > Algorithm`](#objectA_signature_oneOf_i0_signers_items_algorithm_oneOf_i0) @@ -193,11 +193,13 @@ | **Additional items** | False | | **Tuple validation** | See below | -| Each item of this array must be | Description | -| --------------------------------------------------- | ----------- | -| [signer](#objectA_signature_oneOf_i0_signers_items) | - | +| Each item of this array must be | Description | +| ------------------------------------------------------ | ----------- | +| [Signature](#objectA_signature_oneOf_i0_signers_items) | - | -###### 1.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > signer +###### 1.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > Signature + +**Title:** Signature | | | | ------------------------- | -------------------------------------------------------------------------------------------------------- | @@ -285,10 +287,10 @@ Must be one of: **Description:** Optional. Public key object. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------ | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | No | enum (of string) | No | In #/definitions/keyType | Key type indicator. | -| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------ | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | No | enum (of string) | No | In #/definitions/keyType | Key type | +| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | | All of(Requirement) | | ---------------------------------------------------------------------- | @@ -310,15 +312,17 @@ Must be one of: | **Type** | `object` | | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name | -| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate | -| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate | +| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate | ###### 1.1.1.1.1.3.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -375,14 +379,16 @@ Must be one of: | **Type** | `object` | | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name | -| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate | ###### 1.1.1.1.1.3.2.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -428,14 +434,16 @@ Must be one of: | **Type** | `object` | | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus | -| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus | +| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent | ###### 1.1.1.1.1.3.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -465,6 +473,8 @@ Must be one of: ###### 1.1.1.1.1.3.4. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > kty` +**Title:** Key type + | | | | -------------- | --------------------- | | **Type** | `enum (of string)` | @@ -572,11 +582,13 @@ Must be one of: | **Additional items** | False | | **Tuple validation** | See below | -| Each item of this array must be | Description | -| ------------------------------------------------- | ----------- | -| [signer](#objectA_signature_oneOf_i1_chain_items) | - | +| Each item of this array must be | Description | +| ---------------------------------------------------- | ----------- | +| [Signature](#objectA_signature_oneOf_i1_chain_items) | - | -###### 1.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > signer +###### 1.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > Signature + +**Title:** Signature | | | | ------------------------- | -------------------------------------------------------------------------------------------------------- | @@ -676,10 +688,10 @@ Must be one of: **Description:** Optional. Public key object. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------ | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | No | enum (of string) | No | In #/definitions/keyType | Key type indicator. | -| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------ | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | No | enum (of string) | No | In #/definitions/keyType | Key type | +| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | | All of(Requirement) | | ---------------------------------------------------------------------- | @@ -701,15 +713,17 @@ Must be one of: | **Type** | `object` | | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name | -| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate | -| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate | +| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate | ###### 1.1.3.3.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -766,14 +780,16 @@ Must be one of: | **Type** | `object` | | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name | -| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate | ###### 1.1.3.3.2.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -819,14 +835,16 @@ Must be one of: | **Type** | `object` | | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus | -| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus | +| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent | ###### 1.1.3.3.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -856,6 +874,8 @@ Must be one of: ###### 1.1.3.3.4. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > kty` +**Title:** Key type + | | | | -------------- | --------------------- | | **Type** | `enum (of string)` | @@ -990,11 +1010,13 @@ Must be one of: | **Additional items** | False | | **Tuple validation** | See below | -| Each item of this array must be | Description | -| --------------------------------------------------- | ----------- | -| [signer](#objectA_signature_oneOf_i0_signers_items) | - | +| Each item of this array must be | Description | +| ------------------------------------------------------ | ----------- | +| [Signature](#objectA_signature_oneOf_i0_signers_items) | - | -###### 2.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > signer +###### 2.1.1.1.1. root > objectA > signature > oneOf > item 0 > signers > Signature + +**Title:** Signature | | | | ------------------------- | -------------------------------------------------------------------------------------------------------- | @@ -1082,10 +1104,10 @@ Must be one of: **Description:** Optional. Public key object. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------ | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | No | enum (of string) | No | In #/definitions/keyType | Key type indicator. | -| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------ | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | No | enum (of string) | No | In #/definitions/keyType | Key type | +| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | | All of(Requirement) | | ---------------------------------------------------------------------- | @@ -1107,15 +1129,17 @@ Must be one of: | **Type** | `object` | | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name | -| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate | -| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate | +| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate | ###### 2.1.1.1.1.3.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1172,14 +1196,16 @@ Must be one of: | **Type** | `object` | | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name | -| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate | ###### 2.1.1.1.1.3.2.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1225,14 +1251,16 @@ Must be one of: | **Type** | `object` | | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus | -| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus | +| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent | ###### 2.1.1.1.1.3.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1262,6 +1290,8 @@ Must be one of: ###### 2.1.1.1.1.3.4. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > kty` +**Title:** Key type + | | | | -------------- | --------------------- | | **Type** | `enum (of string)` | @@ -1369,11 +1399,13 @@ Must be one of: | **Additional items** | False | | **Tuple validation** | See below | -| Each item of this array must be | Description | -| ------------------------------------------------- | ----------- | -| [signer](#objectA_signature_oneOf_i1_chain_items) | - | +| Each item of this array must be | Description | +| ---------------------------------------------------- | ----------- | +| [Signature](#objectA_signature_oneOf_i1_chain_items) | - | -###### 2.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > signer +###### 2.1.2.1.1. root > objectA > signature > oneOf > item 1 > chain > Signature + +**Title:** Signature | | | | ------------------------- | -------------------------------------------------------------------------------------------------------- | @@ -1473,10 +1505,10 @@ Must be one of: **Description:** Optional. Public key object. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------ | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | No | enum (of string) | No | In #/definitions/keyType | Key type indicator. | -| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------ | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | No | enum (of string) | No | In #/definitions/keyType | Key type | +| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | | All of(Requirement) | | ---------------------------------------------------------------------- | @@ -1498,15 +1530,17 @@ Must be one of: | **Type** | `object` | | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name | -| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate | -| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate | +| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate | ###### 2.1.3.3.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1563,14 +1597,16 @@ Must be one of: | **Type** | `object` | | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name | -| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate | ###### 2.1.3.3.2.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1616,14 +1652,16 @@ Must be one of: | **Type** | `object` | | **Additional properties** | [![Not allowed](https://img.shields.io/badge/Not%20allowed-red)](# "Additional Properties not allowed.") | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ------------------- | -| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type indicator. | -| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus | -| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | ---------------- | ---------- | ----------------------------------------------------------------------- | ----------------- | +| + [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty ) | No | enum (of string) | No | Same as [kty](#objectA_signature_oneOf_i0_signers_items_publicKey_kty ) | Key type | +| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus | +| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent | ###### 2.1.3.3.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty` +**Title:** Key type + | | | | ---------------------- | -------------------------------------------------------------- | | **Type** | `enum (of string)` | @@ -1653,6 +1691,8 @@ Must be one of: ###### 2.1.3.3.4. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > kty` +**Title:** Key type + | | | | -------------- | --------------------- | | **Type** | `enum (of string)` | diff --git a/docs/examples/examples_md_with_badges/references_url.md b/docs/examples/examples_md_with_badges/references_url.md index dadec565..ca270419 100644 --- a/docs/examples/examples_md_with_badges/references_url.md +++ b/docs/examples/examples_md_with_badges/references_url.md @@ -9,12 +9,14 @@ **Description:** Testing $ref with URL -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------- | ------- | ------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------ | -| - [firstName](#firstName ) | No | string | No | In https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/basic.json#/properties/firstName | The person's first name. | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------- | ------- | ------ | ---------- | ------------------------------------------------------------------------------------------------------------------------------ | ----------------- | +| - [firstName](#firstName ) | No | string | No | In https://raw.githubusercontent.com/coveooss/json-schema-for-humans/main/docs/examples/cases/basic.json#/properties/firstName | Person | ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > firstName` +**Title:** Person + | | | | -------------- | --------------------------------------------------------------------------------------------------------------------------- | | **Type** | `string` | diff --git a/json_schema_for_humans/schema/schema_node.py b/json_schema_for_humans/schema/schema_node.py index a18c2e92..547bc459 100644 --- a/json_schema_for_humans/schema/schema_node.py +++ b/json_schema_for_humans/schema/schema_node.py @@ -1,11 +1,11 @@ import copy import string -from typing import Any, Dict, Iterable, Iterator, List, Optional, Set, Union, cast +from typing import Any, Dict, Iterable, Iterator, List, Optional, Set, Union from json_schema_for_humans import const from json_schema_for_humans.generation_configuration import GenerationConfiguration from json_schema_for_humans.schema.schema_keyword import SchemaKeyword -from json_schema_for_humans.templating_utils import get_type_name, schema_keyword_to_str +from json_schema_for_humans.templating_utils import get_type_name, schema_keyword_lookup_to_str circular_references: Dict["SchemaNode", bool] = {} @@ -249,21 +249,7 @@ def format(self) -> Optional[str]: @property def description(self) -> str: - description = schema_keyword_to_str(self, const.DESCRIPTION) - - seen = set() - current_node = self - while not description and current_node.refers_to: - if current_node in seen: - break - seen.add(current_node) - referenced_schema = current_node.refers_to - referenced_description_node = referenced_schema.keywords.get(const.DESCRIPTION) - if referenced_description_node: - description = referenced_description_node.literal_str - current_node = referenced_schema - - return description or "" + return schema_keyword_lookup_to_str(self, SchemaKeyword.DESCRIPTION) or "" @property def literal_str(self) -> Optional[str]: @@ -461,12 +447,7 @@ def kw_type(self) -> Optional["SchemaNode"]: @property def title(self) -> Optional[str]: - title_kw = self.get_keyword(SchemaKeyword.TITLE) - if not title_kw: - return None - title = title_kw.literal - title = cast(str, title) - return title + return schema_keyword_lookup_to_str(self, SchemaKeyword.TITLE) or "" @property def property_display_name(self) -> Optional[str]: diff --git a/json_schema_for_humans/templating_utils.py b/json_schema_for_humans/templating_utils.py index d4ab1207..f9d20c97 100644 --- a/json_schema_for_humans/templating_utils.py +++ b/json_schema_for_humans/templating_utils.py @@ -1,6 +1,7 @@ from typing import TYPE_CHECKING, List, Optional, Type, Union from json_schema_for_humans import const +from json_schema_for_humans.schema.schema_keyword import SchemaKeyword if TYPE_CHECKING: from json_schema_for_humans.schema.schema_node import SchemaNode @@ -26,6 +27,30 @@ def schema_keyword_to_str(schema_node: "SchemaNode", keyword: str) -> Optional[s return None +def schema_keyword_lookup_to_str(schema_node: "SchemaNode", keyword: SchemaKeyword) -> Optional[str]: + """Look up the str value of a schema keyword or return None + + If the keyword is not found on the given node, follow referenced nodes until + the keyword is found. Returns None if the keyword is not found or is not a + literal str. + """ + value = schema_keyword_to_str(schema_node, keyword.value) + + seen = set() + current_node = schema_node + while not value and current_node.refers_to: + if current_node in seen: + break + seen.add(current_node) + referenced_schema = current_node.refers_to + referenced_keyword_node = referenced_schema.keywords.get(keyword.value) + if referenced_keyword_node: + value = referenced_keyword_node.literal_str + current_node = referenced_schema + + return value + + def schema_keyword_convert_to_str(schema_node: "SchemaNode", keyword: str) -> Optional[str]: """Extract and convert to str from a schema keyword or return None""" keyword_value = schema_node.keywords.get(keyword) diff --git a/tests/generate_test.py b/tests/generate_test.py index a23d6d90..0aa562be 100644 --- a/tests/generate_test.py +++ b/tests/generate_test.py @@ -615,6 +615,7 @@ def test_ref_merge() -> None: """Test case where a schema has elements next to $ref""" soup = generate_case("ref_merge") + tests.html_schema_doc_asserts.assert_soup_select_results_text(soup, "#aProperty > div > h4", ["Title from definition"]) tests.html_schema_doc_asserts.assert_descriptions(soup, ["This is the description from the definition"]) tests.html_schema_doc_asserts.assert_types(soup, ["object", "enum (of string)", "object", "string", "string"]) tests.html_schema_doc_asserts.assert_property_names(soup, ["aProperty", "aDictPropertyARequired", "a", "b"]) diff --git a/tests/html_schema_doc_asserts.py b/tests/html_schema_doc_asserts.py index bda28063..125bdb91 100644 --- a/tests/html_schema_doc_asserts.py +++ b/tests/html_schema_doc_asserts.py @@ -13,6 +13,16 @@ def assert_soup_results_text(soup: BeautifulSoup, class_name: str, texts: List[s assert elements_text == texts +def assert_soup_select_results_text(soup: BeautifulSoup, selector: str, texts: List[str]) -> None: + """Assert that all the HTML elements selected by the provided CSS selector has the supplied text + + There must be exactly as many elements as the length of the supplied values and they must be in the same order + """ + elements_text = [element.text.strip() for element in soup.select(selector)] + + assert elements_text == texts + + def assert_property_names(soup: BeautifulSoup, property_names: List[str]) -> None: assert_soup_results_text(soup, "property-name", property_names) From 6484198ae39220c39506eb286cea3fd47b10363d Mon Sep 17 00:00:00 2001 From: Denis Blanchette Date: Fri, 29 Nov 2024 14:21:32 -0500 Subject: [PATCH 2/2] chore: black --- tests/generate_test.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tests/generate_test.py b/tests/generate_test.py index be475158..3eb83aa7 100644 --- a/tests/generate_test.py +++ b/tests/generate_test.py @@ -615,7 +615,9 @@ def test_ref_merge() -> None: """Test case where a schema has elements next to $ref""" soup = generate_case("ref_merge") - tests.html_schema_doc_asserts.assert_soup_select_results_text(soup, "#aProperty > div > h4", ["Title from definition"]) + tests.html_schema_doc_asserts.assert_soup_select_results_text( + soup, "#aProperty > div > h4", ["Title from definition"] + ) tests.html_schema_doc_asserts.assert_descriptions(soup, ["This is the description from the definition"]) tests.html_schema_doc_asserts.assert_types(soup, ["object", "enum (of string)", "object", "string", "string"]) tests.html_schema_doc_asserts.assert_property_names(soup, ["aProperty", "aDictPropertyARequired", "a", "b"])