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

Update the Swagger API Documentation #694

Closed
Templum opened this issue May 22, 2018 · 7 comments
Closed

Update the Swagger API Documentation #694

Templum opened this issue May 22, 2018 · 7 comments
Labels

Comments

@Templum
Copy link
Contributor

Templum commented May 22, 2018

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 the CreateFunctionRequest could show func_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.

@ivanayov
Copy link
Contributor

Derek add label: proposal

@derek derek bot added the proposal label May 22, 2018
@alexellis
Copy link
Member

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.

@Templum
Copy link
Contributor Author

Templum commented May 29, 2018

I updated the documentation in #706. Have a look.

@Templum
Copy link
Contributor Author

Templum commented Jun 1, 2018

Based on feedback in #693 it seems that the return types are different based if the provider is K8S or Swarm.

@alexellis
Copy link
Member

Is this complete now?

@ivanayov
Copy link
Contributor

ivanayov commented Oct 3, 2018

This looks completed.
Waiting for @Templum to confirm before closing.

@Templum
Copy link
Contributor Author

Templum commented Oct 3, 2018

Sorry for the delay, it is fixed. Going to close the issue now

@Templum Templum closed this as completed Oct 3, 2018
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

3 participants