From 5c46f7b8161fe8c330732eac93e513d3754ab6d0 Mon Sep 17 00:00:00 2001 From: Andy Steed <andsteed@adobe.com> Date: Tue, 13 Mar 2018 18:44:14 -0700 Subject: [PATCH] Move stabilizing example into a new, separate schema. Add md + spec files for stabilizing schema. Update original schema json+md files with new expectations --- examples/docs/README.md | 1 + examples/docs/abstract.schema.md | 6 +-- examples/docs/arrays.schema.md | 6 +-- examples/docs/complex.schema.md | 6 +-- examples/docs/constants.schema.md | 6 +-- examples/docs/custom.schema.md | 6 +-- examples/docs/deepextending.schema.md | 6 +-- examples/docs/definitions.schema.md | 6 +-- examples/docs/enums.schema.md | 6 +-- examples/docs/example.schema.md | 6 +-- examples/docs/examples.schema.md | 6 +-- examples/docs/extending.schema.md | 6 +-- examples/docs/extensible.schema.md | 6 +-- examples/docs/simple.schema.md | 6 +-- examples/docs/simpletypes.schema.md | 6 +-- examples/docs/stabilizing.schema.md | 43 +++++++++++++++++++ examples/docs/subdir/subdir.schema.md | 6 +-- .../generated-schemas/stabilizing.schema.json | 26 +++++++++++ examples/schemas/abstract.schema.json | 1 - examples/schemas/stabilizing.schema.json | 26 +++++++++++ spec/examples/abstract.schema.md | 6 +-- spec/examples/arrays.schema.md | 6 +-- spec/examples/complex.schema.md | 6 +-- spec/examples/constants.schema.md | 6 +-- spec/examples/custom.schema.md | 6 +-- spec/examples/deepextending.schema.md | 6 +-- spec/examples/definitions.schema.md | 6 +-- spec/examples/enums.schema.md | 6 +-- spec/examples/example.schema.md | 6 +-- spec/examples/examples.schema.md | 6 +-- spec/examples/extending.schema.md | 6 +-- spec/examples/extensible.schema.md | 6 +-- spec/examples/simple.schema.md | 6 +-- spec/examples/simpletypes.schema.md | 6 +-- spec/examples/stabilizing.schema.md | 43 +++++++++++++++++++ 35 files changed, 226 insertions(+), 88 deletions(-) create mode 100644 examples/docs/stabilizing.schema.md create mode 100644 examples/generated-schemas/stabilizing.schema.json create mode 100644 examples/schemas/stabilizing.schema.json create mode 100644 spec/examples/stabilizing.schema.md diff --git a/examples/docs/README.md b/examples/docs/README.md index a28cb28..896a8a1 100644 --- a/examples/docs/README.md +++ b/examples/docs/README.md @@ -20,6 +20,7 @@ * [Extensible](./extensible.schema.md) – `https://example.com/schemas/extensible` * [Simple](./simple.schema.md) – `https://example.com/schemas/simple` * [Simple Types](./simpletypes.schema.md) – `https://example.com/schemas/simpletypes` +* [Stabilizing](./stabilizing.schema.md) – `https://example.com/schemas/stabilizing` ## /subdir/ diff --git a/examples/docs/abstract.schema.md b/examples/docs/abstract.schema.md index 55b9dca..6bd5774 100644 --- a/examples/docs/abstract.schema.md +++ b/examples/docs/abstract.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/abstract This is an abstract schema. It has `definitions`, but does not declare any properties -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Cannot be instantiated | Yes | Forbidden | Permitted | [abstract.schema.json](abstract.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Cannot be instantiated | Yes | Experimental | Forbidden | Permitted | [abstract.schema.json](abstract.schema.json) | # Abstract Definitions diff --git a/examples/docs/arrays.schema.md b/examples/docs/arrays.schema.md index 3c19110..ba969db 100644 --- a/examples/docs/arrays.schema.md +++ b/examples/docs/arrays.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/arrays This is an example schema with examples for multiple array types and their constraints. -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | No | Forbidden | Permitted | [arrays.schema.json](arrays.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Experimental | Forbidden | Permitted | [arrays.schema.json](arrays.schema.json) | # Arrays Properties diff --git a/examples/docs/complex.schema.md b/examples/docs/complex.schema.md index 774ce4f..024da10 100644 --- a/examples/docs/complex.schema.md +++ b/examples/docs/complex.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/complex This is an example schema that uses types defined in other schemas. -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | No | Forbidden | Permitted | [complex.schema.json](complex.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Experimental | Forbidden | Permitted | [complex.schema.json](complex.schema.json) | ## Schema Hierarchy diff --git a/examples/docs/constants.schema.md b/examples/docs/constants.schema.md index cd47b37..f66f875 100644 --- a/examples/docs/constants.schema.md +++ b/examples/docs/constants.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/constants This is an example schema with examples for properties with constant values -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | No | Forbidden | Permitted | [constants.schema.json](constants.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Experimental | Forbidden | Permitted | [constants.schema.json](constants.schema.json) | # Constant Types Properties diff --git a/examples/docs/custom.schema.md b/examples/docs/custom.schema.md index f783d11..885865a 100644 --- a/examples/docs/custom.schema.md +++ b/examples/docs/custom.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/custom This is an extensible schema. It has `definitions`, that can be used in other schemas. Additionally, it allows custom properties. -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | Yes | Allowed | Permitted | [custom.schema.json](custom.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | Yes | Experimental | Allowed | Permitted | [custom.schema.json](custom.schema.json) | # Custom Properties diff --git a/examples/docs/deepextending.schema.md b/examples/docs/deepextending.schema.md index db2e2cc..4eb7b80 100644 --- a/examples/docs/deepextending.schema.md +++ b/examples/docs/deepextending.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/deepextending This is an extending schema. It is extending another extending schema. It pulls `definitions` from other schemas. -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | Yes | Forbidden | Permitted | [deepextending.schema.json](deepextending.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | Yes | Experimental | Forbidden | Permitted | [deepextending.schema.json](deepextending.schema.json) | ## Schema Hierarchy diff --git a/examples/docs/definitions.schema.md b/examples/docs/definitions.schema.md index 3a1e93b..ebce6f9 100644 --- a/examples/docs/definitions.schema.md +++ b/examples/docs/definitions.schema.md @@ -25,9 +25,9 @@ Bre- aks. -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | Yes | Forbidden | Permitted | [definitions.schema.json](definitions.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | Yes | Experimental | Forbidden | Permitted | [definitions.schema.json](definitions.schema.json) | # Definitions Properties diff --git a/examples/docs/enums.schema.md b/examples/docs/enums.schema.md index 187d2d6..ef161c1 100644 --- a/examples/docs/enums.schema.md +++ b/examples/docs/enums.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/enums This is an example schema with examples for properties with enum values -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | No | Forbidden | Permitted | [enums.schema.json](enums.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Experimental | Forbidden | Permitted | [enums.schema.json](enums.schema.json) | # Enumerated Properties diff --git a/examples/docs/example.schema.md b/examples/docs/example.schema.md index f080e23..264bbaf 100644 --- a/examples/docs/example.schema.md +++ b/examples/docs/example.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/example This is an example schema with examples. Too many examples? There can never be too many examples! -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | No | Forbidden | Permitted | [example.schema.json](example.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Experimental | Forbidden | Permitted | [example.schema.json](example.schema.json) | ## Example Example ```json diff --git a/examples/docs/examples.schema.md b/examples/docs/examples.schema.md index 8dfefb3..ad2db8a 100644 --- a/examples/docs/examples.schema.md +++ b/examples/docs/examples.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/examples This is an example schema with *multiple* examples. Too many examples? There can never be too many examples! -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | No | Forbidden | Permitted | [examples.schema.json](examples.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Experimental | Forbidden | Permitted | [examples.schema.json](examples.schema.json) | ## Examples Examples diff --git a/examples/docs/extending.schema.md b/examples/docs/extending.schema.md index e7de838..ede60ff 100644 --- a/examples/docs/extending.schema.md +++ b/examples/docs/extending.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/extending This is an extending schema. It pulls `definitions` from other schemas. -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | Yes | Forbidden | Permitted | [extending.schema.json](extending.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | Yes | Experimental | Forbidden | Permitted | [extending.schema.json](extending.schema.json) | ## Schema Hierarchy diff --git a/examples/docs/extensible.schema.md b/examples/docs/extensible.schema.md index 2c7b0eb..a237e68 100644 --- a/examples/docs/extensible.schema.md +++ b/examples/docs/extensible.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/extensible This is an extensible schema. It has `definitions`, that can be used in other schemas -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Cannot be instantiated | Yes | Forbidden | Permitted | [extensible.schema.json](extensible.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Cannot be instantiated | Yes | Experimental | Forbidden | Permitted | [extensible.schema.json](extensible.schema.json) | # Extensible Definitions diff --git a/examples/docs/simple.schema.md b/examples/docs/simple.schema.md index 2507f94..5e5fa3d 100644 --- a/examples/docs/simple.schema.md +++ b/examples/docs/simple.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/simple This is a *very* simple example of a JSON schema. There is only one property. -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | No | Forbidden | Permitted | [simple.schema.json](simple.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Experimental | Forbidden | Permitted | [simple.schema.json](simple.schema.json) | # Simple Properties diff --git a/examples/docs/simpletypes.schema.md b/examples/docs/simpletypes.schema.md index 53652a8..945c245 100644 --- a/examples/docs/simpletypes.schema.md +++ b/examples/docs/simpletypes.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/simpletypes This is an example schema with examples for multiple types and their constraints. -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | No | Forbidden | Permitted | [simpletypes.schema.json](simpletypes.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Experimental | Forbidden | Permitted | [simpletypes.schema.json](simpletypes.schema.json) | # Simple Types Properties diff --git a/examples/docs/stabilizing.schema.md b/examples/docs/stabilizing.schema.md new file mode 100644 index 0000000..b88ea2c --- /dev/null +++ b/examples/docs/stabilizing.schema.md @@ -0,0 +1,43 @@ +--- +template: reference +foo: bar +--- + +# Stabilizing Schema + +``` +https://example.com/schemas/stabilizing +``` + +This is a schema which is currently in the `stabilizing` status. + +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Stabilizing | Forbidden | Permitted | [stabilizing.schema.json](stabilizing.schema.json) | + +# Stabilizing Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [id](#id) | `string` | Optional | Stabilizing (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## id + +A unique identifier given to every addressable thing. + +`id` +* is optional +* type: `string` +* defined in this schema + +### id Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + diff --git a/examples/docs/subdir/subdir.schema.md b/examples/docs/subdir/subdir.schema.md index ab876d4..673847a 100644 --- a/examples/docs/subdir/subdir.schema.md +++ b/examples/docs/subdir/subdir.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/subdir/subdir A schema in a sub directory -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Cannot be instantiated | Yes | Forbidden | Permitted | [subdir/subdir.schema.json](subdir/subdir.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Cannot be instantiated | Yes | Experimental | Forbidden | Permitted | [subdir/subdir.schema.json](subdir/subdir.schema.json) | # Subdir Definitions diff --git a/examples/generated-schemas/stabilizing.schema.json b/examples/generated-schemas/stabilizing.schema.json new file mode 100644 index 0000000..c0dcc1c --- /dev/null +++ b/examples/generated-schemas/stabilizing.schema.json @@ -0,0 +1,26 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at http://www.apache.org/licenses/LICENSE-2.0" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://example.com/schemas/stabilizing", + "title": "Stabilizing", + "description": "This is a schema which is currently in the `stabilizing` status.", + "meta:status": "stabilizing", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/id" + } + ], + "properties": { + "id": { + "type": "string", + "format": "uri", + "description": "A unique identifier given to every addressable thing." + } + } +} \ No newline at end of file diff --git a/examples/schemas/abstract.schema.json b/examples/schemas/abstract.schema.json index 9487ff9..5d3a9ba 100644 --- a/examples/schemas/abstract.schema.json +++ b/examples/schemas/abstract.schema.json @@ -10,7 +10,6 @@ "title": "Abstract", "description": "This is an abstract schema. It has `definitions`, but does not declare any properties", "type": "object", - "meta:status": "stabilizing", "definitions": { "first": { "type": "object", diff --git a/examples/schemas/stabilizing.schema.json b/examples/schemas/stabilizing.schema.json new file mode 100644 index 0000000..e7d95b7 --- /dev/null +++ b/examples/schemas/stabilizing.schema.json @@ -0,0 +1,26 @@ +{ + "meta:license": [ + "Copyright 2017 Adobe Systems Incorporated. All rights reserved.", + "This file is licensed to you under the Apache License, Version 2.0 (the 'License');", + "you may not use this file except in compliance with the License. You may obtain a copy", + "of the License at http://www.apache.org/licenses/LICENSE-2.0" + ], + "$schema": "http://json-schema.org/draft-06/schema#", + "$id": "https://example.com/schemas/stabilizing", + "title": "Stabilizing", + "description": "This is a schema which is currently in the `stabilizing` status.", + "meta:status": "stabilizing", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/id" + } + ], + "properties": { + "id": { + "type": "string", + "format": "uri", + "description": "A unique identifier given to every addressable thing." + } + } +} \ No newline at end of file diff --git a/spec/examples/abstract.schema.md b/spec/examples/abstract.schema.md index 55b9dca..6bd5774 100644 --- a/spec/examples/abstract.schema.md +++ b/spec/examples/abstract.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/abstract This is an abstract schema. It has `definitions`, but does not declare any properties -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Cannot be instantiated | Yes | Forbidden | Permitted | [abstract.schema.json](abstract.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Cannot be instantiated | Yes | Experimental | Forbidden | Permitted | [abstract.schema.json](abstract.schema.json) | # Abstract Definitions diff --git a/spec/examples/arrays.schema.md b/spec/examples/arrays.schema.md index 3c19110..ba969db 100644 --- a/spec/examples/arrays.schema.md +++ b/spec/examples/arrays.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/arrays This is an example schema with examples for multiple array types and their constraints. -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | No | Forbidden | Permitted | [arrays.schema.json](arrays.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Experimental | Forbidden | Permitted | [arrays.schema.json](arrays.schema.json) | # Arrays Properties diff --git a/spec/examples/complex.schema.md b/spec/examples/complex.schema.md index 774ce4f..024da10 100644 --- a/spec/examples/complex.schema.md +++ b/spec/examples/complex.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/complex This is an example schema that uses types defined in other schemas. -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | No | Forbidden | Permitted | [complex.schema.json](complex.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Experimental | Forbidden | Permitted | [complex.schema.json](complex.schema.json) | ## Schema Hierarchy diff --git a/spec/examples/constants.schema.md b/spec/examples/constants.schema.md index cd47b37..f66f875 100644 --- a/spec/examples/constants.schema.md +++ b/spec/examples/constants.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/constants This is an example schema with examples for properties with constant values -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | No | Forbidden | Permitted | [constants.schema.json](constants.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Experimental | Forbidden | Permitted | [constants.schema.json](constants.schema.json) | # Constant Types Properties diff --git a/spec/examples/custom.schema.md b/spec/examples/custom.schema.md index f783d11..885865a 100644 --- a/spec/examples/custom.schema.md +++ b/spec/examples/custom.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/custom This is an extensible schema. It has `definitions`, that can be used in other schemas. Additionally, it allows custom properties. -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | Yes | Allowed | Permitted | [custom.schema.json](custom.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | Yes | Experimental | Allowed | Permitted | [custom.schema.json](custom.schema.json) | # Custom Properties diff --git a/spec/examples/deepextending.schema.md b/spec/examples/deepextending.schema.md index db2e2cc..4eb7b80 100644 --- a/spec/examples/deepextending.schema.md +++ b/spec/examples/deepextending.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/deepextending This is an extending schema. It is extending another extending schema. It pulls `definitions` from other schemas. -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | Yes | Forbidden | Permitted | [deepextending.schema.json](deepextending.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | Yes | Experimental | Forbidden | Permitted | [deepextending.schema.json](deepextending.schema.json) | ## Schema Hierarchy diff --git a/spec/examples/definitions.schema.md b/spec/examples/definitions.schema.md index 3a1e93b..ebce6f9 100644 --- a/spec/examples/definitions.schema.md +++ b/spec/examples/definitions.schema.md @@ -25,9 +25,9 @@ Bre- aks. -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | Yes | Forbidden | Permitted | [definitions.schema.json](definitions.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | Yes | Experimental | Forbidden | Permitted | [definitions.schema.json](definitions.schema.json) | # Definitions Properties diff --git a/spec/examples/enums.schema.md b/spec/examples/enums.schema.md index 187d2d6..ef161c1 100644 --- a/spec/examples/enums.schema.md +++ b/spec/examples/enums.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/enums This is an example schema with examples for properties with enum values -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | No | Forbidden | Permitted | [enums.schema.json](enums.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Experimental | Forbidden | Permitted | [enums.schema.json](enums.schema.json) | # Enumerated Properties diff --git a/spec/examples/example.schema.md b/spec/examples/example.schema.md index f080e23..264bbaf 100644 --- a/spec/examples/example.schema.md +++ b/spec/examples/example.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/example This is an example schema with examples. Too many examples? There can never be too many examples! -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | No | Forbidden | Permitted | [example.schema.json](example.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Experimental | Forbidden | Permitted | [example.schema.json](example.schema.json) | ## Example Example ```json diff --git a/spec/examples/examples.schema.md b/spec/examples/examples.schema.md index 8dfefb3..ad2db8a 100644 --- a/spec/examples/examples.schema.md +++ b/spec/examples/examples.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/examples This is an example schema with *multiple* examples. Too many examples? There can never be too many examples! -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | No | Forbidden | Permitted | [examples.schema.json](examples.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Experimental | Forbidden | Permitted | [examples.schema.json](examples.schema.json) | ## Examples Examples diff --git a/spec/examples/extending.schema.md b/spec/examples/extending.schema.md index e7de838..ede60ff 100644 --- a/spec/examples/extending.schema.md +++ b/spec/examples/extending.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/extending This is an extending schema. It pulls `definitions` from other schemas. -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | Yes | Forbidden | Permitted | [extending.schema.json](extending.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | Yes | Experimental | Forbidden | Permitted | [extending.schema.json](extending.schema.json) | ## Schema Hierarchy diff --git a/spec/examples/extensible.schema.md b/spec/examples/extensible.schema.md index 2c7b0eb..a237e68 100644 --- a/spec/examples/extensible.schema.md +++ b/spec/examples/extensible.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/extensible This is an extensible schema. It has `definitions`, that can be used in other schemas -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Cannot be instantiated | Yes | Forbidden | Permitted | [extensible.schema.json](extensible.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Cannot be instantiated | Yes | Experimental | Forbidden | Permitted | [extensible.schema.json](extensible.schema.json) | # Extensible Definitions diff --git a/spec/examples/simple.schema.md b/spec/examples/simple.schema.md index 2507f94..5e5fa3d 100644 --- a/spec/examples/simple.schema.md +++ b/spec/examples/simple.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/simple This is a *very* simple example of a JSON schema. There is only one property. -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | No | Forbidden | Permitted | [simple.schema.json](simple.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Experimental | Forbidden | Permitted | [simple.schema.json](simple.schema.json) | # Simple Properties diff --git a/spec/examples/simpletypes.schema.md b/spec/examples/simpletypes.schema.md index 53652a8..945c245 100644 --- a/spec/examples/simpletypes.schema.md +++ b/spec/examples/simpletypes.schema.md @@ -11,9 +11,9 @@ https://example.com/schemas/simpletypes This is an example schema with examples for multiple types and their constraints. -| Abstract | Extensible | Custom Properties | Additional Properties | Defined In | -|----------|------------|-------------------|-----------------------|------------| -| Can be instantiated | No | Forbidden | Permitted | [simpletypes.schema.json](simpletypes.schema.json) | +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Experimental | Forbidden | Permitted | [simpletypes.schema.json](simpletypes.schema.json) | # Simple Types Properties diff --git a/spec/examples/stabilizing.schema.md b/spec/examples/stabilizing.schema.md new file mode 100644 index 0000000..b88ea2c --- /dev/null +++ b/spec/examples/stabilizing.schema.md @@ -0,0 +1,43 @@ +--- +template: reference +foo: bar +--- + +# Stabilizing Schema + +``` +https://example.com/schemas/stabilizing +``` + +This is a schema which is currently in the `stabilizing` status. + +| Abstract | Extensible | Status | Custom Properties | Additional Properties | Defined In | +|----------|------------|--------|-------------------|-----------------------|------------| +| Can be instantiated | No | Stabilizing | Forbidden | Permitted | [stabilizing.schema.json](stabilizing.schema.json) | + +# Stabilizing Properties + +| Property | Type | Required | Defined by | +|----------|------|----------|------------| +| [id](#id) | `string` | Optional | Stabilizing (this schema) | +| `*` | any | Additional | this schema *allows* additional properties | + +## id + +A unique identifier given to every addressable thing. + +`id` +* is optional +* type: `string` +* defined in this schema + +### id Type + + +`string` +* format: `uri` – Uniformous Resource Identifier (according to [RFC3986](http://tools.ietf.org/html/rfc3986)) + + + + + -- GitLab