Teamwork / Teamwork/kommentaar
Allow adding `description` to Responses
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 34
- Forks
- 6
- Avg merge
- 14h 5m
- Merged PRs (30d)
- 2
Description
Additional information may be useful (we have some use cases) in the description of the Responses.
I have some preliminary work in a fork on this where I changed the response regex to allow adding a description after the type of the response, i.e.
However, the status and meaning are still replicated, which I'm thinking of taking out and just leaving the description.
Contributor guide
No contributing guide indexed for this repository
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 with the response regex and the existing Response handling described in the issue. Verify how a response description is parsed and represented, then confirm that status and meaning are not duplicated and that the generated API documentation includes the description.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go, openapi
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100