swagger-api / swagger-api/swagger.io-docs
error on parameter serialization page
Nobody has claimed this yet.
- Dominant language
- Astro
- Stars
- 1.6k
- Forks
- 407
- Avg merge
- 2m
- Merged PRs (30d)
- 2
Description
at https://swagger.io/docs/specification/v3_0/serialization/, in the "Serialization and RFC 6570" section, the example has a comment "Using the default serialization for query parameters: style=form, explode=false, allowReserved=false", but the actual defaults for query parameters are style=form, explode=true, allowReserved=false.
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 parameter serialization page at swagger.io/docs/specification/v3_0/serialization/ and find the “Serialization and RFC 6570” section. Check the example comment against the OpenAPI defaults, update the documented query-parameter value, and verify the rendered page shows the corrected text.
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
- 55/100