Skip to content

v3.2: Add style: cookie, explain pct-encoding - #4902

Merged
lornajane merged 5 commits into
OAI:v3.2-devfrom
handrews:cookie32-noschema
Aug 23, 2025
Merged

v3.2: Add style: cookie, explain pct-encoding#4902
lornajane merged 5 commits into
OAI:v3.2-devfrom
handrews:cookie32-noschema

Conversation

@handrews

Copy link
Copy Markdown
Member

Replaces PR #4822. Please pay close attention while reviewing, I wrote this through various bouts of illness and then split it from other smaller PRs, and I'm not entirely sure I got it all.

This adds a style: cookie to provide a non-percent-encoding option for managing cookie parameters.

It also explains the conditions under which automatic percent-encoding with style: form might work, and also links to a draft update of the cookie RFC that explains that things that look like percent-encoding should not be decoded for storage, which means that style: cookie is providing the most compliant behavior for that updated guidance.

  • 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

@handrewshandrews added this to the v3.2.0 milestone Aug 21, 2025
@handrews
handrews requested review from a team as code ownersAugust 21, 2025 16:13
@handrewshandrews added the param serialization Issues related to parameter and/or header serialization label Aug 21, 2025
@handrewshandrews changed the title Add style: cookie, explain pct-encodingv3.2: Add style: cookie, explain pct-encodingAug 21, 2025
This adds a `style: cookie` to provide a non-percent-encoding
option for managing cookie parameters.
It also explains the conditions under which automatic percent-encoding
with `style: form` might work, and also links to a draft update of
the cookie RFC that explains that things that look like percent-encoding
should _not_ be decoded for storage, which means that `style: cookie`
is providing the most compliant behavior for that updated guidance.
Comment threadsrc/oas.md Outdated
Comment threadsrc/oas.md Outdated
Comment threadsrc/oas.md Outdated
Comment threadsrc/oas.md
Comment threadsrc/oas.md

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

Comments from the TDC call and some minor edits

Comment threadsrc/oas.md Outdated
Comment threadsrc/oas.md
Comment threadsrc/oas.md Outdated
Comment threadsrc/oas.md Outdated
Comment threadsrc/oas.md Outdated
Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
Co-authored-by: Vincent Biret <vincentbiret@hotmail.com>

@handrewshandrews left a comment

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I'll fix the remaining things soon- I think I have either accepted the suggestions or otherwise replied to all comments for now.

Comment threadsrc/oas.md
Comment threadsrc/oas.md Outdated
Comment threadsrc/oas.md
@handrews

Copy link
Copy Markdown
MemberAuthor

I have updated most of the things. Due to the state of my health and general exhaustion, I'd like to plead that we focus only on accuracy and not what examples or formatting might be nice to have.

@lornajane – I changed "simulating" to "simulating/extending" which might make it a bit more clear why it's not just useing? idk. For the extra level on the examples, I'd happily approve a follow-on PR doing that to all of the examples in this section (although see next point below).

@baywet – I'll follow up with you on slack, but the example request is a bit more complicated. I'll happy approve a follow-on PR from you, and answer any questions you might have while making it.

@karenetheridge – I will gladly approve a PR removing the JSON-like formatting from dataValue throughout the entire spec. It's a convention that makes sense to me, but... I'm a werid data point and if no one else finds it compelling and you find it confusing, let's toss it. But for the whole spec at once.

Comment threadsrc/oas.md Outdated
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.

Adding a new style seemed radical but I think it works!

@lornajane
lornajane merged commit e4c0230 into OAI:v3.2-devAug 23, 2025
2 checks passed
@handrews
handrews deleted the cookie32-noschema branch August 27, 2025 17:32
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

param serializationIssues related to parameter and/or header serialization

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@handrews@lornajane@karenetheridge@ralfhandl@baywet