Skip to content

More guidance on schema dialects.#3909

Merged
handrews merged 3 commits intoOAI:v3.1.1-devfrom
handrews:dialect-311
Jun 18, 2024
Merged

More guidance on schema dialects.#3909
handrews merged 3 commits intoOAI:v3.1.1-devfrom
handrews:dialect-311

Conversation

@handrews
Copy link
Copy Markdown
Member

Fixes:

This makes it more clear that jsonSchemaDialect, like $schema, is per document, and provides guidance for incomplete OAS documents and using $schema in standalone schema documents.

It also clarifies the nature of "requiring" the OAS extension vocabulary.

@handrews handrews added schema-object clarification requests to clarify, but not change, part of the spec labels Jun 13, 2024
@handrews handrews added this to the v3.1.1 milestone Jun 13, 2024
@handrews handrews requested a review from a team June 13, 2024 20:41
This makes it more clear that jsonSchemaDialect, like $schema,
is per document, and provides guidance for incomplete OAS documents
and using $schema in standalone schema documents.

It also clarifies the nature of "requiring" the OAS extension
vocabulary.
ralfhandl
ralfhandl previously approved these changes Jun 14, 2024
Comment thread versions/3.1.1.md
@ralfhandl ralfhandl requested a review from a team June 14, 2024 11:41
Comment thread versions/3.1.1.md Outdated
Co-authored-by: Karen Etheridge <github@froods.org>
@handrews
Copy link
Copy Markdown
Member Author

@karenetheridge I did some further wordsmithing of that section to align more with how the JSON Schema spec talks about false vocabularies and unknown keywords - please take a look and let me know if that works!

@ralfhandl ralfhandl requested a review from karenetheridge June 18, 2024 09:46
Copy link
Copy Markdown
Contributor

@mikekistler mikekistler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. 👍

@ralfhandl
Copy link
Copy Markdown
Contributor

@karenetheridge Please confirm

Copy link
Copy Markdown
Member

@karenetheridge karenetheridge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks!

@handrews handrews merged commit f4c3484 into OAI:v3.1.1-dev Jun 18, 2024
@handrews handrews deleted the dialect-311 branch June 19, 2024 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clarification requests to clarify, but not change, part of the spec schema-object

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants