mirror of
https://github.com/openfaas/faas.git
synced 2025-06-15 03:36:47 +00:00
89878f0c8a
Note, not all `alexellis/github` references should be changed, there are a number of repos which are not part of the openfaas org, this commit excludes those. Signed-off-by: John McCabe <john@johnmccabe.net>
12 lines
407 B
Markdown
12 lines
407 B
Markdown
## 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](http://editor.swagger.io/)
|
|
|
|
* 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.
|