matrix-org · afranke · Sep 27, 2021 · Sep 24, 2021 · Sep 27, 2021 · Sep 27, 2021
diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +0,0 @@
-[submodule "swagger-ui"]
-	path = swagger-ui
-	url = https://github.com/matrix-org/swagger-ui.git

diff --git a/content/swagger.css b/content/swagger.css
diff --git a/rapidoc/index.html b/rapidoc/index.html
@@ -0,0 +1,30 @@
+<!doctype html> <!-- Important: must specify -->
+<html>
+  <head>
+    <meta charset="utf-8"> <!-- Important: rapi-doc uses utf8 charecters -->
+    <script type="module" src="./rapidoc-9.1.1.min.js"></script>
+  </head>
+  <body>
+    <rapi-doc
+      spec-url = "json/api-docs.json"
+      show-header="false"
+      render-style="focused" 
+
+      theme="light"
+      nav-bg-color="#f4f4f4"
+      nav-accent-color="#0098d4"
+      nav-text-color="#000000"
+      nav-hover-text-color="#ffffff"
+      nav-hover-bg-color="#000000"
+      nav-active-text-color="#0098d4"
+      nav-active-bg-color="#000000"
+      primary-color="#000000"
+    >
+    <div slot="nav-logo" style="display: flex; align-items: center; justify-content: center;">
+      <a href="/docs/develop">
+        <img src="/images/matrix-logo.svg">
+      </a>
+    </div>
+    </rapi-doc>
+  </body>
+</html>
diff --git a/rapidoc/rapidoc-9.1.1.min.js b/rapidoc/rapidoc-9.1.1.min.js
diff --git a/scripts/swagger-ui.patch b/scripts/swagger-ui.patch
diff --git a/scripts/update_docs.sh b/scripts/update_docs.sh
@@ -4,8 +4,8 @@
 # At present this includes:
 #   * the spec intro and appendices
 #   * the guides and howtos
-#   * the swagger UI for the API
 #   * 'Unstable' versions of the spec docs
+#   * the RapiDoc UI for the API
 #
 # Note that the historical versions of the CS spec and swagger, and the spec
 # index, are generated manually within matrix-doc and then *committed to git*.
@@ -30,11 +30,10 @@ fi
 # otherwise, assume the latest build was fetched by Github Actions.
 tar -xzf assets.tar.gz
 
-# copy the swagger UI into place
+# Set up foundations for RapiDoc API playground
 rm -fr unstyled_docs/api/client-server
 mkdir -p unstyled_docs/api/client-server/json
-cp -r swagger-ui/dist/* unstyled_docs/api/client-server/
-(cd unstyled_docs && patch -p0) <scripts/swagger-ui.patch
+ln -s ../../../spec/client_server/latest.json unstyled_docs/api/client-server/json/api-docs.json
 
 # and the unstable spec docs, but not:
 # * the spec index (because we want to keep the git version, which points to a specific c-s version), or
@@ -44,12 +43,11 @@ rm -f assets/spec/index.html
 rm -f assets/spec/appendices.html
 cp -ar assets/spec unstyled_docs
 
-# add a link to the stable swagger doc
-ln -s ../../../spec/client_server/latest.json unstyled_docs/api/client-server/json/api-docs.json
-
 # copy the unstyled docs and add the jekyll styling
 rm -rf content/docs
 cp -r unstyled_docs content/docs
 find "content/docs" -name '*.html' -type f |
     xargs "./scripts/add-matrix-org-stylings.pl" "./jekyll/_includes"
 
+# Set up RapiDoc itself at the end so it doesn’t get styled
+cp -r rapidoc/* content/docs/api/client-server/
diff --git a/swagger-ui b/swagger-ui
diff --git a/unstyled_docs/spec/index.html b/unstyled_docs/spec/index.html
@@ -1108,7 +1108,7 @@ <h1><a class="toc-backref" href="#id6">1&nbsp;&nbsp;&nbsp;Matrix APIs</a></h1>
 and <a class="reference external" href="#architecture">overall architecture</a>.</p>
 <p>The <a class="reference external" href="appendices.html">Appendices</a> contain supplemental information not specific to
 one of the above APIs.</p>
-<p>The <a class="reference external" href="https://matrix.org/docs/api/client-server/">Matrix Client-Server API Swagger Viewer</a>
+<p>The <a class="reference external" href="https://matrix.org/docs/api/client-server/">Matrix Client-Server OpenAPI Viewer</a>
 is useful for browsing the Client-Server API.</p>
 <p><a class="anchor" id="matrix-versions"></a></p>
 <div class="section" id="matrix-versions">