Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor webhooks/callbacks and schema examples improvements (3.1.1) #3862

Merged
merged 3 commits into from
Jun 10, 2024

Conversation

handrews
Copy link
Member

Fixes:

These are the minor editorial issues that do not apply to 3.0.4 and therefore do not fit in PR #3861 (which will be forward-ported as usual, but separately to ensure no one misses the 3.1.1-specific improvements).

Hopefully I did the right thing with webhooks vs callbacks here.

Not only do we not capitalize the "h" elsewhere, this example,
which pre-dated 3.1 webhooks, used the term in a confusinglty
not-quite-the-same way.
3.1 deprecates the OAS extension `example` schema keyword
in favor of the draft 2020-12 `examples` standard schema keyword.
@handrews handrews added clarification requests to clarify, but not change, part of the spec editorial Wording and stylistic issues labels May 27, 2024
@handrews handrews added this to the v3.0.4 milestone May 27, 2024
@handrews handrews requested a review from a team May 27, 2024 22:45
ralfhandl
ralfhandl previously approved these changes May 28, 2024
Copy link
Contributor

@ralfhandl ralfhandl left a comment

Choose a reason for hiding this comment

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

+1, formulation suggestion

versions/3.1.1.md Outdated Show resolved Hide resolved
@ralfhandl ralfhandl merged commit cad29a6 into OAI:v3.1.1-dev Jun 10, 2024
1 check passed
@handrews handrews deleted the editorial-311 branch June 10, 2024 19:06
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 editorial Wording and stylistic issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants