Skip to content

Commit 20893ba

Browse files
committed
Further guidance on schemas.
Explain the not-entirely-intuitive schema naming for OAS 3.1, and link to issues discussing various schema FAQs.
1 parent 947559d commit 20893ba

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ _TBD_
4242

4343
### OpenAPI Specification Schemas
4444

45+
Note that the OAS 3.1 `schema/YYYY-MM-DD` schema does _not_ validate the Schema Object, as it makes no assumptions about the JSON Schema dialect in use. The OAS 3.1 `schema-base/YYYY-MM-DD` schema _does_ validate the Schema Object, and requires that if `jsonSchemaDialect` or `$schema` are present, that they use the appropriate `dialect/YYYY-MM-DD`. The name `schema-base` comes from the JSON Schema dialect including the OAS extensions being referred to as the "base dialect" in the specification.
46+
47+
See [issue #4147](https://github.com/OAI/OpenAPI-Specification/issues/4147) for discussion of other possible JSON Schema dialect options, [issue #4152](https://github.com/OAI/OpenAPI-Specification/issues/4152) for programmatic access to the latest schemas, and [issue #4141](https://github.com/OAI/OpenAPI-Specification/issues/4141) for discussions on possibly providing linting schemas that could catch likely problems that do not directly violate the specification.
48+
4549
{% assign schema_files = site.static_files | where: "extname", "" | sort: "path" | reverse %}
4650
{% assign last_version = "" %}
4751
{% assign last_kind = "" %}

0 commit comments

Comments
 (0)