Skip to content

Commit

Permalink
Added README with basic information
Browse files Browse the repository at this point in the history
  • Loading branch information
webron committed Apr 18, 2019
1 parent 6d17b63 commit 3dcfee1
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions schemas/v3.0/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
OpenAPI 3.0.X JSON Schema
---

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.

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.

The TSC will then:
- Run tests on the updates schema
- Update the iteration version
- Convert the schema.yaml to schema.json
- Publish the new version

0 comments on commit 3dcfee1

Please sign in to comment.