forked from OAI/Overlay-Specification
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(schemas): add JSON Schema 2020-12 schemas to repo
* add constraint for `update` scenario' -m 'rename version folder' closes OAI#71
- Loading branch information
1 parent
d029f0d
commit f10fc4b
Showing
2 changed files
with
238 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| { | ||
| "$id": "https://spec.openapis.org/overlay/1.0/schema/2024-10-08", | ||
| "$schema": "https://json-schema.org/draft/2020-12/schema", | ||
| "description": "The description of OpenAPI Initiative Overlay v1.0.0 documents without schema validation, as defined by https://spec.openapis.org/overlay/v1.0.0", | ||
| "type": "object", | ||
| "properties": { | ||
| "overlay": { | ||
| "description": "The version number of the Overlay Specification", | ||
| "type": "string", | ||
| "pattern": "^1\\.0\\.\\d+(-.+)?$" | ||
| }, | ||
| "info": { | ||
| "$ref": "#/$defs/info-object" | ||
| }, | ||
| "extends": { | ||
| "type": "string", | ||
| "format": "uri-reference" | ||
| }, | ||
| "actions": { | ||
| "type": "array", | ||
| "minItems": 1, | ||
| "uniqueItems": true, | ||
| "items": { | ||
| "$ref": "#/$defs/action-object" | ||
| } | ||
| } | ||
| }, | ||
| "required": [ | ||
| "overlay", | ||
| "info", | ||
| "actions" | ||
| ], | ||
| "$ref": "#/$defs/specification-extensions", | ||
| "unevaluatedProperties": false, | ||
| "$defs": { | ||
| "info-object": { | ||
| "$comment": "https://spec.openapis.org/overlay/v1.0.0#info-object", | ||
| "description": "Provides metadata about the Overlay description", | ||
| "type": "object", | ||
| "properties": { | ||
| "title": { | ||
| "description": "A human readable title of the Overlay Description", | ||
| "type": "string" | ||
| }, | ||
| "version": { | ||
| "description": "The version identifier of the Overlay document (which is distinct from the Overlay Specification version)", | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "title", | ||
| "version" | ||
| ], | ||
| "$ref": "#/$defs/specification-extensions", | ||
| "unevaluatedProperties": false | ||
| }, | ||
| "action-object": { | ||
| "description": "This object represents one or more changes to be applied to the target document at the location defined by the target JSONPath expression.", | ||
| "properties": { | ||
| "target": { | ||
| "description": "A JSONPath expression selecting nodes in the target document", | ||
| "type": "string", | ||
| "pattern": "^\\$[.\\[].+$" | ||
| }, | ||
| "description": { | ||
| "description": "A description of the action. [[CommonMark]] syntax MAY be used for rich text representation.", | ||
| "type": "string" | ||
| }, | ||
| "update": { | ||
| "description": "If the target selects an object node, the value of this field MUST be an object with the properties and values to merge with the node. If the target selects an array, the value of this field MUST be an entry to append to the array.", | ||
| "type": [ | ||
| "string", | ||
| "boolean", | ||
| "object", | ||
| "array", | ||
| "number", | ||
| "null" | ||
| ] | ||
| }, | ||
| "remove": { | ||
| "description": "A boolean value that indicates that the target object is to be removed from the the map or array it is contained in", | ||
| "type": "boolean", | ||
| "default": false | ||
| } | ||
| }, | ||
| "allOf": [ | ||
| { | ||
| "description": "The `update` field has no impact if the `remove` field of this action object is true.", | ||
| "if": { | ||
| "properties": { | ||
| "remove": {"const": true} | ||
| }, | ||
| "required": ["remove"] | ||
| }, | ||
| "then": { | ||
| "not": { | ||
| "required": ["update"] | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "description": "If the `target` selects an object node, the value of the `update` field MUST be an object with the properties and values to merge with the selected node", | ||
| "if": { | ||
| "required": ["target"], | ||
| "properties": { | ||
| "target": {"type": "object"} | ||
| } | ||
| }, | ||
| "then": { | ||
| "properties": { | ||
| "update": {"type": "object"} | ||
| } | ||
| } | ||
| } | ||
| ], | ||
| "required": ["target"], | ||
| "$ref": "#/$defs/specification-extensions", | ||
| "unevaluatedProperties": false | ||
| }, | ||
| "specification-extensions": { | ||
| "$comment": "https://spec.openapis.org/overlay/v1.0.0#specification-extensions", | ||
| "description": "While the Overlay Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points", | ||
| "patternProperties": { | ||
| "^x-": true | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| $id: https://spec.openapis.org/overlay/1.0/schema/2024-10-08 | ||
| $schema: https://json-schema.org/draft/2020-12/schema | ||
| description: The description of OpenAPI Initiative Overlay v1.0.0 documents | ||
| without schema validation, as defined by | ||
| https://spec.openapis.org/overlay/v1.0.0 | ||
| type: object | ||
| properties: | ||
| overlay: | ||
| description: The version number of the Overlay Specification | ||
| type: string | ||
| pattern: ^1\.0\.\d+(-.+)?$ | ||
| info: | ||
| $ref: "#/$defs/info-object" | ||
| extends: | ||
| type: string | ||
| format: uri-reference | ||
| actions: | ||
| type: array | ||
| minItems: 1 | ||
| uniqueItems: true | ||
| items: | ||
| $ref: "#/$defs/action-object" | ||
| required: | ||
| - overlay | ||
| - info | ||
| - actions | ||
| $ref: "#/$defs/specification-extensions" | ||
| unevaluatedProperties: false | ||
| $defs: | ||
| info-object: | ||
| $comment: https://spec.openapis.org/overlay/v1.0.0#info-object | ||
| description: Provides metadata about the Overlay description | ||
| type: object | ||
| properties: | ||
| title: | ||
| description: A human readable title of the Overlay Description | ||
| type: string | ||
| version: | ||
| description: The version identifier of the Overlay document (which is distinct | ||
| from the Overlay Specification version) | ||
| type: string | ||
| required: | ||
| - title | ||
| - version | ||
| $ref: "#/$defs/specification-extensions" | ||
| unevaluatedProperties: false | ||
| action-object: | ||
| description: This object represents one or more changes to be applied to the | ||
| target document at the location defined by the target JSONPath expression. | ||
| properties: | ||
| target: | ||
| description: A JSONPath expression selecting nodes in the target document | ||
| type: string | ||
| pattern: ^\$[.\[].+$ | ||
| description: | ||
| description: A description of the action. [[CommonMark]] syntax MAY be used for | ||
| rich text representation. | ||
| type: string | ||
| update: | ||
| description: If the target selects an object node, the value of this field | ||
| MUST be an object with the properties and values to merge with the | ||
| node. If the target selects an array, the value of this field MUST | ||
| be an entry to append to the array. | ||
| type: | ||
| - string | ||
| - boolean | ||
| - object | ||
| - array | ||
| - number | ||
| - "null" | ||
| remove: | ||
| description: A boolean value that indicates that the target object is to be | ||
| removed from the the map or array it is contained in | ||
| type: boolean | ||
| default: false | ||
| allOf: | ||
| - description: The `update` field has no impact if the `remove` field of this | ||
| action object is true. | ||
| if: | ||
| properties: | ||
| remove: | ||
| const: true | ||
| required: | ||
| - remove | ||
| then: | ||
| not: | ||
| required: | ||
| - update | ||
| - description: If the `target` selects an object node, the value of the `update` field MUST be an object with the properties and values to merge with the selected node | ||
| if: | ||
| required: | ||
| - target | ||
| properties: | ||
| target: | ||
| type: object | ||
| then: | ||
| properties: | ||
| update: | ||
| type: object | ||
| required: | ||
| - target | ||
| $ref: "#/$defs/specification-extensions" | ||
| unevaluatedProperties: false | ||
| specification-extensions: | ||
| $comment: https://spec.openapis.org/overlay/v1.0.0#specification-extensions | ||
| description: While the Overlay Specification tries to accommodate most use | ||
| cases, additional data can be added to extend the specification at certain | ||
| points | ||
| patternProperties: | ||
| ^x-: true |