Generate OpenAPI v3 definitions for the http API
Open
Nobody has claimed this yet.
enhancement
good first issue
- Dominant language
- Go
- Stars
- 27
- Forks
- 24
- Avg merge
- 12d 6h
- Merged PRs (30d)
- 1
Description
There are some tools like https://www.thunderclient.com/ that don't work with our current swagger definitions.
A new section can be added to this script to convert this openapiv2 file to openapiv3 and place it in /docs/openapiv3/apidocs.swagger.json
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 by reading scripts/update_swagger.sh and inspecting docs/openapiv2/apidocs.swagger.json to understand how the existing definitions are generated. Add the requested conversion step and verify that docs/openapiv3/apidocs.swagger.json is produced as a valid OpenAPI v3 definition.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, shell
- Domain
- api
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100