Skip to content

Verbose Header Object documentation (3.0.4) - #3867

Merged
handrews merged 6 commits into
OAI:v3.0.4-devfrom
handrews:header-obj-304
Jun 10, 2024
Merged

Verbose Header Object documentation (3.0.4)#3867
handrews merged 6 commits into
OAI:v3.0.4-devfrom
handrews:header-obj-304

Conversation

@handrews

@handrewshandrews commented May 30, 2024

Copy link
Copy Markdown
Member

Fixes:

This copies the relevant Parameter Object fields to the Header Object instead of relying on implicit guidance. The text for the fields has been edited to reflect that only headers are being described.

This also include an example of describing a header using the content field, and explaining why it is necessary to do so.

NOTE: Includes some appendix headings to placate the PR markdown validation check.

This copies the relevant Parameter Object fields to the Header Object
instead of relying on implicit guidance. The text for the fields
has been edited to reflect that only headers are being described.
This also include an example of describing a header using the
`content` field, and explaining why it is necessary to do so.
@handrewshandrews added clarification requests to clarify, but not change, part of the spec headers labels May 30, 2024
@handrewshandrews added this to the v3.0.4 milestone May 30, 2024
@handrews
handrews requested a review from a teamMay 30, 2024 20:20
...to placate the PR checks in GitHub.

@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.

Thanks for the diligence!

Only minor suggestions.

Comment threadversions/3.0.4.md Outdated
Comment threadversions/3.0.4.md Outdated
Comment threadversions/3.0.4.md Outdated
Comment threadversions/3.0.4.md
Co-authored-by: Ralf Handl <ralf.handl@sap.com>

@lornajanelornajane 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.

More information is good information IMO, thank you for this addition.

Comment threadversions/3.0.4.md
Comment threadversions/3.0.4.md Outdated
Comment threadversions/3.0.4.md
Co-authored-by: Ralf Handl <ralf.handl@sap.com>

@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 nit

Comment threadversions/3.0.4.md Outdated
miqui
miqui previously approved these changes Jun 7, 2024
Co-authored-by: Ralf Handl <ralf.handl@sap.com>
@ralfhandl
ralfhandl requested a review from lornajaneJune 10, 2024 11:27
@handrews

Copy link
Copy Markdown
MemberAuthor

This has two TSC approvals and a third positive-comment-with-questions-that-have-been-resolved near-approval so I'm going to merge this to start to reduce the amount of conflicts with empty sections and the like.

@handrews
handrews merged commit 44eda57 into OAI:v3.0.4-devJun 10, 2024
@handrews
handrews deleted the header-obj-304 branch June 10, 2024 17:38
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

clarificationrequests to clarify, but not change, part of the specheaders

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@handrews@lornajane@ralfhandl@miqui