chore: add openapi specification for Jikkou API Server

streamthoughts · Nov 15, 2023 · 5ddc9a4 · 5ddc9a4
1 parent 9b1664a
commit 5ddc9a4
Show file tree

Hide file tree

Showing 2 changed files with 599 additions and 0 deletions.
diff --git a/jikkou-rest-api/openapi/README.md b/jikkou-rest-api/openapi/README.md
@@ -0,0 +1,14 @@
+# Jikkou API Server OpenAPI Spec
+
+## Install Redocly
+
+```bash
+npm i -g @redocly/cli@latest
+```
+
+## Preview API documentation
+
+```bash
+redocly preview-docs openapi.yaml
+```
+