faas-rs/faas
1
0
Fork 0
mirror of https://github.com/openfaas/faas.git synced 2025-06-09 08:46:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
faas/api-docs
History
Lucas Roesler 35f0e9e657 Clean up docs and refactor createhandler 
**What**
- Add a description for the secret key to the api swagger spec.
- Remove optional examples from the secret management guide.
- Update the ApiKeyProtected README to point at the new guide.
- Refactor the `makeSpec` function to accept the already assembled secrets
array because this should be easier to unit test.

Signed-off-by: Lucas Roesler <lucas.roesler@gmail.com>
2017-12-16 16:08:52 +00:00
..
README.md
Migrate from alexellis org to openfaas
2017-10-04 09:18:06 +01:00
swagger.yml
Clean up docs and refactor createhandler
2017-12-16 16:08:52 +00:00

README.md

Exploring or editing the Swagger API documentation

The swagger.yml file can be viewed and edited in the Swagger UI.

  • Head over to the Swagger editor

  • Now click File -> Import URL

  • Type in https://raw.githubusercontent.com/openfaas/faas/master/api-docs/swagger.yml and click OK

You can now view and edit the Swagger, copy back to your fork before pushing changes.