mirror of
https://github.com/openfaas/faas.git
synced 2025-06-10 09:16:48 +00:00
452fde08ad
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>
12 lines
417 B
Markdown
12 lines
417 B
Markdown
## 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](http://editor.swagger.io/)
|
|
|
|
* 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.
|