diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index d836b100..4fc6a960 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -92,17 +92,17 @@ jobs: export RELEASE="unstable" fi # The output path matches the final deployment path at spec.matrix.org - scripts/dump-swagger.py \ + scripts/dump-openapi.py \ --base-url "https://spec.matrix.org${{ needs.calculate-baseurl.outputs.baseURL }}" \ --api application-service \ -r "$RELEASE" \ -o spec/application-service-api/api.json - scripts/dump-swagger.py \ + scripts/dump-openapi.py \ --base-url "https://spec.matrix.org${{ needs.calculate-baseurl.outputs.baseURL }}" \ --api client-server \ -r "$RELEASE" \ -o spec/client-server-api/api.json - scripts/dump-swagger.py \ + scripts/dump-openapi.py \ --base-url "https://spec.matrix.org${{ needs.calculate-baseurl.outputs.baseURL }}" \ --api push-gateway \ -r "$RELEASE" \ diff --git a/.gitignore b/.gitignore index c1a34c50..09afe2d8 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,7 @@ node_modules /data/msc /env* /resources -/scripts/swagger +/scripts/openapi /scripts/tmp /hugo-config.toml /public diff --git a/README.md b/README.md index b78841ef..089bfe17 100644 --- a/README.md +++ b/README.md @@ -88,12 +88,12 @@ spec to `/spec`. If you'd like to serve the spec off a path instead of a domain to the `hugo -d "spec"` command. For building the OpenAPI definitions, create a python3 virtualenv and activate it. Then run `pip install -r ./scripts/requirements.txt` -and finally `python ./scripts/dump-swagger.py` to generate it to `./scripts/swagger/api-docs.json`. To make use of the generated file, +and finally `python ./scripts/dump-openapi.py` to generate it to `./scripts/openapi/api-docs.json`. To make use of the generated file, there are a number of options: -* You can open `./scripts/swagger-preview.html` in your browser, and then open the file by clicking on `Local JSON File`. -* You can run a local HTTP server by running `./scripts/swagger-http-server.py`, and then view the documentation by - opening `./scripts/swagger-preview.html` in your browser. +* You can open `./scripts/openapi-preview.html` in your browser, and then open the file by clicking on `Local JSON File`. +* You can run a local HTTP server by running `./scripts/openapi-http-server.py`, and then view the documentation by + opening `./scripts/openapi-preview.html` in your browser. ## Issue tracking diff --git a/openapi_extensions.md b/openapi_extensions.md index 9e833f18..15b93adc 100644 --- a/openapi_extensions.md +++ b/openapi_extensions.md @@ -12,7 +12,7 @@ To ease API design and management, the API definition is split across several files. Each of these files is self-contained valid OpenAPI. There is no single root file in the source tree as OpenAPI requires; this file -can be generated by `dump-swagger.py`. The script does not convert +can be generated by `dump-openapi.py`. The script does not convert the extensions described further in this document so there can be minor interoperability issues with tooling that expects compliant OpenAPI. diff --git a/scripts/check-swagger-sources.py b/scripts/check-openapi-sources.py similarity index 100% rename from scripts/check-swagger-sources.py rename to scripts/check-openapi-sources.py diff --git a/scripts/dump-swagger.py b/scripts/dump-openapi.py similarity index 100% rename from scripts/dump-swagger.py rename to scripts/dump-openapi.py diff --git a/scripts/swagger-http-server.py b/scripts/openapi-http-server.py similarity index 100% rename from scripts/swagger-http-server.py rename to scripts/openapi-http-server.py diff --git a/scripts/swagger-preview.html b/scripts/openapi-preview.html similarity index 100% rename from scripts/swagger-preview.html rename to scripts/openapi-preview.html