WIP

bcgov · Aug 29, 2024 · 907f882 · 907f882
1 parent 515ea7f
commit 907f882
Show file tree

Hide file tree

Showing 6 changed files with 2,678 additions and 3 deletions.
diff --git a/app/package-lock.json b/app/package-lock.json
diff --git a/app/package.json b/app/package.json
@@ -57,6 +57,7 @@
     "express-winston": "^4.2.0",
     "helmet": "^7.1.0",
     "joi": "^17.13.3",
+    "js-yaml": "^4.1.0",
     "jsonwebtoken": "^9.0.2",
     "knex": "^3.1.0",
     "pg": "^8.12.0",
@@ -73,6 +74,7 @@
     "@types/express": "^4.17.21",
     "@types/express-serve-static-core": "^4.19.5",
     "@types/jest": "^29.5.12",
+    "@types/js-yaml": "^4.0.9",
     "@types/jsonwebtoken": "^9.0.6",
     "@types/node": "^20.14.11",
     "@types/pg": "^8.11.6",

diff --git a/app/src/docs/docs.ts b/app/src/docs/docs.ts
@@ -0,0 +1,23 @@
+const docs = {
+  getDocHTML: (version: string) => `<!DOCTYPE html>
+  <html>
+    <head>
+      <title>Common Object Management Service API - Documentation ${version}</title>
+      <!-- Needed for adaptive design -->
+      <meta charset="utf-8"/>
+      <meta name="viewport" content="width=device-width, initial-scale=1">
+      <link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
+
+      <!-- ReDoc doesn't change outer page styles -->
+      <style>
+        body { margin: 0; padding: 0; }
+      </style>
+    </head>
+    <body>
+      <redoc spec-url='/api/${version}/docs/api-spec.yaml' />
+      <script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
+    </body>
+  </html>`
+};
+
+export default docs;