Skip to content

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

Merged
handrews merged 6 commits into
OAI:v3.1-devfrom
swaggerexpert:char0n/add-header-into-working-with-examples
Dec 19, 2024
Merged

Editorial change: Include Header Object into 'Working With Examples' section#4265
handrews merged 6 commits into
OAI:v3.1-devfrom
swaggerexpert:char0n/add-header-into-working-with-examples

Conversation

@char0n

@char0nchar0n commented Dec 18, 2024

Copy link
Copy Markdown
Contributor

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 ownersDecember 18, 2024 13:27

@ralfhandlralfhandl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Minor changes

Comment threadsrc/oas.md Outdated
Comment threadsrc/oas.md Outdated
Comment threadsrc/oas.md Outdated
Comment threadsrc/oas.md Outdated
@ralfhandl
ralfhandl requested review from a team, handrews and ralfhandlDecember 18, 2024 16:09
char0nand others added 4 commits December 18, 2024 17:55
Co-authored-by: Ralf Handl <ralf.handl@sap.com>
Co-authored-by: Ralf Handl <ralf.handl@sap.com>
Co-authored-by: Ralf Handl <ralf.handl@sap.com>
Co-authored-by: Ralf Handl <ralf.handl@sap.com>
@char0n

Copy link
Copy Markdown
ContributorAuthor

@ralfhandl thanks for catching all inconsistencies!

handrews
handrews previously approved these changes Dec 18, 2024
mikekistler
mikekistler previously approved these changes Dec 18, 2024

@mikekistlermikekistler left a comment

Copy link
Copy Markdown

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.

Comment threadsrc/oas.md Outdated
Co-authored-by: Mike Kistler <mikekistler@microsoft.com>
@char0n
char0n dismissed stale reviews from mikekistler and handrews via f896bb7December 18, 2024 20:56
@ralfhandl
ralfhandl requested review from a team, handrews and mikekistlerDecember 19, 2024 09:47
@handrews
handrews merged commit 4e4a292 into OAI:v3.1-devDec 19, 2024
Sign up for freeto 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

@char0n@ralfhandl@handrews@mikekistler