Merge 0b2f96f into 4453705

sul-dlss · Sep 10, 2019 · d79e6b8 · d79e6b8
2 parents 4453705 + 0b2f96f
commit d79e6b8
Show file tree

Hide file tree

Showing 4 changed files with 849 additions and 2 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,5 @@
+## Why was this change made?
+
+
+
+## Was the API documentation (openapi.json) updated?
diff --git a/README.md b/README.md
@@ -5,8 +5,9 @@
 
 # DOR Services App
 
-This Ruby application provides a REST API for DOR Services. [View the REST API documentation](https://consul.stanford.edu/display/chimera/REST+mappings+for+dor-services+gem).
-
+This Ruby application provides a REST API for DOR Services.
+There is a (OAS 3.0 spec)[http://spec.openapis.org/oas/v3.0.2] that documents the
+API in [openapi.json].  If you clone this repo, you can view this by opening [docs/index.html].
 
 ## Authentication
 

diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>API documentation</title>
+
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+
+    <style>
+      body {
+        margin: 0;
+        padding: 0;
+      }
+    </style>
+  </head>
+  <body>
+    <redoc spec-url='https://raw.githubusercontent.com/sul-dlss/dor-services-app/master/openapi.json'></redoc>
+    <script src="https://cdn.jsdelivr.net/npm/redoc@2.0.0-alpha.17/bundles/redoc.standalone.js"> </script>
+  </body>
+</html>