-
Notifications
You must be signed in to change notification settings - Fork 9.2k
Run tests with YAML metaschemas #4137
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
handrews
merged 13 commits into
OAI:main
from
ralfhandl:schemas-yaml-to-json-test-check-in
Oct 18, 2024
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
33c0340
Update schema-tests.yaml
ralfhandl 7532592
Add check-in step
ralfhandl 42f7075
converted JSON metaschemas
ralfhandl 7119547
Update comment
ralfhandl 3a42a45
Merge branch 'schemas-yaml-to-json-test-check-in' of https://github.c…
ralfhandl 50047b6
Update schema-tests.yaml
ralfhandl 882d1ca
Only generate JSON before running the tests
ralfhandl c993d06
Use YAML for schema tests
ralfhandl 1437630
Refresh package.json
ralfhandl a01f8b3
Update package-lock.json
ralfhandl 0016a58
Updated and aligned README.md
ralfhandl b4aa48e
Further align, point to test suite
ralfhandl 7f19e32
validate script
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
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,16 +1,30 @@ | ||
OpenAPI 3.0.X JSON Schema | ||
--- | ||
# OpenAPI 3.0.X JSON Schema | ||
|
||
Here you can find the JSON Schema for validating OpenAPI definitions of versions 3.0.X. | ||
Here you can find the JSON Schema for validating OpenAPI definitions of versions 3.0.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. | ||
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/oas/3.0/schema/2019-04-02` means this iteration was created on April 2nd, 2019. | ||
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.0/schema/2019-04-02` means this iteration was created on April 2nd, 2019. | ||
|
||
To submit improvements to the schema, modify the schema.yaml file only. | ||
## 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 | ||
- Convert the schema.yaml to schema.json | ||
- Publish the new version | ||
|
||
## Tests | ||
|
||
The [test suite](../../tests/v3.0) is part of this package. | ||
|
||
```bash | ||
npm install | ||
npm test | ||
``` |
Oops, something went wrong.
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.