Skip to content
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

OASv3.1 Schema #2474

Closed
wants to merge 27 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
66b19c7
chore: attempt at a OAS3.1 metaschema
philsturgeon Feb 18, 2021
b02db8c
license identifier
philsturgeon Feb 18, 2021
c49a2f0
require webhooks or paths or schemas
philsturgeon Feb 18, 2021
cd9621f
add info.summary
philsturgeon Feb 18, 2021
59b190a
restrictions? What restrictions? 🥳
philsturgeon Feb 18, 2021
401faed
mutualTLS, dunno any more about it
philsturgeon Feb 18, 2021
1e87e94
no # in id
philsturgeon Feb 18, 2021
ff17110
Update schemas/v3.1/schema.yaml
philsturgeon Feb 18, 2021
4971aa2
not id
philsturgeon Feb 18, 2021
855779a
Convert $ids to $anchors in 3.1 meta-schema
jdesrosiers Feb 19, 2021
397d3f4
Fix #Info reference in 3.1 meta-schema
jdesrosiers Feb 19, 2021
9e357c6
Add missing ExternalDocumentation definition
jdesrosiers Feb 19, 2021
3501339
Fix typo in reference to Extensible schema
jdesrosiers Feb 19, 2021
dffc1dc
Fix typo in MutualTLS anchor
jdesrosiers Feb 19, 2021
e131c2d
Fix typo $refs -> $ref in 3.1 meta-schema
jdesrosiers Feb 19, 2021
bf79d7e
Update 3.1 meta-schema to use draft 2020-12
jdesrosiers Feb 19, 2021
39ddeb9
Fixes for issues uncovered by @MikeRalphson's openapi3.1-examples
jdesrosiers Feb 19, 2021
c102f7d
Merge pull request #1 from jdesrosiers/oas31-schema
philsturgeon Feb 23, 2021
50c538a
use hyperjump to validate
philsturgeon Feb 23, 2021
080a57e
Apply suggestions from code review
philsturgeon Feb 23, 2021
6b0e847
redundant escape
philsturgeon Feb 23, 2021
5acfcd1
updated schema.json
philsturgeon Feb 23, 2021
cbe1532
Apply suggestions from code review
philsturgeon Mar 3, 2021
ff6a7d1
updated JSON
philsturgeon Mar 3, 2021
4943f59
remove operation
philsturgeon Mar 3, 2021
798bce2
Apply suggestions from code review
philsturgeon Mar 3, 2021
5ef1fa9
Apply suggestions from code review
philsturgeon Mar 3, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@
"README.md",
"schemas/*"
],
"dependencies": {},
"dependencies": {
"@hyperjump/json-schema": "^0.17.0",
"@hyperjump/json-schema-core": "^0.20.0"
},
"devDependencies": {
"mdv": "^1.0.7",
"yaml": "^1.8.3"
Expand Down
16 changes: 16 additions & 0 deletions schemas/v3.1/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
OpenAPI 3.1.X JSON Schema
---

Here you can find the JSON Schema for validating OpenAPI definitions of versions 3.1.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/oas/3.1/schema/2021-02-18` means this iteration was created on February 18th, 2021.

To submit improvements to the schema, modify the schema.yaml file only.

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
Loading