Add descriptions to models, parameters, fields
Open
Nobody has claimed this yet.
enhancement
specification
- Dominant language
- Go
- Stars
- 323
- Forks
- 133
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 2
Description
Adding descriptions to the following would be very useful for developers:
- endpoints (operations):
summary(short description)description(long description)externalDocs(link to online documentation)
- request
parameters - request payloads
- models / schemas
- security schemes
- tags (
descriptionandexternalDocs)
Having only the attribute names is useful but does not provide enough context.
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
No files or tests are named. Start by locating the repository's OpenAPI definitions and compare the operation, parameter, request payload, schema, security scheme, and tag objects with the linked specification sections. Done means each listed object supports the requested descriptive fields and the resulting specification remains valid.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100