Skip to content

Commit 8a1710d

Browse files
authored
Merge pull request #4896 from ralfhandl/dev-schema-readme
2 parents ffd3398 + 27b6236 commit 8a1710d

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

src/schemas/validation/README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,27 @@ We are [working on](https://github.com/OAI/OpenAPI-Specification/issues/4152) ho
2121
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 ends with the iteration date:
2222

2323
* `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
2624
* `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
2725

26+
Two metaschemas define the OAS "base" dialect:
27+
28+
* `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
29+
* `https://spec.openapis.org/oas/3.X/dialect/{date}`, source: `dialect.yaml` — The dialect metaschema that extends the standard `draft/2020-12` metaschema by adding the OAS "base" vocabulary
30+
2831
The name "base" for the dialect was intended to indicate that the OAS dialect could be further extended.
2932

33+
~~~mermaid
34+
flowchart LR
35+
schema_base
36+
schema
37+
dialect
38+
meta
39+
schema --> |default| dialect
40+
schema_base --> |$ref| schema
41+
schema_base --> |$ref| dialect
42+
dialect --> |$ref| meta
43+
~~~
44+
3045
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).
3146

3247
## Improving the schemas

0 commit comments

Comments
 (0)