Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add openapi spec for existing api #736

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

w3irdrobot
Copy link

@w3irdrobot w3irdrobot commented Feb 24, 2025

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant