Skip to content

Commit 70ae381

Browse files
committed
Adjust README.md
1 parent cefa986 commit 70ae381

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

src/schemas/validation/README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
# OpenAPI 3.1.X JSON Schema
1+
# OpenAPI 3.X.Y JSON Schema
22

3-
This directory contains the YAML sources for generating the JSON Schemas for validating OpenAPI definitions of versions 3.1.X, which are published on [https://spec.openapis.org](https://spec.openapis.org).
3+
This directory contains the YAML sources for generating the JSON Schemas for validating OpenAPI definitions of versions 3.X.Y, which are published on [https://spec.openapis.org](https://spec.openapis.org).
44

55
Due to limitations of GitHub pages, the schemas on the spec site are served with `Content-Type: application/octet-stream`, but should be interpreted as `application/schema+json`.
66

7-
The sources in this directory, which have `WORK-IN-PROGRESS` in their `$id`s, is _not intended for direct use_.
8-
9-
## Choosing which schema to use
10-
11-
There are two schemas to choose from for 3.1 usage, both of which have an `$id` that starts with `https://spec.openapis.org/oas/3.1/` and end with date or the `WORK-IN-PROGRESS` placeholder:
12-
13-
* `https://spec.openapis.org/oas/3.1/schema/{date}` — A self-contained schema that _does not_ validate Schema Objects beyond `type: [object, boolean]`
14-
* `https://spec.openapis.org/oas/3.1/meta/base/{date}` — The vocabulary metaschema for OAS 3.1's extensions to draft 2020-12
15-
* `https://spec.openapis.org/oas/3.1/dialect/base/{date}` — The dialect metaschema that extends the standard `draft/2020-12` metaschema by adding the OAS "base" vocabulary
16-
* `https://spec.openapis.org/oas/3.1/schema-base/{date}` — A schema that combines the self-contained schema and the "base" dialect schema to validate Schema Objects with the dialect; this schema does not allow changing `$schema` or `jsonSchemaDialect` to other dialects
17-
18-
The name "base" for the dialect was intended to indicate that the OAS dialect could be further extended.
19-
20-
An additional schema that validates the Schema Object with the OAS 3.1 dialect but does not restrict changing `$schema` is [under consideration](https://github.com/OAI/OpenAPI-Specification/issues/4147).
7+
The sources in this directory, which have `WORK-IN-PROGRESS` in their `$id`s, are _not intended for direct use_.
218

229
## Schema `$id` dates
2310

2411
The published schemas on the spec site have an _iteration date_ in their `id`s.
25-
This allows the schemas for a release line (in this case 3.0) to be updated independent of the spec patch release cycle.
12+
This allows the schemas for a release line to be updated independent of the spec patch release cycle.
2613

2714
The iteration version of the JSON Schema can be found in the `$id` field.
2815
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.
2916

3017
We are [working on](https://github.com/OAI/OpenAPI-Specification/issues/4152) how to best provide programmatic access for determining the latest date for each schema.
3118

19+
## Choosing which schema to use
20+
21+
There are two schemas to choose from for versions 3.1 and greater, both of which have an `$id` that starts with `https://spec.openapis.org/oas/3.X/` and end with the iteration date:
22+
23+
* `https://spec.openapis.org/oas/3.X/schema/{date}`, source: `schema.yaml` — A self-contained schema that _does not_ validate Schema Objects beyond `type: [object, boolean]`
24+
* `https://spec.openapis.org/oas/3.X/meta/{date}`, source: `meta.yaml` — The vocabulary metaschema for OAS 3.X's extensions to draft 2020-12
25+
* `https://spec.openapis.org/oas/3.X/dialect/base/{date}`, source: `base.yaml` — The dialect metaschema that extends the standard `draft/2020-12` metaschema by adding the OAS "base" vocabulary
26+
* `https://spec.openapis.org/oas/3.1/schema-base/{date}`, source: `schema-base.yaml` — A schema that combines the self-contained schema and the "base" dialect schema to validate Schema Objects with the dialect; this schema does not allow changing `$schema` or `jsonSchemaDialect` to other dialects
27+
28+
The name "base" for the dialect was intended to indicate that the OAS dialect could be further extended.
29+
30+
An additional schema that validates the Schema Object with the OAS 3.X dialect but does not restrict changing `$schema` is [under consideration](https://github.com/OAI/OpenAPI-Specification/issues/4147).
31+
3232
## Improving the schemas
3333

3434
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.
@@ -39,14 +39,14 @@ Schemas to perform additional optional validation are [under consideration](http
3939

4040
Improvements can be submitted by opening a PR against the `main` branch.
4141

42-
Modify the `*schema*.yaml` files and add test cases for your changes.
42+
Modify the `schema.yaml` file and add test cases for your changes.
4343

4444
The TSC will then:
4545
- Run tests on the updated schema
4646
- Update the iteration version
4747
- Publish the new version
4848

49-
The [test suite](../../tests/v3.1) is part of this package.
49+
The [test suite](../../../tests/schema) is part of this package.
5050

5151
```bash
5252
npm install

0 commit comments

Comments
 (0)