Skip to content

Conversation

handrews
Copy link
Member

@handrews handrews commented Aug 21, 2025

We want it to apply only when percent-encoding applies:

  • in: path
  • in: query
  • in: cookie [no style- deafult is form]
  • in: cookie, style: form

But not:

  • in: header
  • in: cookie, style: cookie

The schema changes needed for this are a bit complex to handle in: "cookie" with both no style, and with an expicit style: "form".

  • schema changes are included in this pull request
  • schema changes are needed for this pull request but not done yet
  • no schema changes are needed for this pull request

We want it to apply only when percent-encoding applies:

* in: path
* in: query
* in: cookie [no style- deafult is form]
* in: cookie, style: form

But not:

* in: header
* in: cookie, style: cookie
@handrews handrews added this to the v3.2.0 milestone Aug 21, 2025
@handrews handrews added the param serialization Issues related to parameter and/or header serialization label Aug 21, 2025
@handrews handrews requested review from a team as code owners August 21, 2025 15:54
Copy link
Contributor

@lornajane lornajane left a comment

Choose a reason for hiding this comment

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

Good clarification, thanks

@lornajane lornajane requested a review from a team August 21, 2025 16:09
@lornajane
Copy link
Contributor

Can we get a separate issue for the followup schema change so we don't lose it? I'm not sure I understand enough to create the issue.

@karenetheridge
Copy link
Member

I can provide the schema changes to this PR.

@ralfhandl ralfhandl merged commit 49d1c51 into OAI:v3.2-dev Aug 21, 2025
2 checks passed
@handrews handrews mentioned this pull request Aug 21, 2025
1 task
@handrews
Copy link
Member Author

@lornajane I added #4598 (comment) to the schema-tracking issue that I know @karenetheridge is already following.

@handrews handrews deleted the allow-reserved branch August 27, 2025 17:32
@karenetheridge
Copy link
Member

"This field only applies to.." -- is that intending to say that other combinations of properties are ILLEGAL? or simply that if they're there, they are ignored?

If the latter, then there are no schema changes to be made here.

@handrews
Copy link
Member Author

@karenetheridge the "only applies" language has been there since 3.0.0, we're only broadening it's applicability a bit. So... whatever it meant before? I think we have interpreted that as "ignore", but I'm not 100% sure. Ignoring is it reasonable-ish, particularly with the new wording, as there are no reserved characters to allow for the field combinations to which it does not apply.

(TL;DR: don't know)

@karenetheridge
Copy link
Member

I feel like we can't add exclusions to the schema here, at least not until 4.0 when breaking changes are allowed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

headers param serialization Issues related to parameter and/or header serialization

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants