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

Consisent x- Param/Encoding/Header wording (3.0.4) #3919

Merged
merged 1 commit into from
Jun 18, 2024

Conversation

handrews
Copy link
Member

It was a bit challenging to figure out where to put the wording about allowing extension parameters when there are multiple fixed fields tables, each in their own subsection.

For the Parameter Object (the only one with multiple tables in past releases), it had been after the last table, but that got further and further away from what felt like the main part of the Object description.

I thought I had put it consistently after the initial "Common Fixed Fields" table, but I put it even before that in one place (which we don't do anywhere), and I forgot to include it in the Header Object at all.

This change puts it after the Common Fixed Fields table for all three, which means that for all Objects it is immediately after the first Fixed Fields table. Note that the Encoding Object is not in this diff as the line was in the right place already for that Object.

It was a bit challenging to figure out where to put the wording
about allowing extension parameters when there are multiple
fixed fields tables, each in their own subsection.

For the Parameter Object (the only one with multiple tables in
past releases), it had been after the last table, but that got
further and further away from what felt like the main part of
the Object description.

I thought I had put it consistently after the initial
"Common Fixed Fields" table, but I put it even before that in
one place (which we don't do anywhere), and I forgot to include
it in the Header Object at all.

This change puts it after the Common Fixed Fields table for
all three, which means that for all Objects it is immediately
after the first Fixed Fields table.
@handrews handrews added bug param serialization Issues related to parameter and/or header serialization headers editorial Wording and stylistic issues labels Jun 17, 2024
@handrews handrews added this to the v3.0.4 milestone Jun 17, 2024
@handrews handrews requested a review from a team June 17, 2024 18:42
@ralfhandl ralfhandl requested a review from a team June 18, 2024 09:36
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! 👍

@ralfhandl ralfhandl merged commit 936f8a5 into OAI:v3.0.4-dev Jun 18, 2024
1 check passed
@handrews handrews deleted the ext-304 branch June 19, 2024 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug editorial Wording and stylistic issues headers param serialization Issues related to parameter and/or header serialization
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants