diff --git a/docs/examples/cases/basic.json b/docs/examples/cases/basic.json index ec424fc7..99e30209 100644 --- a/docs/examples/cases/basic.json +++ b/docs/examples/cases/basic.json @@ -25,6 +25,10 @@ {"type": "null", "title": "no driver licence"}, {"type": "string", "title": "driver licence id"} ] + }, + "middleName": { + "type": "string", + "title": "Middle Name" } } } \ No newline at end of file diff --git a/docs/examples/examples_flat_default/basic.html b/docs/examples/examples_flat_default/basic.html index 85a70b92..86e63902 100644 --- a/docs/examples/examples_flat_default/basic.html +++ b/docs/examples/examples_flat_default/basic.html @@ -277,6 +277,43 @@

+
+

+ middleName

+
+ +
+ +
root + + + + middleName
Type: string
+ + + + + + + + + + + + + + + + + +
diff --git a/docs/examples/examples_js_default/basic.html b/docs/examples/examples_js_default/basic.html index a5789621..b5f69c44 100644 --- a/docs/examples/examples_js_default/basic.html +++ b/docs/examples/examples_js_default/basic.html @@ -238,6 +238,39 @@

+ + + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + middleName

Middle Name

Type: string
+ + + + + + +
diff --git a/docs/examples/examples_js_offline_default/basic.html b/docs/examples/examples_js_offline_default/basic.html index 537d1a54..fe2da62c 100644 --- a/docs/examples/examples_js_offline_default/basic.html +++ b/docs/examples/examples_js_offline_default/basic.html @@ -238,6 +238,39 @@

+

+ + + +
+
+
+

+ +

+
+ +
+
+ +
root + + + + middleName

Middle Name

Type: string
+ + + + + + +
diff --git a/docs/examples/examples_md_default/basic.md b/docs/examples/examples_md_default/basic.md index 52f8dca9..b87279e1 100644 --- a/docs/examples/examples_md_default/basic.md +++ b/docs/examples/examples_md_default/basic.md @@ -6,6 +6,7 @@ - [4. Property `Person > driverLicenseId`](#driverLicenseId) - [4.1. Property `Person > driverLicenseId > allOf > no driver licence`](#driverLicenseId_allOf_i0) - [4.2. Property `Person > driverLicenseId > allOf > driver licence id`](#driverLicenseId_allOf_i1) +- [5. Property `Person > middleName`](#middleName) **Title:** Person @@ -15,12 +16,13 @@ | **Required** | No | | **Additional properties** | Any type allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------- | -| - [firstName](#firstName ) | No | string | No | - | Person | -| - [lastName](#lastName ) | No | string | No | - | Person | -| - [age](#age ) | No | integer | No | - | Person | -| - [driverLicenseId](#driverLicenseId ) | No | Combination | No | - | - | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------- | ------- | ----------- | ---------- | ---------- | -------------------------------- | +| - [firstName](#firstName ) | No | string | No | - | Person [(read more)](#firstName) | +| - [lastName](#lastName ) | No | string | No | - | Person [(read more)](#lastName) | +| - [age](#age ) | No | integer | No | - | Person [(read more)](#age) | +| - [driverLicenseId](#driverLicenseId ) | No | Combination | No | - | - | +| - [middleName](#middleName ) | No | string | No | - | Middle Name | ## 1. Property `Person > firstName` @@ -90,5 +92,14 @@ | **Type** | `string` | | **Required** | No | +## 5. Property `Person > middleName` + +**Title:** Middle Name + +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) diff --git a/docs/examples/examples_md_default/broken_ref.md b/docs/examples/examples_md_default/broken_ref.md index 1ee159aa..c0f82145 100644 --- a/docs/examples/examples_md_default/broken_ref.md +++ b/docs/examples/examples_md_default/broken_ref.md @@ -13,7 +13,7 @@ | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------- | ------- | ------ | ---------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- | -| - [firstName](#firstName ) | No | string | No | - | Person | +| - [firstName](#firstName ) | No | string | No | - | Person [(read more)](#firstName) | | - [lastName](#lastName ) | No | object | No | In a_file_that_does_not_exist_and_will_never_i_hope.lol.json | 😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️ | ## 1. Property `Person > firstName` diff --git a/docs/examples/examples_md_default/html_in_description.md b/docs/examples/examples_md_default/html_in_description.md index dee394b1..bfe12161 100644 --- a/docs/examples/examples_md_default/html_in_description.md +++ b/docs/examples/examples_md_default/html_in_description.md @@ -12,11 +12,11 @@ | **Required** | No | | **Additional properties** | Any type allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------- | -| - [raw_html](#raw_html ) | No | string | No | - | Some raw HTML | -| - [html_in_markdown](#html_in_markdown ) | No | string | No | - | Some HTML in Markdown | -| - [json_in_markdown](#json_in_markdown ) | No | string | No | - | Some JSON in Markdown | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------ | +| - [raw_html](#raw_html ) | No | string | No | - | Some raw HTML [(read more)](#raw_html) | +| - [html_in_markdown](#html_in_markdown ) | No | string | No | - | Some HTML in Markdown [(read more)](#html_in_markdown) | +| - [json_in_markdown](#json_in_markdown ) | No | string | No | - | Some JSON in Markdown [(read more)](#json_in_markdown) | ## 1. Property `HTML in descriptions > raw_html` diff --git a/docs/examples/examples_md_default/pattern_properties.md b/docs/examples/examples_md_default/pattern_properties.md index 44ed5597..b6e83755 100644 --- a/docs/examples/examples_md_default/pattern_properties.md +++ b/docs/examples/examples_md_default/pattern_properties.md @@ -14,11 +14,11 @@ | **Required** | No | | **Additional properties** | Any type allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | -| - [firstName](#firstName ) | No | string | No | - | Person | -| - [lastName](#lastName ) | No | string | No | - | Person | -| - [$[a-c][0-9]^](#pattern1 ) | Yes | object | No | - | paperSize | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------- | +| - [firstName](#firstName ) | No | string | No | - | Person [(read more)](#firstName) | +| - [lastName](#lastName ) | No | string | No | - | Person [(read more)](#lastName) | +| - [$[a-c][0-9]^](#pattern1 ) | Yes | object | No | - | paperSize [(read more)](#pattern1) | ## 1. Property `Person > firstName` @@ -57,10 +57,10 @@ must respect the following conditions **Description:** Review of a paper size. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------- | ------- | ------- | ---------- | ---------- | ----------------- | -| + [rating](#pattern1_rating ) | No | integer | No | - | Rating | -| + [review](#pattern1_review ) | No | string | No | - | Review | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------- | ------- | ------- | ---------- | ---------- | -------------------------------------- | +| + [rating](#pattern1_rating ) | No | integer | No | - | Rating [(read more)](#pattern1_rating) | +| + [review](#pattern1_review ) | No | string | No | - | Review [(read more)](#pattern1_review) | ### 3.1. Property `Person > paperSize > rating` diff --git a/docs/examples/examples_md_default/pattern_properties_html_id.md b/docs/examples/examples_md_default/pattern_properties_html_id.md index 3e26b9f5..d9524937 100644 --- a/docs/examples/examples_md_default/pattern_properties_html_id.md +++ b/docs/examples/examples_md_default/pattern_properties_html_id.md @@ -14,12 +14,12 @@ | **Required** | No | | **Additional properties** | Any type allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | -| - [not_a_pattern](#not_a_pattern ) | No | object | No | - | - | -| - [.*](#pattern1 ) | Yes | object | No | - | Title 1 | -| - [..](#pattern2 ) | Yes | object | No | - | Title 2 | -| - [^.](#pattern3 ) | Yes | object | No | - | Title 3 | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------- | +| - [not_a_pattern](#not_a_pattern ) | No | object | No | - | - | +| - [.*](#pattern1 ) | Yes | object | No | - | Title 1 [(read more)](#pattern1) | +| - [..](#pattern2 ) | Yes | object | No | - | Title 2 [(read more)](#pattern2) | +| - [^.](#pattern3 ) | Yes | object | No | - | Title 3 [(read more)](#pattern3) | ## 1. Property `Person > not_a_pattern` @@ -29,9 +29,9 @@ | **Required** | No | | **Additional properties** | Any type allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | -| - [.$](#not_a_pattern_pattern1 ) | Yes | object | No | - | Title 4 | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------- | +| - [.$](#not_a_pattern_pattern1 ) | Yes | object | No | - | Title 4 [(read more)](#not_a_pattern_pattern1) | ### 1.1. Pattern Property `Person > not_a_pattern > Title 4` > All properties whose name matches the regular expression diff --git a/docs/examples/examples_md_default/recursive_full_schema.md b/docs/examples/examples_md_default/recursive_full_schema.md index 789a2b86..a91876fb 100644 --- a/docs/examples/examples_md_default/recursive_full_schema.md +++ b/docs/examples/examples_md_default/recursive_full_schema.md @@ -96,10 +96,10 @@ | **Required** | No | | **Additional properties** | Any type 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 ) | Bug | +| 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 [(read more)](#DecoratedRecursiveArray_items_TheThing) | #### 3.1.1. Property `Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > SomeName` diff --git a/docs/examples/examples_md_default/ref_merge.md b/docs/examples/examples_md_default/ref_merge.md index 32a2e277..e77cb99b 100644 --- a/docs/examples/examples_md_default/ref_merge.md +++ b/docs/examples/examples_md_default/ref_merge.md @@ -13,10 +13,10 @@ | **Required** | No | | **Additional properties** | Any type allowed | -| 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 | - | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------------ | ----------------------------------------------- | +| - [aProperty](#aProperty ) | No | enum (of string) | No | In #/definitions/aProperty | Title from definition [(read more)](#aProperty) | +| - [aDictPropertyARequired](#aDictPropertyARequired ) | No | object | No | In #/definitions/aDictProperty | - | ## 1. Property `Test > aProperty` diff --git a/docs/examples/examples_md_default/ref_with_tabs.md b/docs/examples/examples_md_default/ref_with_tabs.md index 02c71cf1..0d156611 100644 --- a/docs/examples/examples_md_default/ref_with_tabs.md +++ b/docs/examples/examples_md_default/ref_with_tabs.md @@ -175,9 +175,9 @@ | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- | -| - [signers](#objectA_signature_oneOf_i0_signers ) | No | array | No | - | Signature | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------- | ------- | ----- | ---------- | ---------- | ------------------------------------------------------------ | +| - [signers](#objectA_signature_oneOf_i0_signers ) | No | array | No | - | Signature [(read more)](#objectA_signature_oneOf_i0_signers) | ##### 1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers` @@ -213,14 +213,14 @@ | **Additional properties** | Not allowed | | **Defined in** | #/definitions/signer | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------- | -| + [algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm ) | No | Combination | No | - | - | -| - [keyId](#objectA_signature_oneOf_i0_signers_items_keyId ) | No | string | No | - | Key ID | -| - [publicKey](#objectA_signature_oneOf_i0_signers_items_publicKey ) | No | object | No | In #/definitions/publicKey | Public key | -| - [certificatePath](#objectA_signature_oneOf_i0_signers_items_certificatePath ) | No | array of string | No | - | Certificate path | -| - [excludes](#objectA_signature_oneOf_i0_signers_items_excludes ) | No | array of string | No | - | Excludes | -| + [value](#objectA_signature_oneOf_i0_signers_items_value ) | No | string | No | - | Signature | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------------------------------------------------------------------------------- | +| + [algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm ) | No | Combination | No | - | - | +| - [keyId](#objectA_signature_oneOf_i0_signers_items_keyId ) | No | string | No | - | Key ID [(read more)](#objectA_signature_oneOf_i0_signers_items_keyId) | +| - [publicKey](#objectA_signature_oneOf_i0_signers_items_publicKey ) | No | object | No | In #/definitions/publicKey | Public key [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey) | +| - [certificatePath](#objectA_signature_oneOf_i0_signers_items_certificatePath ) | No | array of string | No | - | Certificate path [(read more)](#objectA_signature_oneOf_i0_signers_items_certificatePath) | +| - [excludes](#objectA_signature_oneOf_i0_signers_items_excludes ) | No | array of string | No | - | Excludes [(read more)](#objectA_signature_oneOf_i0_signers_items_excludes) | +| + [value](#objectA_signature_oneOf_i0_signers_items_value ) | No | string | No | - | Signature [(read more)](#objectA_signature_oneOf_i0_signers_items_value) | ###### 1.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm` @@ -298,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 | -| - [](#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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_kty) | +| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | | All of(Requirement) | | ---------------------------------------------------------------------- | @@ -325,12 +325,12 @@ Must be one of: | **Required** | No | | **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 | -| + [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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty) | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv) | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x) | +| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y) | ###### 1.1.1.1.1.3.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty` @@ -398,11 +398,11 @@ Must be one of: | **Required** | No | | **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 | -| + [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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty) | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv) | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x) | ###### 1.1.1.1.1.3.2.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty` @@ -458,11 +458,11 @@ Must be one of: | **Required** | No | | **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 | -| + [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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty) | +| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n) | +| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e) | ###### 1.1.1.1.1.3.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty` @@ -594,9 +594,9 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| --------------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- | -| - [chain](#objectA_signature_oneOf_i1_chain ) | No | array | No | - | Signature | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------- | ------- | ----- | ---------- | ---------- | ---------------------------------------------------------- | +| - [chain](#objectA_signature_oneOf_i1_chain ) | No | array | No | - | Signature [(read more)](#objectA_signature_oneOf_i1_chain) | ##### 1.1.2.1. Property `root > objectA > signature > oneOf > item 1 > chain` @@ -645,14 +645,14 @@ Must be one of: **Description:** Unique top level property for simple signatures. (signaturecore) -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------- | -| + [algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm ) | No | Combination | No | - | - | -| - [keyId](#objectA_signature_oneOf_i0_signers_items_keyId ) | No | string | No | - | Key ID | -| - [publicKey](#objectA_signature_oneOf_i0_signers_items_publicKey ) | No | object | No | In #/definitions/publicKey | Public key | -| - [certificatePath](#objectA_signature_oneOf_i0_signers_items_certificatePath ) | No | array of string | No | - | Certificate path | -| - [excludes](#objectA_signature_oneOf_i0_signers_items_excludes ) | No | array of string | No | - | Excludes | -| + [value](#objectA_signature_oneOf_i0_signers_items_value ) | No | string | No | - | Signature | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------------------------------------------------------------------------------- | +| + [algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm ) | No | Combination | No | - | - | +| - [keyId](#objectA_signature_oneOf_i0_signers_items_keyId ) | No | string | No | - | Key ID [(read more)](#objectA_signature_oneOf_i0_signers_items_keyId) | +| - [publicKey](#objectA_signature_oneOf_i0_signers_items_publicKey ) | No | object | No | In #/definitions/publicKey | Public key [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey) | +| - [certificatePath](#objectA_signature_oneOf_i0_signers_items_certificatePath ) | No | array of string | No | - | Certificate path [(read more)](#objectA_signature_oneOf_i0_signers_items_certificatePath) | +| - [excludes](#objectA_signature_oneOf_i0_signers_items_excludes ) | No | array of string | No | - | Excludes [(read more)](#objectA_signature_oneOf_i0_signers_items_excludes) | +| + [value](#objectA_signature_oneOf_i0_signers_items_value ) | No | string | No | - | Signature [(read more)](#objectA_signature_oneOf_i0_signers_items_value) | ##### 1.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm` @@ -730,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 | -| - [](#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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_kty) | +| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | | All of(Requirement) | | ---------------------------------------------------------------------- | @@ -757,12 +757,12 @@ Must be one of: | **Required** | No | | **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 | -| + [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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty) | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv) | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x) | +| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y) | ###### 1.1.3.3.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty` @@ -830,11 +830,11 @@ Must be one of: | **Required** | No | | **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 | -| + [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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty) | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv) | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x) | ###### 1.1.3.3.2.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty` @@ -890,11 +890,11 @@ Must be one of: | **Required** | No | | **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 | -| + [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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty) | +| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n) | +| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e) | ###### 1.1.3.3.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty` @@ -1055,9 +1055,9 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- | -| - [signers](#objectA_signature_oneOf_i0_signers ) | No | array | No | - | Signature | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------- | ------- | ----- | ---------- | ---------- | ------------------------------------------------------------ | +| - [signers](#objectA_signature_oneOf_i0_signers ) | No | array | No | - | Signature [(read more)](#objectA_signature_oneOf_i0_signers) | ##### 2.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers` @@ -1093,14 +1093,14 @@ Must be one of: | **Additional properties** | Not allowed | | **Defined in** | #/definitions/signer | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------- | -| + [algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm ) | No | Combination | No | - | - | -| - [keyId](#objectA_signature_oneOf_i0_signers_items_keyId ) | No | string | No | - | Key ID | -| - [publicKey](#objectA_signature_oneOf_i0_signers_items_publicKey ) | No | object | No | In #/definitions/publicKey | Public key | -| - [certificatePath](#objectA_signature_oneOf_i0_signers_items_certificatePath ) | No | array of string | No | - | Certificate path | -| - [excludes](#objectA_signature_oneOf_i0_signers_items_excludes ) | No | array of string | No | - | Excludes | -| + [value](#objectA_signature_oneOf_i0_signers_items_value ) | No | string | No | - | Signature | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------------------------------------------------------------------------------- | +| + [algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm ) | No | Combination | No | - | - | +| - [keyId](#objectA_signature_oneOf_i0_signers_items_keyId ) | No | string | No | - | Key ID [(read more)](#objectA_signature_oneOf_i0_signers_items_keyId) | +| - [publicKey](#objectA_signature_oneOf_i0_signers_items_publicKey ) | No | object | No | In #/definitions/publicKey | Public key [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey) | +| - [certificatePath](#objectA_signature_oneOf_i0_signers_items_certificatePath ) | No | array of string | No | - | Certificate path [(read more)](#objectA_signature_oneOf_i0_signers_items_certificatePath) | +| - [excludes](#objectA_signature_oneOf_i0_signers_items_excludes ) | No | array of string | No | - | Excludes [(read more)](#objectA_signature_oneOf_i0_signers_items_excludes) | +| + [value](#objectA_signature_oneOf_i0_signers_items_value ) | No | string | No | - | Signature [(read more)](#objectA_signature_oneOf_i0_signers_items_value) | ###### 2.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm` @@ -1178,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 | -| - [](#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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_kty) | +| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | | All of(Requirement) | | ---------------------------------------------------------------------- | @@ -1205,12 +1205,12 @@ Must be one of: | **Required** | No | | **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 | -| + [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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty) | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv) | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x) | +| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y) | ###### 2.1.1.1.1.3.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty` @@ -1278,11 +1278,11 @@ Must be one of: | **Required** | No | | **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 | -| + [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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty) | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv) | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x) | ###### 2.1.1.1.1.3.2.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty` @@ -1338,11 +1338,11 @@ Must be one of: | **Required** | No | | **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 | -| + [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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty) | +| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n) | +| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e) | ###### 2.1.1.1.1.3.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty` @@ -1474,9 +1474,9 @@ Must be one of: | **Required** | No | | **Additional properties** | Not allowed | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| --------------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- | -| - [chain](#objectA_signature_oneOf_i1_chain ) | No | array | No | - | Signature | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------- | ------- | ----- | ---------- | ---------- | ---------------------------------------------------------- | +| - [chain](#objectA_signature_oneOf_i1_chain ) | No | array | No | - | Signature [(read more)](#objectA_signature_oneOf_i1_chain) | ##### 2.1.2.1. Property `root > objectA > signature > oneOf > item 1 > chain` @@ -1525,14 +1525,14 @@ Must be one of: **Description:** Unique top level property for simple signatures. (signaturecore) -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------- | -| + [algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm ) | No | Combination | No | - | - | -| - [keyId](#objectA_signature_oneOf_i0_signers_items_keyId ) | No | string | No | - | Key ID | -| - [publicKey](#objectA_signature_oneOf_i0_signers_items_publicKey ) | No | object | No | In #/definitions/publicKey | Public key | -| - [certificatePath](#objectA_signature_oneOf_i0_signers_items_certificatePath ) | No | array of string | No | - | Certificate path | -| - [excludes](#objectA_signature_oneOf_i0_signers_items_excludes ) | No | array of string | No | - | Excludes | -| + [value](#objectA_signature_oneOf_i0_signers_items_value ) | No | string | No | - | Signature | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------------------------------------------------------------------------------- | +| + [algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm ) | No | Combination | No | - | - | +| - [keyId](#objectA_signature_oneOf_i0_signers_items_keyId ) | No | string | No | - | Key ID [(read more)](#objectA_signature_oneOf_i0_signers_items_keyId) | +| - [publicKey](#objectA_signature_oneOf_i0_signers_items_publicKey ) | No | object | No | In #/definitions/publicKey | Public key [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey) | +| - [certificatePath](#objectA_signature_oneOf_i0_signers_items_certificatePath ) | No | array of string | No | - | Certificate path [(read more)](#objectA_signature_oneOf_i0_signers_items_certificatePath) | +| - [excludes](#objectA_signature_oneOf_i0_signers_items_excludes ) | No | array of string | No | - | Excludes [(read more)](#objectA_signature_oneOf_i0_signers_items_excludes) | +| + [value](#objectA_signature_oneOf_i0_signers_items_value ) | No | string | No | - | Signature [(read more)](#objectA_signature_oneOf_i0_signers_items_value) | ##### 2.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm` @@ -1610,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 | -| - [](#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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_kty) | +| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | | All of(Requirement) | | ---------------------------------------------------------------------- | @@ -1637,12 +1637,12 @@ Must be one of: | **Required** | No | | **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 | -| + [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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty) | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv) | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x) | +| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y) | ###### 2.1.3.3.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty` @@ -1710,11 +1710,11 @@ Must be one of: | **Required** | No | | **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 | -| + [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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty) | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv) | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x) | ###### 2.1.3.3.2.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty` @@ -1770,11 +1770,11 @@ Must be one of: | **Required** | No | | **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 | -| + [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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty) | +| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n) | +| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e) | ###### 2.1.3.3.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty` diff --git a/docs/examples/examples_md_default/references_url.md b/docs/examples/examples_md_default/references_url.md index 7730bf99..fce18ce9 100644 --- a/docs/examples/examples_md_default/references_url.md +++ b/docs/examples/examples_md_default/references_url.md @@ -10,9 +10,9 @@ **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 | Person | +| 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 [(read more)](#firstName) | ## 1. Property `root > firstName` diff --git a/docs/examples/examples_md_default/with_examples.md b/docs/examples/examples_md_default/with_examples.md index 4ee46891..64aa3a4f 100644 --- a/docs/examples/examples_md_default/with_examples.md +++ b/docs/examples/examples_md_default/with_examples.md @@ -15,9 +15,9 @@ | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------- | ------- | ------- | ---------- | ---------- | ----------------------------------- | -| - [firstName](#firstName ) | No | string | No | - | Person | -| - [lastName](#lastName ) | No | string | No | - | Person | -| - [age](#age ) | No | integer | No | - | Person | +| - [firstName](#firstName ) | No | string | No | - | Person [(read more)](#firstName) | +| - [lastName](#lastName ) | No | string | No | - | Person [(read more)](#lastName) | +| - [age](#age ) | No | integer | No | - | Person [(read more)](#age) | | - [moreInfo](#moreInfo ) | No | object | No | - | Any more info you want as an object | ## 1. Property `Person > firstName` diff --git a/docs/examples/examples_md_nested_default/basic.md b/docs/examples/examples_md_nested_default/basic.md index e74b0f0a..b0021db7 100644 --- a/docs/examples/examples_md_nested_default/basic.md +++ b/docs/examples/examples_md_nested_default/basic.md @@ -6,6 +6,7 @@ - [4. [Optional] Property Person > driverLicenseId](#driverLicenseId) - [4.1. Property `Person > driverLicenseId > allOf > no driver licence`](#driverLicenseId_allOf_i0) - [4.2. Property `Person > driverLicenseId > allOf > driver licence id`](#driverLicenseId_allOf_i1) +- [5. [Optional] Property Person > middleName](#middleName) **Title:** Person @@ -126,5 +127,22 @@ +
+ + 5. [Optional] Property Person > middleName + + +
+ +**Title:** Middle Name + +| | | +| ------------ | -------- | +| **Type** | `string` | +| **Required** | No | + +
+
+ ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) \ No newline at end of file diff --git a/docs/examples/examples_md_nested_with_badges/basic.md b/docs/examples/examples_md_nested_with_badges/basic.md index bf871d45..d9f9fb05 100644 --- a/docs/examples/examples_md_nested_with_badges/basic.md +++ b/docs/examples/examples_md_nested_with_badges/basic.md @@ -6,6 +6,7 @@ - [4. [Optional] Property Person > driverLicenseId](#driverLicenseId) - [4.1. Property `Person > driverLicenseId > allOf > no driver licence`](#driverLicenseId_allOf_i0) - [4.2. Property `Person > driverLicenseId > allOf > driver licence id`](#driverLicenseId_allOf_i1) +- [5. [Optional] Property Person > middleName](#middleName) **Title:** Person @@ -119,5 +120,21 @@ +
+ + 5. [Optional] Property Person > middleName + + +
+ +**Title:** Middle Name + +| | | +| -------- | -------- | +| **Type** | `string` | + +
+
+ ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) \ No newline at end of file diff --git a/docs/examples/examples_md_with_badges/basic.md b/docs/examples/examples_md_with_badges/basic.md index 9395b4d6..8a0750cc 100644 --- a/docs/examples/examples_md_with_badges/basic.md +++ b/docs/examples/examples_md_with_badges/basic.md @@ -6,6 +6,7 @@ - [4. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > driverLicenseId`](#driverLicenseId) - [4.1. Property `Person > driverLicenseId > allOf > no driver licence`](#driverLicenseId_allOf_i0) - [4.2. Property `Person > driverLicenseId > allOf > driver licence id`](#driverLicenseId_allOf_i1) +- [5. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > middleName`](#middleName) **Title:** Person @@ -14,12 +15,13 @@ | **Type** | `object` | | **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------------- | ------- | ----------- | ---------- | ---------- | ----------------- | -| - [firstName](#firstName ) | No | string | No | - | Person | -| - [lastName](#lastName ) | No | string | No | - | Person | -| - [age](#age ) | No | integer | No | - | Person | -| - [driverLicenseId](#driverLicenseId ) | No | Combination | No | - | - | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------------- | ------- | ----------- | ---------- | ---------- | -------------------------------- | +| - [firstName](#firstName ) | No | string | No | - | Person [(read more)](#firstName) | +| - [lastName](#lastName ) | No | string | No | - | Person [(read more)](#lastName) | +| - [age](#age ) | No | integer | No | - | Person [(read more)](#age) | +| - [driverLicenseId](#driverLicenseId ) | No | Combination | No | - | - | +| - [middleName](#middleName ) | No | string | No | - | Middle Name | ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > firstName` @@ -83,5 +85,13 @@ | -------- | -------- | | **Type** | `string` | +## 5. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > middleName` + +**Title:** Middle Name + +| | | +| -------- | -------- | +| **Type** | `string` | + ---------------------------------------------------------------------------------------------------------------------------- Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans) diff --git a/docs/examples/examples_md_with_badges/broken_ref.md b/docs/examples/examples_md_with_badges/broken_ref.md index 105974ef..cde3973e 100644 --- a/docs/examples/examples_md_with_badges/broken_ref.md +++ b/docs/examples/examples_md_with_badges/broken_ref.md @@ -12,7 +12,7 @@ | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------- | ------- | ------ | ---------- | ------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- | -| - [firstName](#firstName ) | No | string | No | - | Person | +| - [firstName](#firstName ) | No | string | No | - | Person [(read more)](#firstName) | | - [lastName](#lastName ) | No | object | No | In a_file_that_does_not_exist_and_will_never_i_hope.lol.json | 😅 ERROR in schema generation, a referenced schema could not be loaded, no documentation here unfortunately 🏜️ | ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > firstName` diff --git a/docs/examples/examples_md_with_badges/html_in_description.md b/docs/examples/examples_md_with_badges/html_in_description.md index 64b0dd8b..6f4384a4 100644 --- a/docs/examples/examples_md_with_badges/html_in_description.md +++ b/docs/examples/examples_md_with_badges/html_in_description.md @@ -11,11 +11,11 @@ | **Type** | `object` | | **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------------------- | ------- | ------ | ---------- | ---------- | --------------------- | -| - [raw_html](#raw_html ) | No | string | No | - | Some raw HTML | -| - [html_in_markdown](#html_in_markdown ) | No | string | No | - | Some HTML in Markdown | -| - [json_in_markdown](#json_in_markdown ) | No | string | No | - | Some JSON in Markdown | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------- | ------- | ------ | ---------- | ---------- | ------------------------------------------------------ | +| - [raw_html](#raw_html ) | No | string | No | - | Some raw HTML [(read more)](#raw_html) | +| - [html_in_markdown](#html_in_markdown ) | No | string | No | - | Some HTML in Markdown [(read more)](#html_in_markdown) | +| - [json_in_markdown](#json_in_markdown ) | No | string | No | - | Some JSON in Markdown [(read more)](#json_in_markdown) | ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `HTML in descriptions > raw_html` diff --git a/docs/examples/examples_md_with_badges/pattern_properties.md b/docs/examples/examples_md_with_badges/pattern_properties.md index e0e417ab..18f7e872 100644 --- a/docs/examples/examples_md_with_badges/pattern_properties.md +++ b/docs/examples/examples_md_with_badges/pattern_properties.md @@ -13,11 +13,11 @@ | **Type** | `object` | | **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | -| - [firstName](#firstName ) | No | string | No | - | Person | -| - [lastName](#lastName ) | No | string | No | - | Person | -| - [$[a-c][0-9]^](#pattern1 ) | Yes | object | No | - | paperSize | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------- | +| - [firstName](#firstName ) | No | string | No | - | Person [(read more)](#firstName) | +| - [lastName](#lastName ) | No | string | No | - | Person [(read more)](#lastName) | +| - [$[a-c][0-9]^](#pattern1 ) | Yes | object | No | - | paperSize [(read more)](#pattern1) | ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > firstName` @@ -53,10 +53,10 @@ must respect the following conditions **Description:** Review of a paper size. -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ----------------------------- | ------- | ------- | ---------- | ---------- | ----------------- | -| + [rating](#pattern1_rating ) | No | integer | No | - | Rating | -| + [review](#pattern1_review ) | No | string | No | - | Review | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ----------------------------- | ------- | ------- | ---------- | ---------- | -------------------------------------- | +| + [rating](#pattern1_rating ) | No | integer | No | - | Rating [(read more)](#pattern1_rating) | +| + [review](#pattern1_review ) | No | string | No | - | Review [(read more)](#pattern1_review) | ### 3.1. ![Required](https://img.shields.io/badge/Required-blue) Property `Person > paperSize > rating` diff --git a/docs/examples/examples_md_with_badges/pattern_properties_html_id.md b/docs/examples/examples_md_with_badges/pattern_properties_html_id.md index a574418e..1b8d293e 100644 --- a/docs/examples/examples_md_with_badges/pattern_properties_html_id.md +++ b/docs/examples/examples_md_with_badges/pattern_properties_html_id.md @@ -13,12 +13,12 @@ | **Type** | `object` | | **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ---------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | -| - [not_a_pattern](#not_a_pattern ) | No | object | No | - | - | -| - [.*](#pattern1 ) | Yes | object | No | - | Title 1 | -| - [..](#pattern2 ) | Yes | object | No | - | Title 2 | -| - [^.](#pattern3 ) | Yes | object | No | - | Title 3 | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------- | ------- | ------ | ---------- | ---------- | -------------------------------- | +| - [not_a_pattern](#not_a_pattern ) | No | object | No | - | - | +| - [.*](#pattern1 ) | Yes | object | No | - | Title 1 [(read more)](#pattern1) | +| - [..](#pattern2 ) | Yes | object | No | - | Title 2 [(read more)](#pattern2) | +| - [^.](#pattern3 ) | Yes | object | No | - | Title 3 [(read more)](#pattern3) | ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > not_a_pattern` @@ -27,9 +27,9 @@ | **Type** | `object` | | **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| -------------------------------- | ------- | ------ | ---------- | ---------- | ----------------- | -| - [.$](#not_a_pattern_pattern1 ) | Yes | object | No | - | Title 4 | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| -------------------------------- | ------- | ------ | ---------- | ---------- | ---------------------------------------------- | +| - [.$](#not_a_pattern_pattern1 ) | Yes | object | No | - | Title 4 [(read more)](#not_a_pattern_pattern1) | ### 1.1. ![Optional](https://img.shields.io/badge/Optional-yellow) Pattern Property `Person > not_a_pattern > Title 4` > All properties whose name matches the regular expression 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 5b807182..0fecee54 100644 --- a/docs/examples/examples_md_with_badges/recursive_full_schema.md +++ b/docs/examples/examples_md_with_badges/recursive_full_schema.md @@ -90,10 +90,10 @@ | **Type** | `object` | | **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | -| 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 | +| 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 [(read more)](#DecoratedRecursiveArray_items_TheThing) | #### 3.1.1. Property `Bug > DecoratedRecursiveArray > DecoratedRecursiveArray items > SomeName` diff --git a/docs/examples/examples_md_with_badges/ref_merge.md b/docs/examples/examples_md_with_badges/ref_merge.md index 948463f9..62b40d4b 100644 --- a/docs/examples/examples_md_with_badges/ref_merge.md +++ b/docs/examples/examples_md_with_badges/ref_merge.md @@ -12,10 +12,10 @@ | **Type** | `object` | | **Additional properties** | ![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green) | -| 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 | - | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ---------------------------------------------------- | ------- | ---------------- | ---------- | ------------------------------ | ----------------------------------------------- | +| - [aProperty](#aProperty ) | No | enum (of string) | No | In #/definitions/aProperty | Title from definition [(read more)](#aProperty) | +| - [aDictPropertyARequired](#aDictPropertyARequired ) | No | object | No | In #/definitions/aDictProperty | - | ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Test > aProperty` 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 62bed704..279fc02f 100644 --- a/docs/examples/examples_md_with_badges/ref_with_tabs.md +++ b/docs/examples/examples_md_with_badges/ref_with_tabs.md @@ -171,9 +171,9 @@ | **Type** | `object` | | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- | -| - [signers](#objectA_signature_oneOf_i0_signers ) | No | array | No | - | Signature | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------- | ------- | ----- | ---------- | ---------- | ------------------------------------------------------------ | +| - [signers](#objectA_signature_oneOf_i0_signers ) | No | array | No | - | Signature [(read more)](#objectA_signature_oneOf_i0_signers) | ##### 1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers` @@ -207,14 +207,14 @@ | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | **Defined in** | #/definitions/signer | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------- | -| + [algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm ) | No | Combination | No | - | - | -| - [keyId](#objectA_signature_oneOf_i0_signers_items_keyId ) | No | string | No | - | Key ID | -| - [publicKey](#objectA_signature_oneOf_i0_signers_items_publicKey ) | No | object | No | In #/definitions/publicKey | Public key | -| - [certificatePath](#objectA_signature_oneOf_i0_signers_items_certificatePath ) | No | array of string | No | - | Certificate path | -| - [excludes](#objectA_signature_oneOf_i0_signers_items_excludes ) | No | array of string | No | - | Excludes | -| + [value](#objectA_signature_oneOf_i0_signers_items_value ) | No | string | No | - | Signature | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------------------------------------------------------------------------------- | +| + [algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm ) | No | Combination | No | - | - | +| - [keyId](#objectA_signature_oneOf_i0_signers_items_keyId ) | No | string | No | - | Key ID [(read more)](#objectA_signature_oneOf_i0_signers_items_keyId) | +| - [publicKey](#objectA_signature_oneOf_i0_signers_items_publicKey ) | No | object | No | In #/definitions/publicKey | Public key [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey) | +| - [certificatePath](#objectA_signature_oneOf_i0_signers_items_certificatePath ) | No | array of string | No | - | Certificate path [(read more)](#objectA_signature_oneOf_i0_signers_items_certificatePath) | +| - [excludes](#objectA_signature_oneOf_i0_signers_items_excludes ) | No | array of string | No | - | Excludes [(read more)](#objectA_signature_oneOf_i0_signers_items_excludes) | +| + [value](#objectA_signature_oneOf_i0_signers_items_value ) | No | string | No | - | Signature [(read more)](#objectA_signature_oneOf_i0_signers_items_value) | ###### 1.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm` @@ -287,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 | -| - [](#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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_kty) | +| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | | All of(Requirement) | | ---------------------------------------------------------------------- | @@ -312,12 +312,12 @@ Must be one of: | **Type** | `object` | | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | -| 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 | +| 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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty) | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv) | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x) | +| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y) | ###### 1.1.1.1.1.3.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty` @@ -379,11 +379,11 @@ Must be one of: | **Type** | `object` | | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | -| 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 | +| 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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty) | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv) | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x) | ###### 1.1.1.1.1.3.2.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty` @@ -434,11 +434,11 @@ Must be one of: | **Type** | `object` | | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | -| 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 | +| 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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty) | +| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n) | +| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e) | ###### 1.1.1.1.1.3.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty` @@ -560,9 +560,9 @@ Must be one of: | **Type** | `object` | | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| --------------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- | -| - [chain](#objectA_signature_oneOf_i1_chain ) | No | array | No | - | Signature | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------- | ------- | ----- | ---------- | ---------- | ---------------------------------------------------------- | +| - [chain](#objectA_signature_oneOf_i1_chain ) | No | array | No | - | Signature [(read more)](#objectA_signature_oneOf_i1_chain) | ##### 1.1.2.1. Property `root > objectA > signature > oneOf > item 1 > chain` @@ -608,14 +608,14 @@ Must be one of: **Description:** Unique top level property for simple signatures. (signaturecore) -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------- | -| + [algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm ) | No | Combination | No | - | - | -| - [keyId](#objectA_signature_oneOf_i0_signers_items_keyId ) | No | string | No | - | Key ID | -| - [publicKey](#objectA_signature_oneOf_i0_signers_items_publicKey ) | No | object | No | In #/definitions/publicKey | Public key | -| - [certificatePath](#objectA_signature_oneOf_i0_signers_items_certificatePath ) | No | array of string | No | - | Certificate path | -| - [excludes](#objectA_signature_oneOf_i0_signers_items_excludes ) | No | array of string | No | - | Excludes | -| + [value](#objectA_signature_oneOf_i0_signers_items_value ) | No | string | No | - | Signature | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------------------------------------------------------------------------------- | +| + [algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm ) | No | Combination | No | - | - | +| - [keyId](#objectA_signature_oneOf_i0_signers_items_keyId ) | No | string | No | - | Key ID [(read more)](#objectA_signature_oneOf_i0_signers_items_keyId) | +| - [publicKey](#objectA_signature_oneOf_i0_signers_items_publicKey ) | No | object | No | In #/definitions/publicKey | Public key [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey) | +| - [certificatePath](#objectA_signature_oneOf_i0_signers_items_certificatePath ) | No | array of string | No | - | Certificate path [(read more)](#objectA_signature_oneOf_i0_signers_items_certificatePath) | +| - [excludes](#objectA_signature_oneOf_i0_signers_items_excludes ) | No | array of string | No | - | Excludes [(read more)](#objectA_signature_oneOf_i0_signers_items_excludes) | +| + [value](#objectA_signature_oneOf_i0_signers_items_value ) | No | string | No | - | Signature [(read more)](#objectA_signature_oneOf_i0_signers_items_value) | ##### 1.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm` @@ -688,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 | -| - [](#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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_kty) | +| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | | All of(Requirement) | | ---------------------------------------------------------------------- | @@ -713,12 +713,12 @@ Must be one of: | **Type** | `object` | | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | -| 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 | +| 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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty) | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv) | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x) | +| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y) | ###### 1.1.3.3.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty` @@ -780,11 +780,11 @@ Must be one of: | **Type** | `object` | | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | -| 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 | +| 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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty) | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv) | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x) | ###### 1.1.3.3.2.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty` @@ -835,11 +835,11 @@ Must be one of: | **Type** | `object` | | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | -| 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 | +| 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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty) | +| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n) | +| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e) | ###### 1.1.3.3.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty` @@ -988,9 +988,9 @@ Must be one of: | **Type** | `object` | | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- | -| - [signers](#objectA_signature_oneOf_i0_signers ) | No | array | No | - | Signature | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------- | ------- | ----- | ---------- | ---------- | ------------------------------------------------------------ | +| - [signers](#objectA_signature_oneOf_i0_signers ) | No | array | No | - | Signature [(read more)](#objectA_signature_oneOf_i0_signers) | ##### 2.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers` @@ -1024,14 +1024,14 @@ Must be one of: | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | | **Defined in** | #/definitions/signer | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------- | -| + [algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm ) | No | Combination | No | - | - | -| - [keyId](#objectA_signature_oneOf_i0_signers_items_keyId ) | No | string | No | - | Key ID | -| - [publicKey](#objectA_signature_oneOf_i0_signers_items_publicKey ) | No | object | No | In #/definitions/publicKey | Public key | -| - [certificatePath](#objectA_signature_oneOf_i0_signers_items_certificatePath ) | No | array of string | No | - | Certificate path | -| - [excludes](#objectA_signature_oneOf_i0_signers_items_excludes ) | No | array of string | No | - | Excludes | -| + [value](#objectA_signature_oneOf_i0_signers_items_value ) | No | string | No | - | Signature | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------------------------------------------------------------------------------- | +| + [algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm ) | No | Combination | No | - | - | +| - [keyId](#objectA_signature_oneOf_i0_signers_items_keyId ) | No | string | No | - | Key ID [(read more)](#objectA_signature_oneOf_i0_signers_items_keyId) | +| - [publicKey](#objectA_signature_oneOf_i0_signers_items_publicKey ) | No | object | No | In #/definitions/publicKey | Public key [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey) | +| - [certificatePath](#objectA_signature_oneOf_i0_signers_items_certificatePath ) | No | array of string | No | - | Certificate path [(read more)](#objectA_signature_oneOf_i0_signers_items_certificatePath) | +| - [excludes](#objectA_signature_oneOf_i0_signers_items_excludes ) | No | array of string | No | - | Excludes [(read more)](#objectA_signature_oneOf_i0_signers_items_excludes) | +| + [value](#objectA_signature_oneOf_i0_signers_items_value ) | No | string | No | - | Signature [(read more)](#objectA_signature_oneOf_i0_signers_items_value) | ###### 2.1.1.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm` @@ -1104,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 | -| - [](#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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_kty) | +| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | | All of(Requirement) | | ---------------------------------------------------------------------- | @@ -1129,12 +1129,12 @@ Must be one of: | **Type** | `object` | | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | -| 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 | +| 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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty) | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv) | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x) | +| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y) | ###### 2.1.1.1.1.3.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty` @@ -1196,11 +1196,11 @@ Must be one of: | **Type** | `object` | | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | -| 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 | +| 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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty) | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv) | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x) | ###### 2.1.1.1.1.3.2.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty` @@ -1251,11 +1251,11 @@ Must be one of: | **Type** | `object` | | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | -| 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 | +| 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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty) | +| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n) | +| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e) | ###### 2.1.1.1.1.3.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty` @@ -1377,9 +1377,9 @@ Must be one of: | **Type** | `object` | | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| --------------------------------------------- | ------- | ----- | ---------- | ---------- | ----------------- | -| - [chain](#objectA_signature_oneOf_i1_chain ) | No | array | No | - | Signature | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| --------------------------------------------- | ------- | ----- | ---------- | ---------- | ---------------------------------------------------------- | +| - [chain](#objectA_signature_oneOf_i1_chain ) | No | array | No | - | Signature [(read more)](#objectA_signature_oneOf_i1_chain) | ##### 2.1.2.1. Property `root > objectA > signature > oneOf > item 1 > chain` @@ -1425,14 +1425,14 @@ Must be one of: **Description:** Unique top level property for simple signatures. (signaturecore) -| Property | Pattern | Type | Deprecated | Definition | Title/Description | -| ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------- | -| + [algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm ) | No | Combination | No | - | - | -| - [keyId](#objectA_signature_oneOf_i0_signers_items_keyId ) | No | string | No | - | Key ID | -| - [publicKey](#objectA_signature_oneOf_i0_signers_items_publicKey ) | No | object | No | In #/definitions/publicKey | Public key | -| - [certificatePath](#objectA_signature_oneOf_i0_signers_items_certificatePath ) | No | array of string | No | - | Certificate path | -| - [excludes](#objectA_signature_oneOf_i0_signers_items_excludes ) | No | array of string | No | - | Excludes | -| + [value](#objectA_signature_oneOf_i0_signers_items_value ) | No | string | No | - | Signature | +| Property | Pattern | Type | Deprecated | Definition | Title/Description | +| ------------------------------------------------------------------------------- | ------- | --------------- | ---------- | -------------------------- | ----------------------------------------------------------------------------------------- | +| + [algorithm](#objectA_signature_oneOf_i0_signers_items_algorithm ) | No | Combination | No | - | - | +| - [keyId](#objectA_signature_oneOf_i0_signers_items_keyId ) | No | string | No | - | Key ID [(read more)](#objectA_signature_oneOf_i0_signers_items_keyId) | +| - [publicKey](#objectA_signature_oneOf_i0_signers_items_publicKey ) | No | object | No | In #/definitions/publicKey | Public key [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey) | +| - [certificatePath](#objectA_signature_oneOf_i0_signers_items_certificatePath ) | No | array of string | No | - | Certificate path [(read more)](#objectA_signature_oneOf_i0_signers_items_certificatePath) | +| - [excludes](#objectA_signature_oneOf_i0_signers_items_excludes ) | No | array of string | No | - | Excludes [(read more)](#objectA_signature_oneOf_i0_signers_items_excludes) | +| + [value](#objectA_signature_oneOf_i0_signers_items_value ) | No | string | No | - | Signature [(read more)](#objectA_signature_oneOf_i0_signers_items_value) | ##### 2.1.3.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > algorithm` @@ -1505,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 | -| - [](#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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_kty) | +| - [](#objectA_signature_oneOf_i0_signers_items_publicKey_additionalProperties ) | No | object | No | - | - | | All of(Requirement) | | ---------------------------------------------------------------------- | @@ -1530,12 +1530,12 @@ Must be one of: | **Type** | `object` | | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | -| 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 | +| 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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_kty) | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv ) | No | enum (of string) | No | - | Curve name [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_crv) | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_x) | +| + [y](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i0_then_y) | ###### 2.1.3.3.1.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 0 > then > kty` @@ -1597,11 +1597,11 @@ Must be one of: | **Type** | `object` | | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | -| 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 | +| 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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_kty) | +| + [crv](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv ) | No | enum (of string) | No | - | Curve name [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_crv) | +| + [x](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x ) | No | string | No | - | Coordinate [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i1_then_x) | ###### 2.1.3.3.2.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 1 > then > kty` @@ -1652,11 +1652,11 @@ Must be one of: | **Type** | `object` | | **Additional properties** | ![Not allowed](https://img.shields.io/badge/Not%20allowed-red) | -| 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 | +| 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 [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_kty) | +| + [n](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n ) | No | string | No | - | Modulus [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_n) | +| + [e](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e ) | No | string | No | - | Exponent [(read more)](#objectA_signature_oneOf_i0_signers_items_publicKey_allOf_i2_then_e) | ###### 2.1.3.3.3.1.1. Property `root > objectA > signature > oneOf > item 0 > signers > Signature > publicKey > allOf > item 2 > then > kty` diff --git a/docs/examples/examples_md_with_badges/references_url.md b/docs/examples/examples_md_with_badges/references_url.md index 6f3bea7e..65698e39 100644 --- a/docs/examples/examples_md_with_badges/references_url.md +++ b/docs/examples/examples_md_with_badges/references_url.md @@ -9,9 +9,9 @@ **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 | Person | +| 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 [(read more)](#firstName) | ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `root > firstName` diff --git a/docs/examples/examples_md_with_badges/with_examples.md b/docs/examples/examples_md_with_badges/with_examples.md index 65dea44c..dbd1bb71 100644 --- a/docs/examples/examples_md_with_badges/with_examples.md +++ b/docs/examples/examples_md_with_badges/with_examples.md @@ -14,9 +14,9 @@ | Property | Pattern | Type | Deprecated | Definition | Title/Description | | -------------------------- | ------- | ------- | ---------- | ---------- | ----------------------------------- | -| - [firstName](#firstName ) | No | string | No | - | Person | -| - [lastName](#lastName ) | No | string | No | - | Person | -| - [age](#age ) | No | integer | No | - | Person | +| - [firstName](#firstName ) | No | string | No | - | Person [(read more)](#firstName) | +| - [lastName](#lastName ) | No | string | No | - | Person [(read more)](#lastName) | +| - [age](#age ) | No | integer | No | - | Person [(read more)](#age) | | - [moreInfo](#moreInfo ) | No | object | No | - | Any more info you want as an object | ## 1. ![Optional](https://img.shields.io/badge/Optional-yellow) Property `Person > firstName` diff --git a/json_schema_for_humans/md_template.py b/json_schema_for_humans/md_template.py index e751e90b..bd9e2cee 100644 --- a/json_schema_for_humans/md_template.py +++ b/json_schema_for_humans/md_template.py @@ -358,9 +358,15 @@ def properties_table(self, schema: SchemaNode) -> List[List]: line.append("-") elif field == "Title/Description": # title or description - description = sub_property.description or "-" - if sub_property.title: + if sub_property.title and sub_property.description: + # Both title and description exist - show title with read more link + description = f"{sub_property.title} [(read more)](#{sub_property.html_id})" + elif sub_property.title: + # Only title exists description = sub_property.title + else: + # Only description exists (or neither) + description = sub_property.description or "-" line.append(escape_for_table(description)) else: raise ValueError(f"Unknown field {field} for properties table")