Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix additional property empty links #267

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Fix additional property empty links #267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2335d23
Removed empty link from md template
Sep 19, 2024
a8ee763
Removed empty link from all examples
Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions docs/examples/examples_md_default/Configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@

**Title:** JSON Schema for Humans configuration file

| | |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
| | |
| ------------------------- | ----------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]]("Additional Properties of any type are allowed.") |

**Description:** Choose how to generate JSON Schema for Humans documentation file.

Expand Down Expand Up @@ -286,11 +286,11 @@ This is the old behaviour and is only needed for browsers that do not support HT

## <a name="markdown_options"></a>19. Property `JSON Schema for Humans configuration file > markdown_options`

| | |
| ------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
| | |
| ------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]]("Additional Properties of any type are allowed.") |
| **Default** | `{"fenced-code-blocks": {"break-on-newline": true, "cssclass": "highlight jumbotron", "tables": null}, "tables": null}` |

**Description:** [Markdown 2 options](https://github.com/trentm/python-markdown2/wiki/Extras) for the descriptions. `description_is_markdown` must be true for this to have any effect.
Expand All @@ -313,11 +313,11 @@ Adding an extra, even if the value is false, will activate it. For example `{"br

## <a name="template_md_options"></a>20. Property `JSON Schema for Humans configuration file > template_md_options`

| | |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
| | |
| ------------------------- | ----------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]]("Additional Properties of any type are allowed.") |

**Description:** specific options to md template

Expand Down
30 changes: 15 additions & 15 deletions docs/examples/examples_md_default/additional_properties.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@

## <a name="subType1"></a>1. Property `Person > subType1`

| | |
| ------------------------- | ------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Not allowed]](# "Additional Properties not allowed.") |
| | |
| ------------------------- | ----------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Not allowed]]("Additional Properties not allowed.") |

**Description:** A sub type with additionalProperties false.

Expand All @@ -46,11 +46,11 @@

## <a name="subType2"></a>2. Property `Person > subType2`

| | |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
| | |
| ------------------------- | ----------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]]("Additional Properties of any type are allowed.") |

**Description:** A sub type with additionalProperties true.

Expand All @@ -77,11 +77,11 @@

## <a name="additionalProperties"></a>4. Property `Person > additionalProperties`

| | |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
| | |
| ------------------------- | ----------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]]("Additional Properties of any type are allowed.") |

**Description:** additionalProperties schema.

Expand Down
66 changes: 33 additions & 33 deletions docs/examples/examples_md_default/anyOf_option_names.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
- [1.3. Property `root > storage > anyOf > item 2`](#storage_anyOf_i2)
- [1.4. Property `root > storage > anyOf > tmpfs`](#storage_anyOf_i3)

| | |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
| | |
| ------------------------- | ----------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]]("Additional Properties of any type are allowed.") |

**Description:** JSON Schema for an fstab entry

Expand All @@ -20,11 +20,11 @@

## <a name="storage"></a>1. Property `root > storage`

| | |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type** | `combining` |
| **Required** | Yes |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
| | |
| ------------------------- | ----------------------------------------------------------------------- |
| **Type** | `combining` |
| **Required** | Yes |
| **Additional properties** | [[Any type: allowed]]("Additional Properties of any type are allowed.") |

| Any of(Option) |
| ------------------------------- |
Expand All @@ -35,38 +35,38 @@

### <a name="storage_anyOf_i0"></a>1.1. Property `root > storage > anyOf > diskDevice`

| | |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
| **Defined in** | #/definitions/diskDevice |
| | |
| ------------------------- | ----------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]]("Additional Properties of any type are allowed.") |
| **Defined in** | #/definitions/diskDevice |

### <a name="storage_anyOf_i1"></a>1.2. Property `root > storage > anyOf > diskUUID`

| | |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
| **Defined in** | #/definitions/diskUUID |
| | |
| ------------------------- | ----------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]]("Additional Properties of any type are allowed.") |
| **Defined in** | #/definitions/diskUUID |

### <a name="storage_anyOf_i2"></a>1.3. Property `root > storage > anyOf > item 2`

| | |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
| | |
| ------------------------- | ----------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]]("Additional Properties of any type are allowed.") |

### <a name="storage_anyOf_i3"></a>1.4. Property `root > storage > anyOf > tmpfs`

| | |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
| **Defined in** | #/definitions/tmpfs |
| | |
| ------------------------- | ----------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]]("Additional Properties of any type are allowed.") |
| **Defined in** | #/definitions/tmpfs |

----------------------------------------------------------------------------------------------------------------------------
Generated using [json-schema-for-humans](https://github.com/coveooss/json-schema-for-humans)
22 changes: 11 additions & 11 deletions docs/examples/examples_md_default/array.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@
- [2.1.1. Property `root > vegetables > vegetables items > veggieName`](#vegetables_items_veggieName)
- [2.1.2. Property `root > vegetables > vegetables items > veggieLike`](#vegetables_items_veggieLike)

| | |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
| | |
| ------------------------- | ----------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]]("Additional Properties of any type are allowed.") |

**Description:** A schema with an array

Expand Down Expand Up @@ -67,12 +67,12 @@

### <a name="vegetables_items"></a>2.1. root > vegetables > veggie

| | |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
| **Defined in** | #/definitions/veggie |
| | |
| ------------------------- | ----------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]]("Additional Properties of any type are allowed.") |
| **Defined in** | #/definitions/veggie |

| Property | Pattern | Type | Deprecated | Definition | Title/Description |
| --------------------------------------------- | ------- | ------- | ---------- | ---------- | -------------------------- |
Expand Down
10 changes: 5 additions & 5 deletions docs/examples/examples_md_default/array_additionalItems.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
- [2.1. root > addressLines > addressLines item 0](#autogenerated_heading_6)
- [3. Property `root > arrayEmpty`](#arrayEmpty)

| | |
| ------------------------- | ------------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]](# "Additional Properties of any type are allowed.") |
| | |
| ------------------------- | ----------------------------------------------------------------------- |
| **Type** | `object` |
| **Required** | No |
| **Additional properties** | [[Any type: allowed]]("Additional Properties of any type are allowed.") |

**Description:** A little food fun

Expand Down
Loading