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

There appears to be a typo in this table about parameter serialization... #3139

Closed
InfoSec812 opened this issue Jan 16, 2023 · 3 comments
Closed
Labels
bug examples requests for more or better examples in the specification param serialization Issues related to parameter and/or header serialization
Milestone

Comments

@InfoSec812
Copy link
Contributor

label | true | . | .blue | .blue.black.brown | .R=100.G=200.B=150

In the current 3.1 OpenAPI Specification the table in the image below seems to have an error which is in conflict with the docs on the OpenAPI web site. I am looking for clarification on this difference. Please see the in-line screenshots for highlighted differences:

image

Both label notations use dots in this document, but on the web site:

image

The exploded version uses dots and the non-exploded version uses commas in accordance with RFC6570.

Could someone please clarify and confirm? If this is a mistake, I would be happy to submit a PR to resolve.

@hkosova
Copy link
Contributor

hkosova commented Jan 16, 2023

As the person who wrote the doc on your 2nd screenshot - I believe it's indeed a typo in the spec. According to RFC 6570 section 3.2.5 "Label expansion", which in turn points to section 3.2.1 (emphasis mine):

For a variable that is an associative array, expansion depends on both the expression type and the presence of an explode modifier. If there is no explode modifier, expansion consists of appending a comma-separated concatenation of each (name, value) pair that has a defined value. If there is an explode modifier, expansion consists of appending each pair that has a defined value as either "name=value" or, ...

@InfoSec812
Copy link
Contributor Author

Thanks all for the extremely quick response and resolution!

@handrews
Copy link
Member

I think this is also present in 3.0.3 so I am tagging this for 3.0.4 as well.

@handrews handrews added the 3.0.4 label Feb 28, 2023
@handrews handrews closed this as completed Mar 5, 2023
@handrews handrews modified the milestones: v3.1.1, v3.0.4 Jan 27, 2024
@handrews handrews added bug examples requests for more or better examples in the specification param serialization Issues related to parameter and/or header serialization labels May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug examples requests for more or better examples in the specification param serialization Issues related to parameter and/or header serialization
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants