Skip to content

Commit

Permalink
Update the link to the api docs
Browse files Browse the repository at this point in the history
The README.md under fass/api-docs has an incorrect URL to the api spec
file. This change updates it.

Fixes openfaas#1826

Signed-off-by: Varun S Lingaraju <[email protected]>
  • Loading branch information
warunsl committed Dec 31, 2023
1 parent 02205b8 commit c20deaa
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions api-docs/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
## Exploring or editing the Swagger API documentation

The `swagger.yml` file can be viewed and edited in the Swagger UI.
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/swagger.yml` and click OK
* 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.

0 comments on commit c20deaa

Please sign in to comment.