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

Example of deepObject + explode=false #1322

Closed
hkosova opened this issue Aug 16, 2017 · 4 comments
Closed

Example of deepObject + explode=false #1322

hkosova opened this issue Aug 16, 2017 · 4 comments
Assignees
Labels
examples requests for more or better examples in the specification param serialization Issues related to parameter and/or header serialization
Milestone

Comments

@hkosova
Copy link
Contributor

hkosova commented Aug 16, 2017

How are objects serialized when using style: deepObject and explode: false? Style Examples contain a deepObject example only for explode: true.

(Related - OAI/learn.openapis.org#100)

@handrews handrews added the examples requests for more or better examples in the specification label Jan 27, 2024
@handrews handrews added the param serialization Issues related to parameter and/or header serialization label May 27, 2024
@handrews handrews added this to the v3.0.4 milestone May 27, 2024
@handrews handrews self-assigned this May 27, 2024
@handrews
Copy link
Member

@hkosova to me, the deepObject example for explode: true is what I'd expect from explode: false. I'd expect explode: true to go down one level deeper, e.g. R[x]=100&R[y]=150&G[w]=200&B[z]=150, assuming R, G, and B were themselves objects.

So I'm not sure what to do here. I think there just isn't defined behavior for explode: false (despite it being the default with style: deepObject?

@OAI/tsc anyone remember what this should be?

@lornajane
Copy link
Contributor

We discussed that we probably don't need exploded (or not) alternatives for deepObject; @handrews will add a clarification note but we won't add another entry for it with explode=false

@handrews
Copy link
Member

handrews commented Jun 8, 2024

Fix added to PR #3859. @lornajane I know you said don't add more rows but it was just bothering the heck out of me that it's unclear in the one place people glance at the most (rather than poring over the text). If you want me to remove them I will, but I as I look over the voluminous history of issues and complaints in this area, I think failing to address it in the table is problematic (and likewise for the other incomplete entires).

@handrews handrews removed the review label Jun 9, 2024
@handrews
Copy link
Member

PR merged for 3.0.4 and ported to 3.1.1 via PR #3921!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
examples requests for more or better examples in the specification param serialization Issues related to parameter and/or header serialization
Projects
None yet
Development

No branches or pull requests

3 participants