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

fix: typo in style example #3144

Merged
merged 1 commit into from
Mar 4, 2023
Merged

fix: typo in style example #3144

merged 1 commit into from
Mar 4, 2023

Conversation

ralfhandl
Copy link
Contributor

The example for style=label, explode=false in https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-examples is incorrect, see comment #1508 (comment) from @darrelmiller and the examples in https://swagger.io/docs/specification/serialization/.

The latter source states the RFC6570 template for style=label, explode=false as {.id} for a parameter named id, which is consistent with using commas as separators after the leading dot.

Fixes #3139

Thanks to @pk-work for finding this typo.

@darrelmiller
Copy link
Member

@webron Can you merge?

@darrelmiller darrelmiller merged commit 0b1ff16 into OAI:v3.1.1-dev Mar 4, 2023
@ralfhandl ralfhandl deleted the patch-1 branch March 9, 2023 18:02
charjr pushed a commit to charjr/OpenAPI-Specification that referenced this pull request Apr 27, 2023
charjr pushed a commit to charjr/OpenAPI-Specification that referenced this pull request Apr 27, 2023
@karenetheridge
Copy link
Member

Are you sure about this? It's really not dots all the way through?

I just filed swagger-api/swagger.io-docs#342 which makes the reverse change.

@karenetheridge
Copy link
Member

and it looks like this still needs to be added to the v3.2.0-dev branch?

@darrelmiller
Copy link
Member

@karenetheridge Its dots all the way when explode =true but not otherwise https://www.rfc-editor.org/rfc/rfc6570#section-3.2.5

@handrews handrews added this to the v3.1.1 milestone May 17, 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 this pull request may close these issues.

5 participants