From c712dab4580a6caab76079f6912209bc9930391f Mon Sep 17 00:00:00 2001 From: Lars Trieloff <trieloff@adobe.com> Date: Fri, 5 Jan 2018 17:17:45 +0000 Subject: [PATCH] clarify type of additional and pattern properties #18 --- examples/docs/arrays.schema.md | 2 +- examples/docs/complex.schema.md | 6 +++--- examples/docs/constants.schema.md | 2 +- examples/docs/custom.schema.md | 2 +- examples/docs/deepextending.schema.md | 2 +- examples/docs/definitions.schema.md | 2 +- examples/docs/enums.schema.md | 2 +- examples/docs/example.schema.md | 2 +- examples/docs/examples.schema.md | 2 +- examples/docs/extending.schema.md | 2 +- examples/docs/simple.schema.md | 2 +- examples/docs/simpletypes.schema.md | 2 +- templates/md/properties.ejs | 4 ++-- 13 files changed, 16 insertions(+), 16 deletions(-) diff --git a/examples/docs/arrays.schema.md b/examples/docs/arrays.schema.md index f61db50..3c19110 100644 --- a/examples/docs/arrays.schema.md +++ b/examples/docs/arrays.schema.md @@ -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) | | [objectlist](#objectlist) | `object[]` | 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 diff --git a/examples/docs/complex.schema.md b/examples/docs/complex.schema.md index 97eaa8e..6416540 100644 --- a/examples/docs/complex.schema.md +++ b/examples/docs/complex.schema.md @@ -31,9 +31,9 @@ This is an example schema that uses types defined in other schemas. | [reflist](#reflist) | Simple | Optional | Complex References (this schema) | | [refnamed](#refnamed) | Simple | Optional | Complex References (this schema) | | [xor](#xor) | complex | Optional | Complex References (this schema) | -| `int.*` | `integer` | Optional | Complex References (this schema) | -| `str.*` | `string` | Optional | Complex References (this schema) | -| `*` | any | Optional | this schema *allows* additional properties | +| `int.*` | `integer` | Pattern | Complex References (this schema) | +| `str.*` | `string` | Pattern | Complex References (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | ## and diff --git a/examples/docs/constants.schema.md b/examples/docs/constants.schema.md index 22d89ae..cd47b37 100644 --- a/examples/docs/constants.schema.md +++ b/examples/docs/constants.schema.md @@ -20,7 +20,7 @@ This is an example schema with examples for properties with constant values | Property | Type | Required | Defined by | |----------|------|----------|------------| | [hello](#hello) | `const` | **Required** | Constant Types (this schema) | -| `*` | any | Optional | this schema *allows* additional properties | +| `*` | any | Additional | this schema *allows* additional properties | ## hello diff --git a/examples/docs/custom.schema.md b/examples/docs/custom.schema.md index 0d1dec6..f783d11 100644 --- a/examples/docs/custom.schema.md +++ b/examples/docs/custom.schema.md @@ -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) | | [foo](#foo) | `string` | Optional | Custom (this schema) | -| `*` | any | Optional | this schema *allows* additional properties | +| `*` | any | Additional | this schema *allows* additional properties | ## bar diff --git a/examples/docs/deepextending.schema.md b/examples/docs/deepextending.schema.md index f4d69b4..db2e2cc 100644 --- a/examples/docs/deepextending.schema.md +++ b/examples/docs/deepextending.schema.md @@ -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) | | [id](#id) | `string` | Optional | [Definitions](definitions.schema.md#id) | | [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 diff --git a/examples/docs/definitions.schema.md b/examples/docs/definitions.schema.md index 6f92376..3a1e93b 100644 --- a/examples/docs/definitions.schema.md +++ b/examples/docs/definitions.schema.md @@ -36,7 +36,7 @@ aks. | [@id](#@id) | `string` | Optional | Definitions (this schema) | | [id](#id) | `string` | **Required** | 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 diff --git a/examples/docs/enums.schema.md b/examples/docs/enums.schema.md index f0f0a74..187d2d6 100644 --- a/examples/docs/enums.schema.md +++ b/examples/docs/enums.schema.md @@ -20,7 +20,7 @@ This is an example schema with examples for properties with enum values | Property | Type | Required | Defined by | |----------|------|----------|------------| | [hello](#hello) | `enum` | **Required** | Enumerated (this schema) | -| `*` | any | Optional | this schema *allows* additional properties | +| `*` | any | Additional | this schema *allows* additional properties | ## hello diff --git a/examples/docs/example.schema.md b/examples/docs/example.schema.md index 7757435..f080e23 100644 --- a/examples/docs/example.schema.md +++ b/examples/docs/example.schema.md @@ -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) | | [foo](#foo) | `string` | Optional | Example (this schema) | -| `*` | any | Optional | this schema *allows* additional properties | +| `*` | any | Additional | this schema *allows* additional properties | ## bar diff --git a/examples/docs/examples.schema.md b/examples/docs/examples.schema.md index 05dec41..8dfefb3 100644 --- a/examples/docs/examples.schema.md +++ b/examples/docs/examples.schema.md @@ -38,7 +38,7 @@ This is an example schema with *multiple* examples. Too many examples? There can |----------|------|----------|------------| | [bar](#bar) | `string` | **Required** | 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 diff --git a/examples/docs/extending.schema.md b/examples/docs/extending.schema.md index 24487e7..e7de838 100644 --- a/examples/docs/extending.schema.md +++ b/examples/docs/extending.schema.md @@ -30,7 +30,7 @@ This is an extending schema. It pulls `definitions` from other schemas. | [baz](#baz) | `string` | Optional | Extending (this schema) | | [id](#id) | `string` | Optional | [Definitions](definitions.schema.md#id) | | [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 diff --git a/examples/docs/simple.schema.md b/examples/docs/simple.schema.md index 33bfb51..2507f94 100644 --- a/examples/docs/simple.schema.md +++ b/examples/docs/simple.schema.md @@ -20,7 +20,7 @@ This is a *very* simple example of a JSON schema. There is only one property. | Property | Type | Required | Defined by | |----------|------|----------|------------| | [id](#id) | `string` | Optional | Simple (this schema) | -| `*` | any | Optional | this schema *allows* additional properties | +| `*` | any | Additional | this schema *allows* additional properties | ## id diff --git a/examples/docs/simpletypes.schema.md b/examples/docs/simpletypes.schema.md index fab2e7a..53652a8 100644 --- a/examples/docs/simpletypes.schema.md +++ b/examples/docs/simpletypes.schema.md @@ -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_uri](#string_uri) | `string` | Optional | 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 diff --git a/templates/md/properties.ejs b/templates/md/properties.ejs index 9b1ea80..d7e97e9 100644 --- a/templates/md/properties.ejs +++ b/templates/md/properties.ejs @@ -20,7 +20,7 @@ }); %><% _.keys(pprops).forEach(property => { const schema = pprops[property]; %> -| `<%= property %>` | <%= schema.simpletype %> | Optional | <% +| `<%= property %>` | <%= schema.simpletype %> | Pattern | <% if (schema.$oSchema) { %>[<%= schema.$oSchema.$linkVal %>](<%= schema.$oSchema.$linkPath %>#<%= property.replace(':', '') %>)<% } else { @@ -28,5 +28,5 @@ <% }); %><% 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 -- GitLab