Adopt openapi spec for API documentation?
Open
Nobody has claimed this yet.
wontfix
- Dominant language
- SCSS
- Stars
- 554
- Forks
- 140
- Avg merge
- 2h 30m
- Merged PRs (30d)
- 3
Description
I was trying to follow along your documentation on contributing, and was surprised when I got to the instructions about submitting an API template. With the widespread adoption of the openapis.org spec I'd recommend using that format for the required submission.
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 with the contributing documentation and the linked API template to understand the current submission requirements. Compare those requirements with the OpenAPI specification, then determine the scope needed to adopt it. Done means the format decision and any affected submission guidance are clearly documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100