From 68cc65bfeae6fa67c24e471fff778b4eae42b7ca Mon Sep 17 00:00:00 2001
From: Alexandre Franke <alexandre.franke@matrix.org>
Date: Mon, 31 Jan 2022 09:35:27 +0100
Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Allow=20JSON=20generation=20for=20a?=
 =?UTF-8?q?ll=20API?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Alexandre Franke <alexandre.franke@matrix.org>
---
 .github/workflows/main.yml |  1 +
 scripts/dump-swagger.py    | 30 ++++++++++++++++++++++--------
 2 files changed, 23 insertions(+), 8 deletions(-)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 778d3dbb8..e647c3d1a 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -76,6 +76,7 @@ jobs:
           # The output path matches the final deployment path at spec.matrix.org
           scripts/dump-swagger.py \
             --base-url "https://spec.matrix.org${{ needs.calculate-baseurl.outputs.baseURL }}" \
+            --api client-server \
             -o spec/client-server-api/api.json
           tar -czf openapi.tar.gz spec
       - name: "📤 Artifact upload"
diff --git a/scripts/dump-swagger.py b/scripts/dump-swagger.py
index bbd4035e5..d2b9b5af8 100755
--- a/scripts/dump-swagger.py
+++ b/scripts/dump-swagger.py
@@ -87,11 +87,24 @@ parser.add_argument(
     %(default)s""",
 )
 parser.add_argument(
-    "--client_release", "-c", metavar="LABEL",
+    "--spec-release", "-r", metavar="LABEL",
     default="unstable",
-    help="""The client-server release version to generate for. Default:
+    help="""The spec release version to generate for. Default:
     %(default)s""",
 )
+available_apis = {
+        "client-server": "Matrix Client-Server API",
+        "server-server": "Matrix Server-Server API",
+        "application-service": "Matrix Application Service API",
+        "identity": "Matrix Identity Service API",
+        "push-gateway": "Matrix Push Gateway API",
+        }
+parser.add_argument(
+    "--api",
+    default="client-server",
+    choices=available_apis,
+    help="""The API to generate for. Default: %(default)s""",
+)
 parser.add_argument(
     "-o", "--output",
     default=os.path.join(scripts_dir, "swagger", "api-docs.json"),
@@ -100,7 +113,8 @@ parser.add_argument(
 args = parser.parse_args()
 
 output_file = os.path.abspath(args.output)
-release_label = args.client_release
+release_label = args.spec_release
+selected_api = args.api
 
 major_version = release_label
 match = re.match("^(r\d+)(\.\d+)*$", major_version)
@@ -130,7 +144,7 @@ output = {
     }],
     "schemes": ["https"],
     "info": {
-        "title": "Matrix Client-Server API",
+        "title": available_apis[selected_api],
         "version": release_label,
     },
     "securityDefinitions": {},
@@ -138,15 +152,15 @@ output = {
     "swagger": "2.0",
 }
 
-cs_api_dir = os.path.join(api_dir, 'client-server')
-with open(os.path.join(cs_api_dir, 'definitions',
+selected_api_dir = os.path.join(api_dir, selected_api)
+with open(os.path.join(selected_api_dir, 'definitions',
                        'security.yaml')) as f:
     output['securityDefinitions'] = yaml.safe_load(f)
 
-for filename in os.listdir(cs_api_dir):
+for filename in os.listdir(selected_api_dir):
     if not filename.endswith(".yaml"):
         continue
-    filepath = os.path.join(cs_api_dir, filename)
+    filepath = os.path.join(selected_api_dir, filename)
 
     print("Reading swagger API: %s" % filepath)
     with open(filepath, "r") as f: