Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
adds an openapi v3.1 document describing the current api. we can use this document to iterate on what a new version of the api might look like. there's alot of existing tooling that exist for this format that the community can utilize to make working with our apis easier.
the idea for this came from #667 (comment)
to view, docker can be used.
docker run -p 8080:8080 \ -e SWAGGER_JSON=/workspace/swagger.json \ -v $PWD/main/http_server/openapi.yaml:/workspace/swagger.json \ docker.swagger.io/swaggerapi/swagger-ui
open up
localhost:8080
in a browser to view the docs using the swagger ui tool.the contents of the file can also just be copy and pasted into the online editor as well.
in the future, we can consider options around hosting this, maybe making it available on the bitaxe itself?