swagger-api / swagger-api/swagger.io-docs
You need to document TAG usage in both 2.0 and 3.0 specs
Nobody has claimed this yet.
- Dominant language
- Astro
- Stars
- 1.6k
- Forks
- 407
- Avg merge
- 2m
- Merged PRs (30d)
- 2
Description
TAG is a really useful directive to organize specifications into different orders depending on precedence, importance, or whatever. The problem is that many of our engineers expect it to mean something else and misuse it, leaving it for the spec editors to clean up. It's a very simple directive to explain and useful to add to a spec. Please add it to your Swagger 2.0/OpenAPI 3.0 spec tutorials. Thx.
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
Locate the Swagger 2.0 and OpenAPI 3.0 specification tutorials in the documentation. Read how existing directives are explained, then document TAG usage and its intended purpose in both tutorials. Done means both tutorials clearly explain the directive so engineers are less likely to misuse it.
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
- Mostly clear
- Newbie friendliness
- 45/100