Improve x-traitTag support
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Describe the problem to be solved
Currently when using x-traitTag it seems all you can do is provide a textual description.
Within the generated documentation neither the tag, nor the operations seem to indicate which operations are tagged with this trait unless it's hand-written in the description.
Describe the solution you'd like
After the tag description include a simple list of operation names which are tagged with the given tag, hyperlinked to the full description of the operation.
Describe alternatives you've considered
Display trait links as part of the full description of an operation.
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
The issue names no files, tests, or entry points. Start by locating the x-traitTag handling in the generated documentation and compare trait and operation rendering. Done means each trait description includes a linked list of tagged operation names, or the chosen alternative is implemented and covered by the relevant documentation behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100