Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Rename swagger.yaml to lms-openapi.yaml

Browse Source 
* 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.
This commit is contained in:
Feanil Patel
2023-06-29 15:30:40 -04:00
parent 26262131ae
commit 8c43868b52
3 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@@ -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

2
docs/guides/lms_apis.rst
View File

@@ -4,4 +4,4 @@ LMS APIs
The LMS currently has the following API Endpoints.
.. openapi:: ../swagger.yaml
.. openapi:: ../lms-openapi.yaml

0
docs/swagger.yaml → docs/lms-openapi.yaml
View File