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 Docs #139

Open
5 tasks
u8sand opened this issue Nov 20, 2023 · 0 comments
Open
5 tasks

Add OpenAPI Docs #139

u8sand opened this issue Nov 20, 2023 · 0 comments
Labels

Comments

@u8sand
Copy link
Collaborator

u8sand commented Nov 20, 2023

Using the Playbook REST API

  • Probably needs a standardized API documentation of inputs/outputs - sherry xie

  • Could add more textual explanations - sherry xie

  • How workflow arguments are constructed more generally for each type of node - sherry xie

  • Document all possible node constructions somewhere (maybe overkill) → otherwise users kind of have to search through code to find the node names - sherry xie

  • Could clarify that the returned IDs can be used to view both the UI and in JSON format - sherry xie

If possible, a swagger page would be very useful for users to know what is possible and how to format calls. If not, more extensive documentation would be great. - Sean Kim

@u8sand u8sand added enhancement New feature or request use-a-thon-feedback labels Nov 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant