From c20deaa0912244fa2f9e67f0315e4c47730cbbc6 Mon Sep 17 00:00:00 2001 From: Varun S Lingaraju Date: Sat, 30 Dec 2023 21:57:35 -0800 Subject: [PATCH] Update the link to the api docs 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 --- api-docs/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/api-docs/README.md b/api-docs/README.md index ea0f87c67..af58a27ed 100644 --- a/api-docs/README.md +++ b/api-docs/README.md @@ -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.