Skip to content

Editorial change: Include Header Object into 'Working With Examples' section #4265

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

Conversation

char0n
Copy link
Contributor

@char0n char0n commented Dec 18, 2024

When studying changes of OpenAPI 3.0.4 (from the OpenAPI 3.0.3), I've noticed a section Working with examples. Everything that is written there does apply to Header Object. In other section when something apply to Header Object it is enumerated explicitly. But in Working with examples section, the header is missing. IMHO it's an unintended omission, and this PR is trying to remedy it.

Appendix B.

image

Appendix C.

image

@char0n char0n requested review from a team as code owners December 18, 2024 13:27
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.

Minor changes

@ralfhandl ralfhandl requested review from ralfhandl, handrews and a team December 18, 2024 16:09
char0n and others added 4 commits December 18, 2024 17:55
Co-authored-by: Ralf Handl <[email protected]>
Co-authored-by: Ralf Handl <[email protected]>
Co-authored-by: Ralf Handl <[email protected]>
Co-authored-by: Ralf Handl <[email protected]>
@char0n
Copy link
Contributor Author

char0n commented Dec 18, 2024

@ralfhandl thanks for catching all inconsistencies!

handrews
handrews previously approved these changes Dec 18, 2024
mikekistler
mikekistler previously approved these changes Dec 18, 2024
Copy link
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. 👍

I left one question/suggestion that you may want to consider.

Co-authored-by: Mike Kistler <[email protected]>
@char0n char0n dismissed stale reviews from mikekistler and handrews via f896bb7 December 18, 2024 20:56
@ralfhandl ralfhandl requested review from mikekistler, handrews and a team December 19, 2024 09:47
@handrews handrews merged commit 4e4a292 into OAI:v3.1-dev Dec 19, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants