faas/api-docs
Lucas Roesler 06ade37420 feat: refactor api spec to use OpenAPI and add missing spec
Convert the existing swagger2.0 file to a moden OpenAPI file.
Add missing endpoitns and model definitions.

Signed-off-by: Lucas Roesler <roesler.lucas@gmail.com>
2023-06-28 08:33:03 +01:00
..

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.