Merge pull request #22 from HotSushi/docsite

Add Specification for Tables and jobs, and a beautiful new UI
linkedin · Feb 24, 2024 · 4f74053 · 4f74053
2 parents 157458d + db5e78b
commit 4f74053
Show file tree

Hide file tree

Showing 10 changed files with 3,730 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -21,4 +21,7 @@ Server should be brought up at http://localhost:3000/
 ### Adding new documentation
 Follow user guide in [docusaurus.io/docs](https://docusaurus.io/docs/category/guides) to add new documentation. Particularly [Pages](https://docusaurus.io/docs/creating-pages), [Docs](https://docusaurus.io/docs/docs-introduction), [Blog](https://docusaurus.io/docs/blog).
 
-A special flavor of markdown [MDX](https://docusaurus.io/docs/markdown-features) is used by default for all md files by Docusaurus. It is more powerful with its javascript integration. 
+A special flavor of markdown [MDX](https://docusaurus.io/docs/markdown-features) is used by default for all md files by Docusaurus. It is more powerful with its javascript integration.
+
+#### Updating OpenAPI Specification
+Instructions to update specification can be found at [/specs](specs/README.md).
diff --git a/docs/User Guide/Catalog/TableSpec.mdx b/docs/User Guide/Catalog/TableSpec.mdx
@@ -0,0 +1,15 @@
+---
+title: Spec
+tags:
+  - Table
+  - Service
+  - API
+  - OpenAPI
+  - Spec
+hide_table_of_contents: true
+---
+# Table Service OpenAPI Spec
+
+import ApiDocMdx from '@theme/ApiDocMdx';
+
+<ApiDocMdx id="tables-openapi-spec-json" />
diff --git a/docs/User Guide/Jobs/JobSpec.mdx b/docs/User Guide/Jobs/JobSpec.mdx
@@ -0,0 +1,15 @@
+---
+title: Spec
+tags:
+  - Jobs
+  - Service
+  - API
+  - OpenAPI
+  - Spec
+hide_table_of_contents: true
+---
+# Jobs Service OpenAPI Spec
+
+import ApiDocMdx from '@theme/ApiDocMdx';
+
+<ApiDocMdx id="jobs-openapi-spec-json" />
diff --git a/docs/User Guide/_category_.json b/docs/User Guide/_category_.json
@@ -5,5 +5,5 @@
       "type": "generated-index",
       "description": "Learn more about the APIs OpenHouse provide"
     }
-  }
+}
 
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -57,7 +57,21 @@ const config = {
           customCss: './src/css/custom.css',
         },
       }),
-    ],
+    ],[
+      'redocusaurus',
+      {
+        specs: [
+          {
+            id: 'tables-openapi-spec-json',
+            spec: 'specs/tables.json'
+          },
+          {
+            id: 'jobs-openapi-spec-json',
+            spec: 'specs/jobs.json'
+          }
+        ],
+      },
+    ]
   ],
 
   themeConfig:
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,5 +5,5 @@ @@
           "type": "generated-index",
           "description": "Learn more about the APIs OpenHouse provide"
         }
-      }
+    }