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.
eduNEXT · Jun 29, 2023 · 8c43868 · 8c43868
1 parent 2626213
commit 8c43868
Show file tree

Hide file tree

Showing 3 changed files with 2 additions and 2 deletions.
diff --git 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
@@ -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 → docs/lms-openapi.yaml b/docs/swagger.yaml → docs/lms-openapi.yaml