Skip to content

Add support for a property directly at the root level of a schema #120

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

Merged
merged 1 commit into from
Oct 2, 2023
Merged

Add support for a property directly at the root level of a schema #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions gh-pages/_includes/examples-table.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
| [Name](/json-schema-static-docs/examples/name.html) | [name.yml](/json-schema-static-docs/yml/name.yml) |
| [Enum Value Documentation](/json-schema-static-docs/examples/enums.html) | [enums.yml](/json-schema-static-docs/yml/enums.yml) |
| [One-of](/json-schema-static-docs/examples/oneof.html) | [oneof.yml](/json-schema-static-docs/yml/oneof.yml) |
| [Root level property](/json-schema-static-docs/examples/root-level-property.html) | [root-level-property.yml](/json-schema-static-docs/yml/root-level-property.yml) |
| [Draft 2019-09 - Array](/json-schema-static-docs/examples/draft-2019-09/array.html) | [draft-2019-09/array.yml](/json-schema-static-docs/yml/draft-2019-09/array.yml) |
| [Draft 2019-09 - Deprecated](/json-schema-static-docs/examples/draft-2019-09/deprecated.html) | [draft-2019-09/deprecated.yml](/json-schema-static-docs/yml/draft-2019-09/deprecated.yml) |
| [Draft 07 - User](/json-schema-static-docs/examples/draft-07/user.html) | [draft-07/user.yml](/json-schema-static-docs/yml/draft-07/user.yml) |
Expand Down
10 changes: 3 additions & 7 deletions gh-pages/examples/draft-06/animal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: A schema demonstrating some draft 06 features

## Properties

<table><thead><tr><th colspan="2">Name</th><th>Type</th></tr></thead><tbody><tr><td colspan="2"><a href="#animaltype">animalType</a></td><td>String</td></tr><tr><td colspan="2"><a href="#canfly">canFly</a></td><td>Boolean</td></tr></tbody></table>
<table class="jssd-properties-table"><thead><tr><th colspan="2">Name</th><th>Type</th></tr></thead><tbody><tr><td colspan="2"><a href="#animaltype">animalType</a></td><td>String</td></tr><tr><td colspan="2"><a href="#canfly">canFly</a></td><td>Boolean</td></tr></tbody></table>


## Example
Expand All @@ -39,11 +39,10 @@ description: A schema demonstrating some draft 06 features
<hr />



## animalType


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand All @@ -61,12 +60,10 @@ description: A schema demonstrating some draft 06 features





## canFly


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand All @@ -89,7 +86,6 @@ description: A schema demonstrating some draft 06 features




<hr />

## Schema
Expand Down
10 changes: 3 additions & 7 deletions gh-pages/examples/draft-07/user.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: A schema demonstrating some draft 07 features

## Properties

<table><thead><tr><th colspan="2">Name</th><th>Type</th></tr></thead><tbody><tr><td colspan="2"><a href="#username">username</a></td><td>String=seymour_butz</td></tr><tr><td colspan="2"><a href="#password">password</a></td><td>String</td></tr></tbody></table>
<table class="jssd-properties-table"><thead><tr><th colspan="2">Name</th><th>Type</th></tr></thead><tbody><tr><td colspan="2"><a href="#username">username</a></td><td>String=seymour_butz</td></tr><tr><td colspan="2"><a href="#password">password</a></td><td>String</td></tr></tbody></table>


## Example
Expand All @@ -32,11 +32,10 @@ description: A schema demonstrating some draft 07 features
<hr />



## username


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand Down Expand Up @@ -65,12 +64,10 @@ description: A schema demonstrating some draft 07 features





## password


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand Down Expand Up @@ -101,7 +98,6 @@ description: A schema demonstrating some draft 07 features




<hr />

## Schema
Expand Down
14 changes: 5 additions & 9 deletions gh-pages/examples/draft-2019-09/array.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: A schema describing fruits and vegetables

## Properties

<table><thead><tr><th colspan="2">Name</th><th>Type</th></tr></thead><tbody><tr><td colspan="2"><a href="#fruits">fruits</a></td><td>Array</td></tr><tr><td colspan="2"><a href="#vegetables">vegetables</a></td><td>Array</td></tr></tbody></table>
<table class="jssd-properties-table"><thead><tr><th colspan="2">Name</th><th>Type</th></tr></thead><tbody><tr><td colspan="2"><a href="#fruits">fruits</a></td><td>Array</td></tr><tr><td colspan="2"><a href="#vegetables">vegetables</a></td><td>Array</td></tr></tbody></table>


## Example
Expand All @@ -43,11 +43,10 @@ description: A schema describing fruits and vegetables
<hr />



## fruits


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand All @@ -72,12 +71,10 @@ description: A schema describing fruits and vegetables





## vegetables


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand All @@ -101,7 +98,7 @@ description: A schema describing fruits and vegetables
### vegetables.name


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand All @@ -122,7 +119,7 @@ description: A schema describing fruits and vegetables
### vegetables.hasARoundShape


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand All @@ -146,7 +143,6 @@ description: A schema describing fruits and vegetables




<hr />

## Schema
Expand Down
10 changes: 3 additions & 7 deletions gh-pages/examples/draft-2019-09/deprecated.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: A schema demonstrating use of deprecated

## Properties

<table><thead><tr><th colspan="2">Name</th><th>Type</th></tr></thead><tbody><tr><td colspan="2"><a href="#firstname">firstName</a></td><td>String</td></tr><tr><td colspan="2"><a href="#lastname">lastName</a></td><td>String</td></tr></tbody></table>
<table class="jssd-properties-table"><thead><tr><th colspan="2">Name</th><th>Type</th></tr></thead><tbody><tr><td colspan="2"><a href="#firstname">firstName</a></td><td>String</td></tr><tr><td colspan="2"><a href="#lastname">lastName</a></td><td>String</td></tr></tbody></table>


## Example
Expand All @@ -32,11 +32,10 @@ description: A schema demonstrating use of deprecated
<hr />



## firstName


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand All @@ -58,12 +57,10 @@ description: A schema demonstrating use of deprecated





## lastName


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Deprecated</th>
Expand Down Expand Up @@ -94,7 +91,6 @@ description: A schema demonstrating use of deprecated




<hr />

## Schema
Expand Down
6 changes: 2 additions & 4 deletions gh-pages/examples/enums.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: JSON schema example demonstrating documentation of enum values usin

## Properties

<table><thead><tr><th colspan="2">Name</th><th>Type</th></tr></thead><tbody><tr><td colspan="2"><a href="#status">status</a></td><td>String</td></tr></tbody></table>
<table class="jssd-properties-table"><thead><tr><th colspan="2">Name</th><th>Type</th></tr></thead><tbody><tr><td colspan="2"><a href="#status">status</a></td><td>String</td></tr></tbody></table>


## Example
Expand All @@ -31,11 +31,10 @@ description: JSON schema example demonstrating documentation of enum values usin
<hr />



## status


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand Down Expand Up @@ -65,7 +64,6 @@ description: JSON schema example demonstrating documentation of enum values usin




<hr />

## Schema
Expand Down
7 changes: 4 additions & 3 deletions gh-pages/examples/examples-index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@
- [oneof-and-anyof](oneof-and-anyof.md)
- [oneof](oneof.md)
- [person](person.md)
- [root-level-property](root-level-property.md)

## Draft-06
- [draft-06/animal](draft-06/animal.md)

## Draft-07
- [draft-07/user](draft-07/user.md)

## Draft-2019-09
- [draft-2019-09/array](draft-2019-09/array.md)
- [draft-2019-09/deprecated](draft-2019-09/deprecated.md)

## Draft-07
- [draft-07/user](draft-07/user.md)
14 changes: 4 additions & 10 deletions gh-pages/examples/name.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: JSON schema example for a name entity

## Properties

<table><thead><tr><th colspan="2">Name</th><th>Type</th></tr></thead><tbody><tr><td colspan="2"><a href="#title">title</a></td><td>String</td></tr><tr><td colspan="2"><a href="#firstname">firstName</a></td><td>String</td></tr><tr><td colspan="2"><a href="#lastname">lastName</a></td><td>String</td></tr></tbody></table>
<table class="jssd-properties-table"><thead><tr><th colspan="2">Name</th><th>Type</th></tr></thead><tbody><tr><td colspan="2"><a href="#title">title</a></td><td>String</td></tr><tr><td colspan="2"><a href="#firstname">firstName</a></td><td>String</td></tr><tr><td colspan="2"><a href="#lastname">lastName</a></td><td>String</td></tr></tbody></table>


## Example
Expand All @@ -33,11 +33,10 @@ description: JSON schema example for a name entity
<hr />



## title


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand Down Expand Up @@ -66,12 +65,10 @@ description: JSON schema example for a name entity





## firstName


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand Down Expand Up @@ -102,12 +99,10 @@ description: JSON schema example for a name entity





## lastName


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand Down Expand Up @@ -143,7 +138,6 @@ description: JSON schema example for a name entity




<hr />

## Schema
Expand Down
16 changes: 7 additions & 9 deletions gh-pages/examples/oneof.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ description: Example schema to demonstrate the use of the oneOf keyword

## Properties

<table><thead><tr><th colspan="2">Name</th><th>Type</th></tr></thead><tbody><tr><th rowspan="2">justOne</th><td rowspan="2">One of:</td><td>Object</td></tr><tr><td>Object</td></tr></tbody></table>
<table class="jssd-properties-table"><thead><tr><th colspan="2">Name</th><th>Type</th></tr></thead><tbody><tr><th rowspan="2">justOne</th><td rowspan="2">One of:</td><td>Object</td></tr><tr><td>Object</td></tr></tbody></table>


## Example
Expand All @@ -42,11 +42,10 @@ description: Example schema to demonstrate the use of the oneOf keyword
<hr />



## justOne


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand All @@ -70,7 +69,7 @@ description: Example schema to demonstrate the use of the oneOf keyword
### justOne.0


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand All @@ -86,7 +85,7 @@ description: Example schema to demonstrate the use of the oneOf keyword
### justOne.0.propertyA


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand All @@ -104,7 +103,7 @@ description: Example schema to demonstrate the use of the oneOf keyword
### justOne.1


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand All @@ -120,7 +119,7 @@ description: Example schema to demonstrate the use of the oneOf keyword
### justOne.1.propertyB


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand All @@ -137,7 +136,7 @@ description: Example schema to demonstrate the use of the oneOf keyword
### justOne.1.propertyC


<table>
<table class="jssd-property-table">
<tbody>
<tr>
<th>Title</th>
Expand All @@ -158,7 +157,6 @@ description: Example schema to demonstrate the use of the oneOf keyword




<hr />

## Schema
Expand Down
Loading