-
Notifications
You must be signed in to change notification settings - Fork 9.2k
dev: schemas live in src folder #4361
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
cefa986
Remove obsolete schemas folder
ralfhandl 70ae381
Adjust README.md
ralfhandl d6d0fe7
Update schema-publish.yaml
ralfhandl b54b525
No loop, just work on src/schemas/validation
ralfhandl 9d4f648
Update schema-publish.yaml
ralfhandl c43615c
npm script for building schemas locally
ralfhandl 183ac8b
Run only on changes to inputs and scripts
ralfhandl bd302e3
Update schema-publish.yaml
ralfhandl 494222b
Use branch name
ralfhandl aaa779b
Update src/schemas/validation/README.md
ralfhandl 0a41814
Update schema-publish.sh
ralfhandl 3e2604f
Merge branch 'dev-schemas-live-in-src' of https://github.com/ralfhand…
ralfhandl 6f75109
Update package.json
ralfhandl afa9511
Update schema-publish.yaml
ralfhandl 90f9f2f
Update README.md
ralfhandl File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
---|---|---|
@@ -1,34 +1,34 @@ | ||
# OpenAPI 3.1.X JSON Schema | ||
# OpenAPI 3.X.Y JSON Schema | ||
|
||
This directory contains the YAML sources for generating the JSON Schemas for validating OpenAPI definitions of versions 3.1.X, which are published on [https://spec.openapis.org](https://spec.openapis.org). | ||
This directory contains the YAML sources for generating the JSON Schemas for validating OpenAPI definitions of versions 3.X.Y, which are published on [https://spec.openapis.org](https://spec.openapis.org). | ||
|
||
Due to limitations of GitHub pages, the schemas on the spec site are served with `Content-Type: application/octet-stream`, but should be interpreted as `application/schema+json`. | ||
|
||
The sources in this directory, which have `WORK-IN-PROGRESS` in their `$id`s, is _not intended for direct use_. | ||
|
||
## Choosing which schema to use | ||
|
||
There are two schemas to choose from for 3.1 usage, both of which have an `$id` that starts with `https://spec.openapis.org/oas/3.1/` and end with date or the `WORK-IN-PROGRESS` placeholder: | ||
|
||
* `https://spec.openapis.org/oas/3.1/schema/{date}` — A self-contained schema that _does not_ validate Schema Objects beyond `type: [object, boolean]` | ||
* `https://spec.openapis.org/oas/3.1/meta/base/{date}` — The vocabulary metaschema for OAS 3.1's extensions to draft 2020-12 | ||
* `https://spec.openapis.org/oas/3.1/dialect/base/{date}` — The dialect metaschema that extends the standard `draft/2020-12` metaschema by adding the OAS "base" vocabulary | ||
* `https://spec.openapis.org/oas/3.1/schema-base/{date}` — A schema that combines the self-contained schema and the "base" dialect schema to validate Schema Objects with the dialect; this schema does not allow changing `$schema` or `jsonSchemaDialect` to other dialects | ||
|
||
The name "base" for the dialect was intended to indicate that the OAS dialect could be further extended. | ||
|
||
An additional schema that validates the Schema Object with the OAS 3.1 dialect but does not restrict changing `$schema` is [under consideration](https://github.com/OAI/OpenAPI-Specification/issues/4147). | ||
The sources in this directory, which have `WORK-IN-PROGRESS` in their `$id`s, are _not intended for direct use_. | ||
|
||
## Schema `$id` dates | ||
|
||
The published schemas on the spec site have an _iteration date_ in their `id`s. | ||
This allows the schemas for a release line (in this case 3.0) to be updated independent of the spec patch release cycle. | ||
This allows the schemas for a release line to be updated independent of the spec patch release cycle. | ||
|
||
The iteration version of the JSON Schema can be found in the `$id` field. | ||
For example, the value of `$id: https://spec.openapis.org/oas/3.1/schema/2021-03-02` means this iteration was created on March 2nd, 2021. | ||
|
||
We are [working on](https://github.com/OAI/OpenAPI-Specification/issues/4152) how to best provide programmatic access for determining the latest date for each schema. | ||
|
||
## Choosing which schema to use | ||
|
||
There are two schemas to choose from for versions 3.1 and greater, both of which have an `$id` that starts with `https://spec.openapis.org/oas/3.X/` and end with the iteration date: | ||
ralfhandl marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
* `https://spec.openapis.org/oas/3.X/schema/{date}`, source: `schema.yaml` — A self-contained schema that _does not_ validate Schema Objects beyond `type: [object, boolean]` | ||
* `https://spec.openapis.org/oas/3.X/meta/{date}`, source: `meta.yaml` — The vocabulary metaschema for OAS 3.X's extensions to draft 2020-12 | ||
* `https://spec.openapis.org/oas/3.X/dialect/base/{date}`, source: `base.yaml` — The dialect metaschema that extends the standard `draft/2020-12` metaschema by adding the OAS "base" vocabulary | ||
* `https://spec.openapis.org/oas/3.1/schema-base/{date}`, source: `schema-base.yaml` — A schema that combines the self-contained schema and the "base" dialect schema to validate Schema Objects with the dialect; this schema does not allow changing `$schema` or `jsonSchemaDialect` to other dialects | ||
|
||
The name "base" for the dialect was intended to indicate that the OAS dialect could be further extended. | ||
|
||
An additional schema that validates the Schema Object with the OAS 3.X dialect but does not restrict changing `$schema` is [under consideration](https://github.com/OAI/OpenAPI-Specification/issues/4147). | ||
|
||
## Improving the schemas | ||
|
||
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. | ||
|
@@ -39,14 +39,14 @@ Schemas to perform additional optional validation are [under consideration](http | |
|
||
Improvements can be submitted by opening a PR against the `main` branch. | ||
|
||
|
||
Modify the `*schema*.yaml` files and add test cases for your changes. | ||
Modify the `schema.yaml` file 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 | ||
|
||
The [test suite](../../tests/v3.1) is part of this package. | ||
The [test suite](../../../tests/schema) is part of this package. | ||
|
||
```bash | ||
npm install | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.