Skip to content

Commit 3dcfee1

Browse files
committed
Added README with basic information
1 parent 6d17b63 commit 3dcfee1

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

schemas/v3.0/README.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
OpenAPI 3.0.X JSON Schema
2+
---
3+
4+
Here you can find the JSON Schema for validating OpenAPI definitions of versions 3.0.X.
5+
6+
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.
7+
8+
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.
9+
10+
To submit improvements to the schema, modify the schema.yaml file only.
11+
12+
The TSC will then:
13+
- Run tests on the updates schema
14+
- Update the iteration version
15+
- Convert the schema.yaml to schema.json
16+
- Publish the new version

0 commit comments

Comments
 (0)