-
-
Notifications
You must be signed in to change notification settings - Fork 1.9k
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
Update the Swagger API Documentation #694
Comments
Derek add label: proposal |
Hi Simon, thank you for raising this. I'd support you working on this and I think it will help the community going forward too. |
I updated the documentation in #706. Have a look. |
Based on feedback in #693 it seems that the return types are different based if the provider is K8S or Swarm. |
Is this complete now? |
This looks completed. |
Sorry for the delay, it is fixed. Going to close the issue now |
Currently, there is an swagger documentation available here, hower it is not update and also not complete.
For example both create and update return an 400 - Bad Request in case the provided information where not in the correct format. Which is not displayed.
Definition are only partially available and also lack the marking of required fields.
There is also som improvements options for example the field
network
of theCreateFunctionRequest
could showfunc_functions
as defaults, as this field is even only required in an docker envrioment.Note
I would be willing to work on that issue and update the documentation accordingly.
The text was updated successfully, but these errors were encountered: