From 8c43868b52054065b45a0eca022536a2d1e9922d Mon Sep 17 00:00:00 2001 From: Feanil Patel Date: Thu, 29 Jun 2023 15:30:40 -0400 Subject: [PATCH] docs: Rename swagger.yaml to lms-openapi.yaml * Swagger was renamed to OpenAPI at some point so use the new name for clarity. * Prefix with `lms` to make it clear that these are the APIs from the LMS and may not all be available in the CMS. --- Makefile | 2 +- docs/guides/lms_apis.rst | 2 +- docs/{swagger.yaml => lms-openapi.yaml} | 0 3 files changed, 2 insertions(+), 2 deletions(-) rename docs/{swagger.yaml => lms-openapi.yaml} (100%) diff --git a/Makefile b/Makefile index cfbdb65fbb..e075f092f1 100644 --- a/Makefile +++ b/Makefile @@ -23,7 +23,7 @@ clean: ## archive and delete most git-ignored files tar xf $(PRIVATE_FILES) rm $(PRIVATE_FILES) -SWAGGER = docs/swagger.yaml +SWAGGER = docs/lms-openapi.yaml docs: guides technical-docs ## build all the developer documentation for this repository diff --git a/docs/guides/lms_apis.rst b/docs/guides/lms_apis.rst index 86684ec025..7c77b47e50 100644 --- a/docs/guides/lms_apis.rst +++ b/docs/guides/lms_apis.rst @@ -4,4 +4,4 @@ LMS APIs The LMS currently has the following API Endpoints. -.. openapi:: ../swagger.yaml +.. openapi:: ../lms-openapi.yaml diff --git a/docs/swagger.yaml b/docs/lms-openapi.yaml similarity index 100% rename from docs/swagger.yaml rename to docs/lms-openapi.yaml