Add OpenAPI link

Signed-off-by: Matteo Joliveau <[email protected]>

Author: Matteo Joliveau

.vuepress/config.js

@@ -7,9 +7,13 @@ module.exports = {
       { text: 'Users Guide', link: '/users/' },
       { text: 'Developers Guide', link: '/developers/' },
       { text: 'Website', link: 'https://enseada.io', target: '_blank' },
-      { text: 'Source code', link: 'https://github.com/enseadaio/enseada', target: '_blank' },
     ],
+    repo: 'enseadaio/enseada',
+    repoLabel: 'Source Code',
+    docsRepo: 'enseadaio/documentation',
+    editLinks: true,
     displayAllHeaders: true,
+    lastUpdated: 'Last Updated',
     sidebar: {
       '/users/': [
         '',
@@ -23,39 +27,16 @@ module.exports = {
         'ui',
       ],
       '/developers/': [
-        'apis',
+        '',
+        {
+          title: 'API Reference',
+          path: 'https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/enseadaio/enseada/develop/docs/openapi.yml',
+        },
       ],
       '/': [
         '',
       ]
     },
-    // sidebar: [
-    //   {
-    //     title: 'Getting Started',
-    //     path: '/getting-started',
-    //   },
-    //   {
-    //     title: 'Install and Update',
-    //     path: '/install'
-    //   },
-    //   {
-    //     title: 'User Guide',
-    //     path: '/users/',
-    //     children: [
-    //       // 'authentication',
-    //       // 'authorization',
-    //       // 'package-registries',
-    //       // 'ui',
-    //     ]
-    //   },
-    //   {
-    //     title: 'Developer Guide',
-    //     path: '/developers/',
-        
-    //     children: [
-    //       'apis',
-    //     ]
-    //   },
-    // ]
-  }
+  },
+  plugins: ['@vuepress/register-components'],
 }

developers/README.md

@@ -1 +1,6 @@
-# Developer Guide
+# Developer Guide
+
+Enseada is designed to be easily integrated into other systems.
+All functionalities are available through a RESTful API protected by OAuth tokens.
+
+The scopes required by each endpoint are defined in the [API Reference documentation](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/enseadaio/enseada/develop/docs/openapi.yml#section/Authentication/oauth). Additional access control is evaluated beside the authorized scopes to ensure that the user is allowed to perform the operation.

developers/apis.md

@@ -15,6 +15,7 @@
     "vuepress": "^1.2.0"
   },
   "devDependencies": {
+    "@vuepress/plugin-register-components": "^1.4.0",
     "rimraf": "^3.0.0"
   }
 }

package.json

@@ -907,6 +907,13 @@
   dependencies:
     "@vuepress/shared-utils" "^1.2.0"
 
+"@vuepress/plugin-register-components@^1.4.0":
+  version "1.4.0"
+  resolved "https://registry.yarnpkg.com/@vuepress/plugin-register-components/-/plugin-register-components-1.4.0.tgz#0dafefd3baed6cc50b53f9826e84b25d83fed763"
+  integrity sha512-HmSzCTPVrlJJ8PSIXAvh4RkPy9bGmdrQuAXAtjiiq5rzBjL3uIg2VwzTrKDqf7FkCKs4lcRAEuNxB70bH6tddA==
+  dependencies:
+    "@vuepress/shared-utils" "^1.4.0"
+
 "@vuepress/plugin-search@^1.2.0":
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/@vuepress/plugin-search/-/plugin-search-1.2.0.tgz#0b27c467b7fd42bd4d9e32de0fe2fb81a24bd311"
@@ -927,6 +934,21 @@
     semver "^6.0.0"
     upath "^1.1.0"
 
+"@vuepress/shared-utils@^1.4.0":
+  version "1.4.0"
+  resolved "https://registry.yarnpkg.com/@vuepress/shared-utils/-/shared-utils-1.4.0.tgz#ab4bfcd5c1e3d0e5e384e0c1d0bb86470430c87e"
+  integrity sha512-6QTv7zMRXAojCuPRIm4aosYfrQO4OREhyxvbFeg/ZMWkVX+xZZQTdE7ZyK/4NAvEgkpjtPTRC1TQYhLJUqC5mQ==
+  dependencies:
+    chalk "^2.3.2"
+    diacritics "^1.3.0"
+    escape-html "^1.0.3"
+    fs-extra "^7.0.1"
+    globby "^9.2.0"
+    gray-matter "^4.0.1"
+    hash-sum "^1.0.2"
+    semver "^6.0.0"
+    upath "^1.1.0"
+
 "@vuepress/theme-default@^1.2.0":
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/@vuepress/theme-default/-/theme-default-1.2.0.tgz#3303af21a00031a3482ed1c494508234f545cbf1"