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.

Sign up for GitHub

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

Jump to bottom

Feature Request: Generate OpenAPI spec for the API to help development of clients #1275

Open
zbalkan opened this issue Mar 2, 2023 · 0 comments
Open

Feature Request: Generate OpenAPI spec for the API to help development of clients #1275

zbalkan opened this issue Mar 2, 2023 · 0 comments

Comments

@zbalkan
Copy link

zbalkan commented Mar 2, 2023

The documentation in /doc/api/ are good but not detailed enough. For instance;

  • It is not clear which parameters will be in the path, which ones will be in the queries, or they should be in the JSON data as properties.
  • It is not clear what kind of errors are expected
  • Lacking examples to clarify the success and fail scenarios

It would be great if CFSSL provides an OpenAPI spec file along with it so that it would improve the process of writing clients.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@zbalkan