swagger-api / swagger-api/swagger.io-docs
documentation at odds with behavior
Open
Nobody has claimed this yet.
- Dominant language
- Astro
- Stars
- 1.6k
- Forks
- 407
- Avg merge
- 2m
- Merged PRs (30d)
- 2
Description
documentation says "You can assign a list of tags to each API operation"
problem is you cannot - the instant you add a second tag ("list" . .. .) there are errors
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 by locating the swagger.io documentation page containing the statement that each API operation can have a list of tags, then reproduce the error when a second tag is added. Compare the documented behavior with the observed behavior; the issue is done when the documentation accurately reflects the supported behavior and the tag example no longer misleads readers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100