Merge pull request #11 from rikoe/app-directory-api

Add and link static OpenAPI web page generated with redoc

.travis.yml

@@ -11,4 +11,4 @@ script:
   - git config --global user.name "${GH_NAME}"
   - git config --global user.email "${GH_EMAIL}"
   - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc
-  - cd website && yarn install && GIT_USER="${GH_NAME}" yarn run publish-gh-pages
+  - cd website && yarn install && yarn run redoc-appd && GIT_USER="${GH_NAME}" yarn run publish-gh-pages

docs/appd-spec.md

@@ -1,8 +1,16 @@
 ---
 id: appd-spec
 sidebar_label: App Directory Specification
-title: App Directory Specification
-hide_title: true
+title: App Directory Specification (Draft)
 ---
+## API
 
-# App Directory Specification (Draft)
+View the [full specification](/FDC3/appd-spec) in [OpenAPI v3.0](https://www.openapis.org/) format (generated with [ReDoc](https://rebilly.github.io/ReDoc/)).
+
+## Endpoints
+
+ Endpoint           | Method | Description
+ ------------------ | ------ | -----------
+ `/v1/apps`         | POST   | Create a new application definition
+ `/v1/apps/{appId}` | GET    | Retrieve an application defintion        
+ `/v1/apps/search`  | GET    | Retrieve a list of applications   

website/.npmrc

@@ -0,0 +1 @@
+save-exact=true

website/package.json

@@ -6,9 +6,11 @@
     "publish-gh-pages": "docusaurus-publish",
     "write-translations": "docusaurus-write-translations",
     "version": "docusaurus-version",
-    "rename-version": "docusaurus-rename-version"
+    "rename-version": "docusaurus-rename-version",
+    "redoc-appd": "redoc-cli bundle --output pages/en/appd-spec.html ../src/app-directory/specification/appd.yaml"
   },
   "devDependencies": {
-    "docusaurus": "1.6.2"
+    "docusaurus": "1.6.2",
+    "redoc-cli": "0.7.0"
   }
 }

website/siteConfig.js

@@ -34,7 +34,7 @@ const siteConfig = {
     {doc: 'use-cases/use-cases-intro', label: 'Use Cases'},
     {page: 'help', label: 'Community'},
     {page: 'help', label: 'About'},
-    {blog: true, label: 'News'},
+    {blog: true, label: 'News'}
   ],
 
   // If you have users set above, you add it here:
@@ -81,6 +81,8 @@ const siteConfig = {
   // No .html extensions for paths.
   cleanUrl: true,
 
+  wrapPagesHTML: true,
+
   // Open Graph and Twitter card images.
   ogImage: 'img/docusaurus.png',
   twitterImage: 'img/docusaurus.png',