:recycle: fixing up some imports | simplifying route example | adding swagger

backend/lib/models/response.js

 const Schwifty = require('@hapipal/schwifty')
 
-const responseSchema = require('../schemas/response')
+const responseSchema = require('../schemas/responses')
 
 module.exports = class Response extends Schwifty.Model {
     static get tableName() {

backend/lib/models/user.js

 const Schwifty = require('@hapipal/schwifty')
 
-const ProfileModel = require('../profiles')
+const ProfileModel = require('./profile')
 const userSchema = require('../schemas/users')
 
 /**

backend/lib/routes/handlers/user.js

+const { makeReturn } = require('./util.js')
+const handlerType = 'user'
+
+module.exports = {
+    get: async (request, h) => {
+        try {
+            const { userService } = request.services()
+            const { user_email } = request.params
+            const user = await userService.findByEmail(user_email)
+
+            if (!user) throw `No user found for ${user_email}`
+
+            return makeReturn(true, { user }, handlerType)
+        } catch (error) {
+            return makeReturn(false, { error }, handlerType)
+        }
+    },
+}

backend/lib/routes/handlers/util.js

+const makeReturn = (ok, data, handler) => ({ ok, handler, data })
+
+module.exports = { makeReturn }

backend/lib/routes/user/get-user.js

-const Joi = require('joi')
+const { responseWrapper } = require('../../schemas/api.js')
+const { validator } = require('../../schemas/users.js')
+const userHandlers = require('../handlers/user')
 
-const pluginConfig = {
-    handlerType: 'user',
-    docs: {
-        get: {
-            description: 'get user',
-            notes: 'Returns a user by the email passed in the path',
-        },
-    },
-}
-
-const validators = {
-    params: Joi.object({ user_email: Joi.string() }),
+const docs = {
+    description: 'get user',
+    notes: 'Returns a user by the email passed in the path',
+    tags: ['api'],
 }
 
 module.exports = {
     method: 'GET',
     path: '/{user_email}',
     options: {
-        ...pluginConfig.docs.get,
-        tags: ['api'],
+        ...docs,
         // auth: 'default_jwt',
         auth: false,
         cors: true,
-        handler: async (request, h) => {
-            try {
-                const { userService } = request.services()
-                const email = request.params.user_email
-                const user = await userService.findByEmail(email)
-                return {
-                    ok: true,
-                    handler: pluginConfig.handlerType,
-                    data: { user },
-                }
-            } catch (err) {
-                return {
-                    ok: false,
-                    handler: pluginConfig.handlerType,
-                    data: { error: err },
-                }
-            }
-        },
+        handler: userHandlers.get,
         validate: {
-            ...validators,
+            params: validator,
             failAction: 'log',
         },
-
         response: {
-            schema: Joi.object({
-                ok: Joi.bool(),
-                handler: Joi.string(),
-                data: Joi.object(),
-            }).label('password_res'),
+            schema: responseWrapper.label('password_res'),
             failAction: 'log',
         },
     },

backend/lib/schemas/api.js

+const Joi = require('joi')
+
+const responseWrapper = Joi.object({
+    ok: Joi.bool(),
+    handler: Joi.string(),
+    data: Joi.object(),
+})
+
+module.exports = {
+    responseWrapper,
+}

backend/lib/schemas/tag-associations.js

     tag_id: Joi.number().required(),
 }).label('association__single_validator')
 
-const list = Joi.array().items(single).label('association__list_validator')
 
 // single is used to define database models
 const single = Joi.object({
     _is_deleted: Joi.boolean().required(),
 }).label('association__single')
 
+const list = Joi.array().items(single).label('association__list_validator')
+
 module.exports = {
     single,
     validator,

backend/package-lock.json

                 "@hapipal/schwifty": "^6.2.0",
                 "dotenv": "^16.4.5",
                 "exiting": "^7.0.0",
+                "hapi-swagger": "^17.2.1",
                 "joi": "^17.13.0",
                 "knex": "^3.1.0",
                 "mysql": "^2.18.1",
                 "objection": "^3.1.4"
             }
         },
+        "node_modules/@apidevtools/json-schema-ref-parser": {
+            "version": "11.6.4",
+            "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-11.6.4.tgz",
+            "integrity": "sha512-9K6xOqeevacvweLGik6LnZCb1fBtCOSIWQs8d096XGeqoLKC33UVMGz9+77Gw44KvbH4pKcQPWo4ZpxkXYj05w==",
+            "dependencies": {
+                "@jsdevtools/ono": "^7.1.3",
+                "@types/json-schema": "^7.0.15",
+                "js-yaml": "^4.1.0"
+            },
+            "engines": {
+                "node": ">= 16"
+            },
+            "funding": {
+                "url": "https://github.com/sponsors/philsturgeon"
+            }
+        },
+        "node_modules/@apidevtools/openapi-schemas": {
+            "version": "2.1.0",
+            "resolved": "https://registry.npmjs.org/@apidevtools/openapi-schemas/-/openapi-schemas-2.1.0.tgz",
+            "integrity": "sha512-Zc1AlqrJlX3SlpupFGpiLi2EbteyP7fXmUOGup6/DnkRgjP9bgMM/ag+n91rsv0U1Gpz0H3VILA/o3bW7Ua6BQ==",
+            "engines": {
+                "node": ">=10"
+            }
+        },
+        "node_modules/@apidevtools/swagger-methods": {
+            "version": "3.0.2",
+            "resolved": "https://registry.npmjs.org/@apidevtools/swagger-methods/-/swagger-methods-3.0.2.tgz",
+            "integrity": "sha512-QAkD5kK2b1WfjDS/UQn/qQkbwF31uqRjPTrsCs5ZG9BQGAkjwvqGFjjPqAuzac/IYzpPtRzjCP1WrTuAIjMrXg=="
+        },
+        "node_modules/@apidevtools/swagger-parser": {
+            "version": "10.0.3",
+            "resolved": "https://registry.npmjs.org/@apidevtools/swagger-parser/-/swagger-parser-10.0.3.tgz",
+            "integrity": "sha512-sNiLY51vZOmSPFZA5TF35KZ2HbgYklQnTSDnkghamzLb3EkNtcQnrBQEj5AOCxHpTtXpqMCRM1CrmV2rG6nw4g==",
+            "dependencies": {
+                "@apidevtools/json-schema-ref-parser": "^9.0.6",
+                "@apidevtools/openapi-schemas": "^2.0.4",
+                "@apidevtools/swagger-methods": "^3.0.2",
+                "@jsdevtools/ono": "^7.1.3",
+                "call-me-maybe": "^1.0.1",
+                "z-schema": "^5.0.1"
+            },
+            "peerDependencies": {
+                "openapi-types": ">=7"
+            }
+        },
+        "node_modules/@apidevtools/swagger-parser/node_modules/@apidevtools/json-schema-ref-parser": {
+            "version": "9.1.2",
+            "resolved": "https://registry.npmjs.org/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-9.1.2.tgz",
+            "integrity": "sha512-r1w81DpR+KyRWd3f+rk6TNqMgedmAxZP5v5KWlXQWlgMUUtyEJch0DKEci1SorPMiSeM8XPl7MZ3miJ60JIpQg==",
+            "dependencies": {
+                "@jsdevtools/ono": "^7.1.3",
+                "@types/json-schema": "^7.0.6",
+                "call-me-maybe": "^1.0.1",
+                "js-yaml": "^4.1.0"
+            }
+        },
         "node_modules/@hapi/accept": {
             "version": "6.0.3",
             "resolved": "https://registry.npmjs.org/@hapi/accept/-/accept-6.0.3.tgz",
             "resolved": "https://registry.npmjs.org/@hapi/hoek/-/hoek-9.3.0.tgz",
             "integrity": "sha512-/c6rf4UJlmHlC9b5BaNvzAcFv7HZ2QHaV0D4/HNlBdvFnvQq8RI4kYdhyPCl7Xj+oWvTWQ8ujhqS53LIgAe6KQ=="
         },
+        "node_modules/@jsdevtools/ono": {
+            "version": "7.1.3",
+            "resolved": "https://registry.npmjs.org/@jsdevtools/ono/-/ono-7.1.3.tgz",
+            "integrity": "sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg=="
+        },
         "node_modules/@sideway/address": {
             "version": "4.1.5",
             "resolved": "https://registry.npmjs.org/@sideway/address/-/address-4.1.5.tgz",
             "resolved": "https://registry.npmjs.org/@sideway/pinpoint/-/pinpoint-2.0.0.tgz",
             "integrity": "sha512-RNiOoTPkptFtSVzQevY/yWtZwf/RxyVnPy/OcA9HBM3MlGDnBEYL5B41H0MTn0Uec8Hi+2qUtTfG2WWZBmMejQ=="
         },
+        "node_modules/@types/json-schema": {
+            "version": "7.0.15",
+            "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz",
+            "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA=="
+        },
         "node_modules/abbrev": {
             "version": "1.1.1",
             "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz",
                 "node": ">= 8"
             }
         },
+        "node_modules/argparse": {
+            "version": "2.0.1",
+            "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
+            "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="
+        },
         "node_modules/balanced-match": {
             "version": "1.0.2",
             "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
                 "node": ">=8"
             }
         },
+        "node_modules/call-me-maybe": {
+            "version": "1.0.2",
+            "resolved": "https://registry.npmjs.org/call-me-maybe/-/call-me-maybe-1.0.2.tgz",
+            "integrity": "sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ=="
+        },
         "node_modules/chokidar": {
             "version": "3.6.0",
             "resolved": "https://registry.npmjs.org/chokidar/-/chokidar-3.6.0.tgz",
                 "node": ">= 6"
             }
         },
+        "node_modules/handlebars": {
+            "version": "4.7.8",
+            "resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.8.tgz",
+            "integrity": "sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==",
+            "dependencies": {
+                "minimist": "^1.2.5",
+                "neo-async": "^2.6.2",
+                "source-map": "^0.6.1",
+                "wordwrap": "^1.0.0"
+            },
+            "bin": {
+                "handlebars": "bin/handlebars"
+            },
+            "engines": {
+                "node": ">=0.4.7"
+            },
+            "optionalDependencies": {
+                "uglify-js": "^3.1.4"
+            }
+        },
+        "node_modules/hapi-swagger": {
+            "version": "17.2.1",
+            "resolved": "https://registry.npmjs.org/hapi-swagger/-/hapi-swagger-17.2.1.tgz",
+            "integrity": "sha512-IaF3OHfYjzDuyi5EQgS0j0xB7sbAAD4DaTwexdhPYqEBI/J7GWMXFbftGObCIOeMVDufjoSBZWeaarEkNn6/ww==",
+            "dependencies": {
+                "@apidevtools/json-schema-ref-parser": "^11.1.0",
+                "@hapi/boom": "^10.0.1",
+                "@hapi/hoek": "^11.0.2",
+                "handlebars": "^4.7.8",
+                "http-status": "^1.7.3",
+                "swagger-parser": "^10.0.3",
+                "swagger-ui-dist": "^5.9.1"
+            },
+            "engines": {
+                "node": ">=16.0.0"
+            },
+            "peerDependencies": {
+                "@hapi/hapi": ">=20.x.x",
+                "joi": "17.x"
+            }
+        },
         "node_modules/has-flag": {
             "version": "3.0.0",
             "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz",
                 "node": ">= 0.4"
             }
         },
+        "node_modules/http-status": {
+            "version": "1.7.4",
+            "resolved": "https://registry.npmjs.org/http-status/-/http-status-1.7.4.tgz",
+            "integrity": "sha512-c2qSwNtTlHVYAhMj9JpGdyo0No/+DiKXCJ9pHtZ2Yf3QmPnBIytKSRT7BuyIiQ7icXLynavGmxUqkOjSrAuMuA==",
+            "engines": {
+                "node": ">= 0.4.0"
+            }
+        },
         "node_modules/ignore-by-default": {
             "version": "1.0.1",
             "resolved": "https://registry.npmjs.org/ignore-by-default/-/ignore-by-default-1.0.1.tgz",
                 "@hapi/hoek": "^9.0.0"
             }
         },
+        "node_modules/js-yaml": {
+            "version": "4.1.0",
+            "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
+            "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
+            "dependencies": {
+                "argparse": "^2.0.1"
+            },
+            "bin": {
+                "js-yaml": "bin/js-yaml.js"
+            }
+        },
         "node_modules/json-schema-traverse": {
             "version": "1.0.0",
             "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz",
             "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz",
             "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg=="
         },
+        "node_modules/lodash.get": {
+            "version": "4.4.2",
+            "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz",
+            "integrity": "sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ=="
+        },
+        "node_modules/lodash.isequal": {
+            "version": "4.5.0",
+            "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz",
+            "integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ=="
+        },
         "node_modules/lru-cache": {
             "version": "7.18.3",
             "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-7.18.3.tgz",
                 "node": "*"
             }
         },
+        "node_modules/minimist": {
+            "version": "1.2.8",
+            "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz",
+            "integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==",
+            "funding": {
+                "url": "https://github.com/sponsors/ljharb"
+            }
+        },
         "node_modules/mo-walk": {
             "version": "1.2.0",
             "resolved": "https://registry.npmjs.org/mo-walk/-/mo-walk-1.2.0.tgz",
                 "node": ">= 0.6"
             }
         },
+        "node_modules/neo-async": {
+            "version": "2.6.2",
+            "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz",
+            "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw=="
+        },
         "node_modules/nodemon": {
             "version": "3.1.0",
             "resolved": "https://registry.npmjs.org/nodemon/-/nodemon-3.1.0.tgz",
                 "knex": ">=1.0.1"
             }
         },
+        "node_modules/openapi-types": {
+            "version": "12.1.3",
+            "resolved": "https://registry.npmjs.org/openapi-types/-/openapi-types-12.1.3.tgz",
+            "integrity": "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw==",
+            "peer": true
+        },
         "node_modules/p-limit": {
             "version": "2.3.0",
             "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.3.0.tgz",
                 "node": ">=10"
             }
         },
+        "node_modules/source-map": {
+            "version": "0.6.1",
+            "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz",
+            "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==",
+            "engines": {
+                "node": ">=0.10.0"
+            }
+        },
         "node_modules/sqlstring": {
             "version": "2.3.1",
             "resolved": "https://registry.npmjs.org/sqlstring/-/sqlstring-2.3.1.tgz",
                 "url": "https://github.com/sponsors/ljharb"
             }
         },
+        "node_modules/swagger-parser": {
+            "version": "10.0.3",
+            "resolved": "https://registry.npmjs.org/swagger-parser/-/swagger-parser-10.0.3.tgz",
+            "integrity": "sha512-nF7oMeL4KypldrQhac8RyHerJeGPD1p2xDh900GPvc+Nk7nWP6jX2FcC7WmkinMoAmoO774+AFXcWsW8gMWEIg==",
+            "dependencies": {
+                "@apidevtools/swagger-parser": "10.0.3"
+            },
+            "engines": {
+                "node": ">=10"
+            }
+        },
+        "node_modules/swagger-ui-dist": {
+            "version": "5.17.14",
+            "resolved": "https://registry.npmjs.org/swagger-ui-dist/-/swagger-ui-dist-5.17.14.tgz",
+            "integrity": "sha512-CVbSfaLpstV65OnSjbXfVd6Sta3q3F7Cj/yYuvHMp1P90LztOLs6PfUnKEVAeiIVQt9u2SaPwv0LiH/OyMjHRw=="
+        },
         "node_modules/tarn": {
             "version": "3.0.2",
             "resolved": "https://registry.npmjs.org/tarn/-/tarn-3.0.2.tgz",
                 "nodetouch": "bin/nodetouch.js"
             }
         },
+        "node_modules/uglify-js": {
+            "version": "3.17.4",
+            "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.17.4.tgz",
+            "integrity": "sha512-T9q82TJI9e/C1TAxYvfb16xO120tMVFZrGA3f9/P4424DNu6ypK103y0GPFVa17yotwSyZW5iYXgjYHkGrJW/g==",
+            "optional": true,
+            "bin": {
+                "uglifyjs": "bin/uglifyjs"
+            },
+            "engines": {
+                "node": ">=0.8.0"
+            }
+        },
         "node_modules/undefsafe": {
             "version": "2.0.5",
             "resolved": "https://registry.npmjs.org/undefsafe/-/undefsafe-2.0.5.tgz",
             "resolved": "https://registry.npmjs.org/util-deprecate/-/util-deprecate-1.0.2.tgz",
             "integrity": "sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw=="
         },
+        "node_modules/validator": {
+            "version": "13.12.0",
+            "resolved": "https://registry.npmjs.org/validator/-/validator-13.12.0.tgz",
+            "integrity": "sha512-c1Q0mCiPlgdTVVVIJIrBuxNicYE+t/7oKeI9MWLj3fh/uq2Pxh/3eeWbVZ4OcGW1TUf53At0njHw5SMdA3tmMg==",
+            "engines": {
+                "node": ">= 0.10"
+            }
+        },
+        "node_modules/wordwrap": {
+            "version": "1.0.0",
+            "resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz",
+            "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q=="
+        },
         "node_modules/yallist": {
             "version": "4.0.0",
             "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz",
             "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A=="
+        },
+        "node_modules/z-schema": {
+            "version": "5.0.5",
+            "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.5.tgz",
+            "integrity": "sha512-D7eujBWkLa3p2sIpJA0d1pr7es+a7m0vFAnZLlCEKq/Ij2k0MLi9Br2UPxoxdYystm5K1yeBGzub0FlYUEWj2Q==",
+            "dependencies": {
+                "lodash.get": "^4.4.2",
+                "lodash.isequal": "^4.5.0",
+                "validator": "^13.7.0"
+            },
+            "bin": {
+                "z-schema": "bin/z-schema"
+            },
+            "engines": {
+                "node": ">=8.0.0"
+            },
+            "optionalDependencies": {
+                "commander": "^9.4.1"
+            }
+        },
+        "node_modules/z-schema/node_modules/commander": {
+            "version": "9.5.0",
+            "resolved": "https://registry.npmjs.org/commander/-/commander-9.5.0.tgz",
+            "integrity": "sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==",
+            "optional": true,
+            "engines": {
+                "node": "^12.20.0 || >=14"
+            }
         }
     }
 }

backend/package.json

         "@hapipal/schwifty": "^6.2.0",
         "dotenv": "^16.4.5",
         "exiting": "^7.0.0",
+        "hapi-swagger": "^17.2.1",
         "joi": "^17.13.0",
         "knex": "^3.1.0",
         "mysql": "^2.18.1",

backend/server/manifest.js

+const Inert = require('@hapi/inert')
+const Vision = require('@hapi/vision')
 const Confidence = require('@hapipal/confidence')
 const Schwifty = require('@hapipal/schwifty')
+const HapiSwagger = require('hapi-swagger')
 
 const confs = {
     local: {
         user: process.env.PSCALE_DB_USER,
         pw: process.env.PSCALE_DB_PASSWORD,
     },
-    dbFlavor: process.env.DB_TYPE
+    dbFlavor: process.env.DB_TYPE,
 }
 
 const isProd = () => (process.env.USE_LOCAL_DB == 'true' ? 'local' : 'prod')
                     },
                 },
             },
+            /** Documentaion plugins */
+            Inert,
+            Vision,
+            {
+                plugin: HapiSwagger,
+                options: {
+                    info: { title: 'Test API Documentation' },
+                },
+            },
             /** Model and knex integration */
             {
                 plugin: Schwifty,