faas-rs/faas
1
0
Fork 0
mirror of https://github.com/openfaas/faas.git synced 2025-06-08 08:25:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update the link to the api docs

Browse Source 
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>
This commit is contained in:
Varun S Lingaraju 2023-12-30 21:57:35 -08:00 committed by Alex Ellis
parent b2a378fea4
commit 452fde08ad
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
api-docs/README.md
View File

@ -1,11 +1,11 @@
## Exploring or editing the Swagger API documentation ## 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/) * Head over to the [Swagger editor](http://editor.swagger.io/)
* Now click File -> Import URL * 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. You can now view and edit the Swagger, copy back to your fork before pushing changes.