swagger-api / swagger-api/swagger.io-docs
Query Parameter doc is incorrect
Open
Nobody has claimed this yet.
- Dominant language
- Astro
- Stars
- 1.6k
- Forks
- 407
- Avg merge
- 2m
- Merged PRs (30d)
- 2
Description
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.
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
Open the Query Parameters section of the linked swagger.io serialization documentation and compare its table with the OpenAPI 3.0.1 style examples section. Replace the two incorrect object-column entries for pipeDelimited and spaceDelimited with the corresponding examples, then verify both rows match the specification.
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