From edd4adea698d7f2dd6201c9e3381072c9355b5f6 Mon Sep 17 00:00:00 2001 From: Lorna Jane Mitchell Date: Sat, 8 Aug 2026 19:53:54 +0100 Subject: [PATCH 1/3] Put the in-progress spec and schemas onto the dev branch --- versions/1.2.0-dev.md => src/overlay.md | 0 schemas/v1.2-dev/readme.md => src/schemas/validation/README.md | 0 {schemas/v1.2-dev => src/schemas/validation}/schema.yaml | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename versions/1.2.0-dev.md => src/overlay.md (100%) rename schemas/v1.2-dev/readme.md => src/schemas/validation/README.md (100%) rename {schemas/v1.2-dev => src/schemas/validation}/schema.yaml (100%) diff --git a/versions/1.2.0-dev.md b/src/overlay.md similarity index 100% rename from versions/1.2.0-dev.md rename to src/overlay.md diff --git a/schemas/v1.2-dev/readme.md b/src/schemas/validation/README.md similarity index 100% rename from schemas/v1.2-dev/readme.md rename to src/schemas/validation/README.md diff --git a/schemas/v1.2-dev/schema.yaml b/src/schemas/validation/schema.yaml similarity index 100% rename from schemas/v1.2-dev/schema.yaml rename to src/schemas/validation/schema.yaml From fb2be2ca73aadfd815a618b273e6d83f211bcc3e Mon Sep 17 00:00:00 2001 From: Lorna Mitchell Date: Tue, 8 Sep 2026 16:27:41 +0100 Subject: [PATCH 2/3] Fix incorrect link path in schema validation readme --- src/schemas/validation/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/schemas/validation/README.md b/src/schemas/validation/README.md index d98a4e0..57ddd45 100644 --- a/src/schemas/validation/README.md +++ b/src/schemas/validation/README.md @@ -23,7 +23,7 @@ The TSC will then: ## Tests -The [test suite](../../tests/v1.2-dev) is part of this package. +The [test suite](../../../tests/v1.2-dev) is part of this package. ```bash npm install From 78aedbdb32899faf28ad37856648b825be9a0ee2 Mon Sep 17 00:00:00 2001 From: Lorna Mitchell Date: Tue, 22 Sep 2026 16:23:30 +0100 Subject: [PATCH 3/3] Prepare Release 1.2.0 --- src/schemas/validation/README.md | 37 -------- src/schemas/validation/schema.yaml | 130 ---------------------------- versions/1.2.0-editors.md | 16 ++++ src/overlay.md => versions/1.2.0.md | 2 +- 4 files changed, 17 insertions(+), 168 deletions(-) delete mode 100644 src/schemas/validation/README.md delete mode 100644 src/schemas/validation/schema.yaml create mode 100644 versions/1.2.0-editors.md rename src/overlay.md => versions/1.2.0.md (99%) diff --git a/src/schemas/validation/README.md b/src/schemas/validation/README.md deleted file mode 100644 index 57ddd45..0000000 --- a/src/schemas/validation/README.md +++ /dev/null @@ -1,37 +0,0 @@ -# OpenAPI Overlay 1.2.x JSON Schema - -Here you can find the JSON Schema for validating Overlays of versions 1.2.x. - -As a reminder, the JSON Schema is not the source of truth for the Specification. -In cases of conflicts between the Specification itself and the JSON Schema, the -Specification wins. Also, some Specification constraints cannot be represented -with the JSON Schema so it's highly recommended to employ other methods to -ensure compliance. - -The iteration version of the JSON Schema can be found in the `$id` field. -For example, the value of `$id: https://spec.openapis.org/overlay/1.2/schema/2024-10-17` means this iteration was created on October 17, 2024. - -## Contributing - -To submit improvements to the schema, modify the `schema.yaml` and add test cases for your changes. - -The TSC will then: - -- Run tests on the updated schema -- Update the iteration version -- Publish the new version - -## Tests - -The [test suite](../../../tests/v1.2-dev) is part of this package. - -```bash -npm install -npm test -``` - -You can also validate a document individually. - -```bash -node scripts/validate.mjs path/to/document/to/validate.yaml -``` diff --git a/src/schemas/validation/schema.yaml b/src/schemas/validation/schema.yaml deleted file mode 100644 index f1d9917..0000000 --- a/src/schemas/validation/schema.yaml +++ /dev/null @@ -1,130 +0,0 @@ -$id: https://spec.openapis.org/overlay/1.2/schema/WORK-IN-PROGRESS -$schema: https://json-schema.org/draft/2020-12/schema -description: The description of Overlay v1.2.x documents -type: object -properties: - overlay: - type: string - pattern: ^1\.2\.\d+$ - $self: - type: string - format: uri-reference - $comment: MUST NOT contain a fragment - pattern: "^[^#]*$" - info: - $ref: "#/$defs/info-object" - extends: - type: string - format: uri-reference - $comment: MUST NOT contain a fragment - pattern: "^[^#]*$" - actions: - type: array - minItems: 1 - uniqueItems: true - items: - oneOf: - - $ref: "#/$defs/reusable-action-reference-object" - - $ref: "#/$defs/action-object" - components: - $ref: "#/$defs/components-object" -required: - - overlay - - info - - actions -$ref: "#/$defs/specification-extensions" -unevaluatedProperties: false -$defs: - reusable-action-reference-object: - type: object - allOf: - - $ref: "#/$defs/specification-extensions" - - $ref: "#/$defs/description-field" - - $ref: "#/$defs/target-field" - properties: - $ref: - type: string - pattern: ^#\/components\/actions\/(?:[^~/]|~0|~1)+$ - required: - - $ref - - target - unevaluatedProperties: false - reusable-action-fields-object: - type: object - allOf: - - $ref: "#/$defs/description-field" - - $ref: "#/$defs/action-fields" - - $ref: "#/$defs/specification-extensions" - unevaluatedProperties: false - reusable-action-object: - type: object - allOf: - - $ref: "#/$defs/specification-extensions" - - $ref: "#/$defs/description-field" - properties: - fields: - $ref: "#/$defs/reusable-action-fields-object" - unevaluatedProperties: false - components-object: - type: object - properties: - actions: - type: object - additionalProperties: - $ref: "#/$defs/reusable-action-object" - $ref: "#/$defs/specification-extensions" - unevaluatedProperties: false - info-object: - type: object - properties: - title: - type: string - version: - type: string - allOf: - - $ref: "#/$defs/description-field" - required: - - title - - version - $ref: "#/$defs/specification-extensions" - unevaluatedProperties: false - description-field: - type: object - properties: - description: - type: string - target-field: - type: object - properties: - target: - type: string - pattern: ^\$ - action-fields: - type: object - properties: - update: - type: - - string - - boolean - - object - - array - - number - - "null" - copy: - type: string - remove: - type: boolean - default: false - action-object: - type: object - allOf: - - $ref: "#/$defs/description-field" - - $ref: "#/$defs/target-field" - - $ref: "#/$defs/action-fields" - - $ref: "#/$defs/specification-extensions" - required: - - target - unevaluatedProperties: false - specification-extensions: - patternProperties: - ^x-: true diff --git a/versions/1.2.0-editors.md b/versions/1.2.0-editors.md new file mode 100644 index 0000000..6f22f3a --- /dev/null +++ b/versions/1.2.0-editors.md @@ -0,0 +1,16 @@ +# Overlay Specification Editors + +## Active + +- Lorna Mitchell [@lornajane](https://github.com/lornajane) +- Mike Kistler [@mikekistler](https://github.com/mikekistler) +- Ralf Handl [@ralfhandl](https://github.com/ralfhandl) +- Vincent Biret [@baywet](https://github.com/baywet) + +## Emeritus + +- Darrel Miller [@darrelmiller](https://github.com/darrelmiller) +- Greg Dennis [@gregsdennis](https://github.com/gregsdennis) +- Kevin Swiber [@kevinswiber](https://github.com/kevinswiber) +- Mike Ralphson [@MikeRalphson](https://github.com/MikeRalphson) +- Ron Ratovsky [@webron](https://github.com/webron) diff --git a/src/overlay.md b/versions/1.2.0.md similarity index 99% rename from src/overlay.md rename to versions/1.2.0.md index 994f039..960a5c3 100644 --- a/src/overlay.md +++ b/versions/1.2.0.md @@ -779,7 +779,7 @@ Some formats, like [YAML](https://yaml.org/) or [JSONC](https://jsonc.org/), sup | Version | Date | Notes | | ---- | ---- | ---- | -| 1.2.0 | TBD | Release of the Overlay Specification 1.2.0 | +| 1.2.0 | 2026-09-22 | Release of the Overlay Specification 1.2.0 | | 1.1.0 | 2026-01-14 | Release of the Overlay Specification 1.1.0 | | 1.0.0 | 2024-10-17 | First release of the Overlay Specification |