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

Take advantage of readme.com's OpenAPI documentation feature #15

Open
displague opened this issue Nov 22, 2023 · 0 comments
Open

Take advantage of readme.com's OpenAPI documentation feature #15

displague opened this issue Nov 22, 2023 · 0 comments

Comments

@displague
Copy link

displague commented Nov 22, 2023

The API spec is currently documented in https://github.com/turing-machines/help-center/blob/main/Docs/Getting%20started/BMC%20API.md

This is incomplete and in a text format. The OpenAPIv3.1 spec could be used to instead offer this spec in a way that tool and SDK generation would benefit from. The API documentation would also be generated from this specification.

Since readme.com is already in use, their ability to serve OpenAPI documentation behind a nice UI could be taken advantage of.

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

No branches or pull requests

1 participant