faas/api-docs/README.md
Varun S Lingaraju 452fde08ad Update the link to the api docs
The README.md under fass/api-docs has an incorrect URL to the api spec
file. This change updates it.

Fixes #1826

Signed-off-by: Varun S Lingaraju <warunsl@gmail.com>
2025-03-31 21:51:16 +01:00

417 B

Exploring or editing the Swagger API documentation

The spec.openapi.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/spec.openapi.yml and click OK

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