search

swagger-api / swagger.io-docs

The content of swagger.io
https://swagger.io/docs/
1.56k stars 401 forks source link

Query Parameter doc is incorrect #217

Open jwalton opened 6 years ago

jwalton commented 6 years ago

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 commented 6 years ago

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"): https://github.com/OAI/OpenAPI-Specification/issues/1508#issuecomment-373915620.

@webron do you have anything to add?

webron commented 6 years ago

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

karenetheridge commented 3 years ago

Has this been fixed in the spec?

hkosova commented 3 years ago

@karenetheridge yes, the definition of pipeDelimited and spaceDelimited styles was fixed in OpenAPI 3.1: https://github.com/OAI/OpenAPI-Specification/pull/2101

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