Merge pull request #1270 from OAI/oas3-schema

[WIP] Alternative OAS3 JSON Schema
OAI · Apr 18, 2019 · ce93fe4 · ce93fe4
2 parents d34e2ad + 35ab014
commit ce93fe4
Show file tree

Hide file tree

Showing 3 changed files with 2,673 additions and 0 deletions.
diff --git a/schemas/v3.0/README.md b/schemas/v3.0/README.md
@@ -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 updated schema
+- Update the iteration version
+- Convert the schema.yaml to schema.json
+- Publish the new version