diff --git a/api-docs/README.md b/api-docs/README.md new file mode 100644 index 00000000..7d299543 --- /dev/null +++ b/api-docs/README.md @@ -0,0 +1,11 @@ +## 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/alexellis/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.