New: Move route definitions to routes.json (fixes #37)

lib/UsersModule.js

@@ -7,27 +7,8 @@ import AbstractApiModule from 'adapt-authoring-api'
 class UsersModule extends AbstractApiModule {
   /** @override */
   async setValues () {
-    /** @ignore */ this.root = 'users'
     /** @ignore */ this.schemaName = 'user'
     /** @ignore */ this.collectionName = 'users'
-
-    this.useDefaultRouteConfig()
-    // remove POST / route
-    delete this.routes.find(r => r.route === '/').handlers.post
-
-    const desc = method => `This endpoint is shorthand for \`${method}\` \`/api/${this.root}/:_id\`, see the documentation for that endpoint for more details`
-
-    this.routes = [{
-      route: '/me',
-      modifiers: ['put', 'patch'],
-      handlers: { get: this.requestHandler(), put: this.requestHandler(), patch: this.requestHandler() },
-      permissions: { get: ['read:me'], put: ['write:me'], patch: ['write:me'] },
-      meta: {
-        get: { summary: 'Retrieve your own user data', description: desc('GET') },
-        put: { summary: 'Replace your own user data', description: desc('PUT') },
-        patch: { summary: 'Update your own user data', description: desc('PATCH') }
-      }
-    }, ...this.routes]
   }
 
   /**

routes.json

@@ -0,0 +1,33 @@
+{
+  "root": "users",
+  "useDefaultRoutes": false,
+  "routes": [
+    {
+      "route": "/me",
+      "handlers": { "get": "default", "put": "default", "patch": "default" },
+      "permissions": { "get": ["read:me"], "put": ["write:me"], "patch": ["write:me"] }
+    },
+    {
+      "route": "/",
+      "handlers": { "get": "default" },
+      "permissions": { "get": ["read:${scope}"] }
+    },
+    {
+      "route": "/schema",
+      "handlers": { "get": "serveSchema" },
+      "permissions": { "get": ["read:schema"] }
+    },
+    {
+      "route": "/:_id",
+      "handlers": { "put": "default", "get": "default", "patch": "default", "delete": "default" },
+      "permissions": { "put": ["write:${scope}"], "get": ["read:${scope}"], "patch": ["write:${scope}"], "delete": ["write:${scope}"] }
+    },
+    {
+      "route": "/query",
+      "validate": false,
+      "modifying": false,
+      "handlers": { "post": "query" },
+      "permissions": { "post": ["read:${scope}"] }
+    }
+  ]
+}