diff --git a/schemas/v3.0/README.md b/schemas/v3.0/README.md index 84956279da..ebe15ca73c 100644 --- a/schemas/v3.0/README.md +++ b/schemas/v3.0/README.md @@ -1,16 +1,29 @@ -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. +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 +- Convert the `schema.yaml` to `schema.json` - Publish the new version + +## Tests + +The test suite is part of this package. + +```bash +npm install +npm test +``` diff --git a/schemas/v3.1/README.md b/schemas/v3.1/README.md index 01da62b56d..4509584071 100644 --- a/schemas/v3.1/README.md +++ b/schemas/v3.1/README.md @@ -1,7 +1,6 @@ # OpenAPI 3.1.X JSON Schema -Here you can find the JSON Schema for validating OpenAPI definitions of versions -3.1.X. +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 @@ -9,9 +8,8 @@ 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-03-02` -means this iteration was created on March 2nd, 2021. +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-03-02` means this iteration was created on March 2nd, 2021. The `schema.yaml` schema doesn't validate the JSON Schemas in your OpenAPI document because 3.1 allows you to use any JSON Schema dialect you choose. We @@ -19,23 +17,20 @@ have also included `schema-base.yaml` that extends the main schema to validate that all schemas use the default OAS base vocabulary. ## Contributing -To submit improvements to the schema, modify the schema.yaml file only. + +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 +- Convert the `schema.yaml` to `schema.json` - Publish the new version ## Tests -The test suite is included as a git submodule of https://github.com/Mermade/openapi3-examples. - -```bash -npx mocha --recursive tests -``` -You can also validate a document individually. +The test suite is part of this package. ```bash -scripts/validate.js path/to/document/to/validate.yaml +npm install +npm test ```