Skip to content
Snippets Groups Projects
Commit c712dab4 authored by Lars Trieloff's avatar Lars Trieloff
Browse files

clarify type of additional and pattern properties #18

parent 4fa19225
Branches
Tags
No related merge requests found
...@@ -27,7 +27,7 @@ This is an example schema with examples for multiple array types and their const ...@@ -27,7 +27,7 @@ This is an example schema with examples for multiple array types and their const
| [numlist](#numlist) | `number[]` | Optional | Arrays (this schema) | | [numlist](#numlist) | `number[]` | Optional | Arrays (this schema) |
| [objectlist](#objectlist) | `object[]` | Optional | Arrays (this schema) | | [objectlist](#objectlist) | `object[]` | Optional | Arrays (this schema) |
| [stringlistlist](#stringlistlist) | `string[][]` | Optional | Arrays (this schema) | | [stringlistlist](#stringlistlist) | `string[][]` | Optional | Arrays (this schema) |
| `*` | any | Optional | this schema *allows* additional properties | | `*` | any | Additional | this schema *allows* additional properties |
## boollist ## boollist
......
...@@ -31,9 +31,9 @@ This is an example schema that uses types defined in other schemas. ...@@ -31,9 +31,9 @@ This is an example schema that uses types defined in other schemas.
| [reflist](#reflist) | Simple | Optional | Complex References (this schema) | | [reflist](#reflist) | Simple | Optional | Complex References (this schema) |
| [refnamed](#refnamed) | Simple | Optional | Complex References (this schema) | | [refnamed](#refnamed) | Simple | Optional | Complex References (this schema) |
| [xor](#xor) | complex | Optional | Complex References (this schema) | | [xor](#xor) | complex | Optional | Complex References (this schema) |
| `int.*` | `integer` | Optional | Complex References (this schema) | | `int.*` | `integer` | Pattern | Complex References (this schema) |
| `str.*` | `string` | Optional | Complex References (this schema) | | `str.*` | `string` | Pattern | Complex References (this schema) |
| `*` | any | Optional | this schema *allows* additional properties | | `*` | any | Additional | this schema *allows* additional properties |
## and ## and
......
...@@ -20,7 +20,7 @@ This is an example schema with examples for properties with constant values ...@@ -20,7 +20,7 @@ This is an example schema with examples for properties with constant values
| Property | Type | Required | Defined by | | Property | Type | Required | Defined by |
|----------|------|----------|------------| |----------|------|----------|------------|
| [hello](#hello) | `const` | **Required** | Constant Types (this schema) | | [hello](#hello) | `const` | **Required** | Constant Types (this schema) |
| `*` | any | Optional | this schema *allows* additional properties | | `*` | any | Additional | this schema *allows* additional properties |
## hello ## hello
......
...@@ -21,7 +21,7 @@ This is an extensible schema. It has `definitions`, that can be used in other sc ...@@ -21,7 +21,7 @@ This is an extensible schema. It has `definitions`, that can be used in other sc
|----------|------|----------|------------| |----------|------|----------|------------|
| [bar](#bar) | `string` | Optional | Custom (this schema) | | [bar](#bar) | `string` | Optional | Custom (this schema) |
| [foo](#foo) | `string` | Optional | Custom (this schema) | | [foo](#foo) | `string` | Optional | Custom (this schema) |
| `*` | any | Optional | this schema *allows* additional properties | | `*` | any | Additional | this schema *allows* additional properties |
## bar ## bar
......
...@@ -32,7 +32,7 @@ This is an extending schema. It is extending another extending schema. It pulls ...@@ -32,7 +32,7 @@ This is an extending schema. It is extending another extending schema. It pulls
| [hey](#hey) | `string` | Optional | Deeply Extending (this schema) | | [hey](#hey) | `string` | Optional | Deeply Extending (this schema) |
| [id](#id) | `string` | Optional | [Definitions](definitions.schema.md#id) | | [id](#id) | `string` | Optional | [Definitions](definitions.schema.md#id) |
| [meta:id](#metaid) | `string` | Optional | [Definitions](definitions.schema.md#metaid) | | [meta:id](#metaid) | `string` | Optional | [Definitions](definitions.schema.md#metaid) |
| `*` | any | Optional | this schema *allows* additional properties | | `*` | any | Additional | this schema *allows* additional properties |
## @id ## @id
......
...@@ -36,7 +36,7 @@ aks. ...@@ -36,7 +36,7 @@ aks.
| [@id](#@id) | `string` | Optional | Definitions (this schema) | | [@id](#@id) | `string` | Optional | Definitions (this schema) |
| [id](#id) | `string` | **Required** | Definitions (this schema) | | [id](#id) | `string` | **Required** | Definitions (this schema) |
| [meta:id](#metaid) | `string` | Optional | Definitions (this schema) | | [meta:id](#metaid) | `string` | Optional | Definitions (this schema) |
| `*` | any | Optional | this schema *allows* additional properties | | `*` | any | Additional | this schema *allows* additional properties |
## @id ## @id
......
...@@ -20,7 +20,7 @@ This is an example schema with examples for properties with enum values ...@@ -20,7 +20,7 @@ This is an example schema with examples for properties with enum values
| Property | Type | Required | Defined by | | Property | Type | Required | Defined by |
|----------|------|----------|------------| |----------|------|----------|------------|
| [hello](#hello) | `enum` | **Required** | Enumerated (this schema) | | [hello](#hello) | `enum` | **Required** | Enumerated (this schema) |
| `*` | any | Optional | this schema *allows* additional properties | | `*` | any | Additional | this schema *allows* additional properties |
## hello ## hello
......
...@@ -29,7 +29,7 @@ This is an example schema with examples. Too many examples? There can never be t ...@@ -29,7 +29,7 @@ This is an example schema with examples. Too many examples? There can never be t
|----------|------|----------|------------| |----------|------|----------|------------|
| [bar](#bar) | `string` | Optional | Example (this schema) | | [bar](#bar) | `string` | Optional | Example (this schema) |
| [foo](#foo) | `string` | Optional | Example (this schema) | | [foo](#foo) | `string` | Optional | Example (this schema) |
| `*` | any | Optional | this schema *allows* additional properties | | `*` | any | Additional | this schema *allows* additional properties |
## bar ## bar
......
...@@ -38,7 +38,7 @@ This is an example schema with *multiple* examples. Too many examples? There can ...@@ -38,7 +38,7 @@ This is an example schema with *multiple* examples. Too many examples? There can
|----------|------|----------|------------| |----------|------|----------|------------|
| [bar](#bar) | `string` | **Required** | Examples (this schema) | | [bar](#bar) | `string` | **Required** | Examples (this schema) |
| [foo](#foo) | `string` | Optional | Examples (this schema) | | [foo](#foo) | `string` | Optional | Examples (this schema) |
| `*` | any | Optional | this schema *allows* additional properties | | `*` | any | Additional | this schema *allows* additional properties |
## bar ## bar
......
...@@ -30,7 +30,7 @@ This is an extending schema. It pulls `definitions` from other schemas. ...@@ -30,7 +30,7 @@ This is an extending schema. It pulls `definitions` from other schemas.
| [baz](#baz) | `string` | Optional | Extending (this schema) | | [baz](#baz) | `string` | Optional | Extending (this schema) |
| [id](#id) | `string` | Optional | [Definitions](definitions.schema.md#id) | | [id](#id) | `string` | Optional | [Definitions](definitions.schema.md#id) |
| [meta:id](#metaid) | `string` | Optional | [Definitions](definitions.schema.md#metaid) | | [meta:id](#metaid) | `string` | Optional | [Definitions](definitions.schema.md#metaid) |
| `*` | any | Optional | this schema *allows* additional properties | | `*` | any | Additional | this schema *allows* additional properties |
## @id ## @id
......
...@@ -20,7 +20,7 @@ This is a *very* simple example of a JSON schema. There is only one property. ...@@ -20,7 +20,7 @@ This is a *very* simple example of a JSON schema. There is only one property.
| Property | Type | Required | Defined by | | Property | Type | Required | Defined by |
|----------|------|----------|------------| |----------|------|----------|------------|
| [id](#id) | `string` | Optional | Simple (this schema) | | [id](#id) | `string` | Optional | Simple (this schema) |
| `*` | any | Optional | this schema *allows* additional properties | | `*` | any | Additional | this schema *allows* additional properties |
## id ## id
......
...@@ -36,7 +36,7 @@ This is an example schema with examples for multiple types and their constraints ...@@ -36,7 +36,7 @@ This is an example schema with examples for multiple types and their constraints
| [string_unconstrained](#string_unconstrained) | `string` | Optional | Simple Types (this schema) | | [string_unconstrained](#string_unconstrained) | `string` | Optional | Simple Types (this schema) |
| [string_uri](#string_uri) | `string` | Optional | Simple Types (this schema) | | [string_uri](#string_uri) | `string` | Optional | Simple Types (this schema) |
| [yesno](#yesno) | `boolean` | **Required** | Simple Types (this schema) | | [yesno](#yesno) | `boolean` | **Required** | Simple Types (this schema) |
| `*` | any | Optional | this schema *allows* additional properties | | `*` | any | Additional | this schema *allows* additional properties |
## integer_threes ## integer_threes
......
...@@ -20,7 +20,7 @@ ...@@ -20,7 +20,7 @@
}); });
%><% _.keys(pprops).forEach(property => { %><% _.keys(pprops).forEach(property => {
const schema = pprops[property]; %> const schema = pprops[property]; %>
| `<%= property %>` | <%= schema.simpletype %> | Optional | <% | `<%= property %>` | <%= schema.simpletype %> | Pattern | <%
if (schema.$oSchema) { if (schema.$oSchema) {
%>[<%= schema.$oSchema.$linkVal %>](<%= schema.$oSchema.$linkPath %>#<%= property.replace(':', '') %>)<% %>[<%= schema.$oSchema.$linkVal %>](<%= schema.$oSchema.$linkPath %>#<%= property.replace(':', '') %>)<%
} else { } else {
...@@ -28,5 +28,5 @@ ...@@ -28,5 +28,5 @@
<% <%
}); });
%><% if (additional!==false||additional===undefined) { %> %><% if (additional!==false||additional===undefined) { %>
| `*` | any | Optional | this schema *allows* additional properties | | `*` | any | Additional | this schema *allows* additional properties |
<% } %> <% } %>
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment