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

Query Parameter doc is incorrect #217

Open
jwalton opened this issue Apr 7, 2018 · 4 comments
Open

Query Parameter doc is incorrect #217

jwalton opened this issue Apr 7, 2018 · 4 comments

Comments

@jwalton
Copy link

jwalton commented Apr 7, 2018

Un the Query Parameters section of [https://swagger.io/docs/specification/serialization/], the table shows the "object" column for {style: 'pipeDelimited', explode: false} and {style: 'spaceDelimited', explode: false} as "N/A", but the table in the spec shows examples here.

@hkosova
Copy link
Contributor

hkosova commented Apr 9, 2018

This might be a mistake in the OpenAPI Specification itself -- the Style Values section says that pipeDelimited and spaceDelimited apply to arrays only, so the behavior for objects is undefined. N/a in our doc means undefined behavior.

Here's a related discussion about pipeDelimited and spaceDelimited in the Specification repository (see point "2"): OAI/OpenAPI-Specification#1508 (comment).

@webron do you have anything to add?

@webron
Copy link
Contributor

webron commented Apr 9, 2018

@hkosova it looks like the description of the styles is inaccurate (in the spec). I guess it's remnants of the previous version.

@karenetheridge
Copy link

Has this been fixed in the spec?

@hkosova
Copy link
Contributor

hkosova commented Nov 18, 2021

@karenetheridge yes, the definition of pipeDelimited and spaceDelimited styles was fixed in OpenAPI 3.1:
OAI/OpenAPI-Specification#2101

But the docs on swagger.io have not been updated w/r/t 3.1 yet.

@hkosova hkosova removed their assignment Apr 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants