swagger-api / swagger-api/swagger.io-docs
error in "Parameter Serialization" page for spaceDelimited, pipeDelimited styles
Nobody has claimed this yet.
- Dominant language
- Astro
- Stars
- 1.6k
- Forks
- 407
- Avg merge
- 2m
- Merged PRs (30d)
- 2
Description
I believe there is an error in https://swagger.io/docs/specification/serialization/#query, when describing the spaceDelimited and pipeDelimited styles:
in the explode=true case, it gives a serialized string /users?id=3&id=4&id=5, but actually should say n/a, as explode=true cannot be used with these styles.
canonical reference: https://spec.openapis.org/oas/v3.0.3#style-examples
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Parameter Serialization page at swagger.io/docs/specification/serialization/#query and compare the spaceDelimited and pipeDelimited examples with the OpenAPI v3.0.3 style examples. Update the explode=true entries to show the documented result, then verify the rendered page matches the canonical reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100