Merge pull request #173 from PortalTechnologiesInc/fix/api-reference-redoc-iframe

denmeh · web-flow · commit 2325e67a8dea · 2026-03-26T00:41:32.000Z
fix(docs): replace inline Redoc script with hosted iframe
diff --git a/docs/sdk/api-reference-rest.md b/docs/sdk/api-reference-rest.md
@@ -1,25 +1,15 @@
 # API Reference (OpenAPI)
 
-Full interactive reference for the Portal REST API, generated from the [openapi.yaml](https://github.com/PortalTechnologiesInc/lib/blob/master/crates/portal-rest/openapi.yaml) spec.
-
-<div id="redoc-container"></div>
-
-<script src="https://cdn.jsdelivr.net/npm/redoc@latest/bundles/redoc.standalone.js"></script>
-<script>
-  Redoc.init(
-    'https://raw.githubusercontent.com/PortalTechnologiesInc/lib/master/crates/portal-rest/openapi.yaml',
-    {
-      scrollYOffset: 50,
-      hideDownloadButton: false,
-      theme: {
-        colors: { primary: { main: '#e8b468' } },
-        typography: { fontSize: '15px', fontFamily: 'inherit' }
-      }
-    },
-    document.getElementById('redoc-container')
-  );
-</script>
-
-> If the interactive viewer doesn't load, open the raw spec directly:
-> [openapi.yaml on GitHub](https://github.com/PortalTechnologiesInc/lib/blob/master/crates/portal-rest/openapi.yaml)
-> or paste the raw URL into [Redocly](https://redocly.github.io/redoc/) / [Swagger Editor](https://editor.swagger.io/).
+Full interactive reference for the Portal REST API, generated from the [`openapi.yaml`](https://github.com/PortalTechnologiesInc/lib/blob/master/crates/portal-rest/openapi.yaml) spec.
+
+<iframe
+  src="https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/PortalTechnologiesInc/lib/master/crates/portal-rest/openapi.yaml&nocors"
+  width="100%"
+  height="900px"
+  style="border: none; border-radius: 6px;"
+  title="Portal REST API Reference">
+</iframe>
+
+> If the viewer above doesn't load, open the spec directly:
+> - [openapi.yaml on GitHub](https://github.com/PortalTechnologiesInc/lib/blob/master/crates/portal-rest/openapi.yaml)
+> - Paste the raw URL into [Redocly](https://redocly.github.io/redoc/) or [Swagger Editor](https://editor.swagger.io/)
