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

OpenAPI Generated Docs #15

Open
cipherboy opened this issue Dec 9, 2023 · 1 comment
Open

OpenAPI Generated Docs #15

cipherboy opened this issue Dec 9, 2023 · 1 comment
Labels
docs Improvements or additions to documentation feature New feature or request

Comments

@cipherboy
Copy link
Member

Currently API docs are hand-maintained: https://github.com/openbao/openbao/tree/development/website/content/api-docs

This has lead to a divergence between them and the in-code docs at various points of time; while OpenBao uses a custom framework, it has the ability to generate an OpenAPI schema and thus should have the ability to generate OpenAPI docs, which would decrease the burden of accepting changes and increase maintainability of our documentation.

This needs to be done carefully as the hand-written docs and the OpenAPI docs will likely differ, so we'll likely want to go plugin-by-plugin and manually review and merge back any useful changes.

@Scorpil Scorpil added docs Improvements or additions to documentation enhancement labels Dec 15, 2023
@JanMa
Copy link
Member

JanMa commented Jan 14, 2024

I took a closer look into this, and as far as I can see a lot of the prerequisites are already in place. Using the gen_openapi.sh script and openapi generator we can already produce some pretty solid API docs.

What's still left to do is to adjust the default template of the document generator we choose to use with the openapi generator so it fits into the upcoming openbao website

cipherboy pushed a commit to cipherboy/openbao that referenced this issue Jan 21, 2024
Co-authored-by: hashicorp-copywrite[bot] <110428419+hashicorp-copywrite[bot]@users.noreply.github.com>
@cipherboy cipherboy added feature New feature or request and removed enhancement labels Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation feature New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants