Finishing touches

.eslintignore

@@ -1,2 +1,3 @@
 build/
-node_modules/
+node_modules/
+src/types/generated/

README.md

@@ -6,19 +6,21 @@ The OpenAPI schema defines all the endpoints of the server.
 
 Redocly bundles all the OpenAPI files in the `config` folder into a single spec.
 
-[openapi-typescript](https://www.npmjs.com/package/openapi-typescript) generates type definitions, of all models in the endpoints, from the bundled OpenAPI spec.
+[openapi-typescript](https://www.npmjs.com/package/openapi-typescript) generates type definitions, of all models in the
+endpoints, from the bundled OpenAPI spec.
 
-[fastify-openapi-glue](https://www.npmjs.com/package/fastify-openapi-glue) plugs in the endpoints and models to fastify and handles all the routing and authentication.
+[fastify-openapi-glue](https://www.npmjs.com/package/fastify-openapi-glue) plugs in the endpoints and models to fastify
+and handles all the routing and authentication.
 
-## Prerequistes
+## Prerequisites
 
 - node 18
 - pnpm
 
 ## Commands
 
 | Command      | Purpose                                                                          |
-| ------------ | -------------------------------------------------------------------------------- |
+|--------------|----------------------------------------------------------------------------------|
 | dev          | Run the server locally                                                           |
 | openapi      | Bundle the OpenAPI internal and public schemas, and generate type defitions      |
 | verify       | Generates the OpenAPI schemas, type definitions and builds and lints the project |
@@ -30,7 +32,7 @@ Note: after making a change to `openapi.yml`, run `pnpm openapi` to update all t
 ## Structure
 
 | Folder | Usage                                                                            |
-| ------ | -------------------------------------------------------------------------------- |
+|--------|----------------------------------------------------------------------------------|
 | config | Used to store the OpenAPI schema, separated into folders for each component type |
 | module | Database repository, service and controller code for each module in the service  |
 | server | Functions used to start and run the server                                       |
@@ -39,5 +41,6 @@ Note: after making a change to `openapi.yml`, run `pnpm openapi` to update all t
 
 ## Notes
 
-- Some dependancies are using older versions to use CommonJS. The same principles will work in ESM.
-- The API key authentication is not secure or well crafted, it has been included to show the usage of hooking in the security methods of `fastify-openapi-glue`.
+- Some dependencies are using older versions to use CommonJS. The same principles will work in ESM.
+- The API key authentication is not secure or well crafted, it has been included to show the usage of hooking in the
+  security methods of `fastify-openapi-glue`.

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "openapi-test",
+  "name": "openapi-demo",
   "version": "0.1.0",
   "description": "OpenAPI Demo",
   "author": "Alexander Broadbent",
@@ -12,13 +12,13 @@
     "build": "tsc",
     "dev": "NODE_ENV=local nodemon -r dotenv-flow/config --watch src --files src/index.ts",
     "test": "jest",
-    "verify": "pnpm openapi && pnpm lint && pnpm build && pnpm openapi:validate",
-    "openapi": "pnpm openapi:generate-internal && pnpm openapi:generate-api && pnpm openapi:generate-types",
-    "openapi:generate-api": "redocly bundle api -o ./src/config/openapi.bundle.json",
-    "openapi:generate-internal": "redocly bundle internal -o ./src/config/openapi-internal.bundle.json",
-    "openapi:generate-types": "openapi-typescript ./src/config/openapi-internal.bundle.json --output ./src/types/generated/openapi-schema.ts",
-    "openapi:validate": "redocly lint --lint-config error",
-    "docs:preview": "concurrently \"http-server docs/public\" \"open http://127.0.0.1:8080\""
+    "docs:preview": "concurrently \"http-server docs/public\" \"open http://127.0.0.1:8080\"",
+    "verify": "pnpm openapi:validate && pnpm openapi && pnpm lint && pnpm build",
+    "openapi": "pnpm bundle:internal && pnpm bundle:api && pnpm generate:types",
+    "openapi:validate": "redocly lint internal --lint-config error",
+    "bundle:api": "redocly bundle api -o ./src/config/openapi.bundle.json",
+    "bundle:internal": "redocly bundle internal -o ./src/config/openapi-internal.bundle.json",
+    "generate:types": "openapi-typescript ./src/config/openapi-internal.bundle.json --output ./src/types/generated/openapi-schema.ts"
   },
   "repository": {
     "type": "git",