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] API documentation for deployed functions #1337

Open
alexellis opened this issue Oct 5, 2019 · 1 comment
Open

[Feature] API documentation for deployed functions #1337

alexellis opened this issue Oct 5, 2019 · 1 comment

Comments

@alexellis
Copy link
Member

Feature: API documentation for deployed functions

Several users have asked for the ability to document how to interact with functions which have been deployed on OpenFaaS. This issue is also tracked on the Trello roadmap, see #contributors on Slack.

Expected Behaviour

As a user of functions deployed to OpenFaaS, I want to know how to interact with them, programatically. This should cover input/output format, schema and content-type (mime).

Current Behaviour

BT and other users have implemented custom /docs endpoints within their functions.
@alexellis alexellis mentioned this issue Oct 5, 2019
Closed
@itsmurugappan
Copy link

itsmurugappan commented Dec 8, 2019 •
edited
Loading

@alexellis This is a utility I developed to document the deployed functions in open api spec 3.0 and visualize it in a swagger ui.
https://github.com/Optum/faas-swagger
Please let me know your thoughts.

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
2 participants
@alexellis @itsmurugappan