Perikk 50 create delete user endpoint

.dockerignore

@@ -2,3 +2,4 @@ Dockerfile
 .dockerignore
 node_modules
 .git
+.env

README.md

@@ -2,36 +2,28 @@
 
 ## Setting up
 
-### Pre-requisite
+1. Clone (**do not fork**) the repository
+2. `npm ci` to install dependencies
+3. Copy `.env.example` to a `.env` file
+4. Update the values inside the `.env` file, using your own database connection details. **Do not put the production database details in here, lest you incur the wrath of the gods.**
+5. `npm run dev` to run the app
+6. Profit
 
-[Follow this guide to create your databases](./DB_SETUP.md)
+## Contributing
 
-Once you have complete the above guide, continue to the steps below.
-
-1. Copy `.env.example` and name it `.env` (NOTE: Make sure to copy the file, don't remove the original)
-2. Copy the URL of your **PRIMARY** database instance (see image below on how to get this) and place it into the `.env` file's `DATABASE_URL` variable, keeping `?schema=prisma` on the end. E.g. `DATABASE_URL="postgres://uy:[email protected]/ufy?schema=prisma"`
-   ![](./assets/db-setup/4.PNG)
-3. Do the same thing for your **SHADOW** database, placing its URL into the `SHADOW_DATABASE_URL` variable, keeping `?schema=shadow` on the end. E.g. `SHADOW_DATABASE_URL="postgres://jk:[email protected]/irk?schema=shadow"`
-4. `npm ci` to install dependencies
-5. `npx prisma migrate reset` to build the database tables and insert some seed data (as defined in [./prisma/seed.js](./prisma/seed.js))
-6. `npm run dev` to run the app
+- Project management board: https://github.com/orgs/boolean-uk/projects/13/views/1
+- Pull requests MUST be made from branches following the naming convention: `<username>-<issue_number>-<feature>`, e.g. `vherus-#1-user_registration`
 
 ## API Spec
 
-[TODO]: <Deploy and update the link below>
-[Deployed API Spec](https://UPDATEME)
+[Deployed API Spec](https://team-dev-backend-api-nameless-cherry-5503.fly.dev/api-docs/)
 
-The API Spec is hosted by the server itself (i.e. this project), and the view/page is generated automatically by the SwaggerUI libraryi.
+The API Spec is hosted by the server itself (i.e. this project), and the view/page is generated automatically by the SwaggerUI library.
 
 To view it locally, you can just go to: [http://localhost:4000/api-docs](http://localhost:4000/api-docs).
 
 Whenever you make any change to the API (e.g. adding a new route, changing the payload for an existing route, adding a new error), you must update the API Spec accordingly. To do this, you just need to update the `openapi.yaml` file -- guidance on the basic structure of the `openapi.yaml` file can be found [here](https://swagger.io/docs/specification/about/).
 
-- **You should always verify these changes locally before committing your work.**
-- If your server is already running when you changed the `openapi.yaml` file, you will need to stop and restart your server.
-- Once verified, stage and commit the changes on the same branch where you changed the behaviour of the API.
-
 ## DATABASE ERD
 
-[TODO]: <Update this with your ERD>
-TODO
+You must create and include an ERD here. This needs to be kept up to date with any and all database schema changes.

docs/openapi.yml

@@ -2,10 +2,10 @@ openapi: 3.0.3
 info:
   title: Team Dev Server API
   description: |-
-  version: 1.0
+  version: '1.0'
 
 servers:
-  - url: http://localhost:4000/
+  - url: https://team-dev-backend-api-nameless-cherry-5503.fly.dev/
 tags:
   - name: user
   - name: post
@@ -32,6 +32,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/CreatedUser'
+        '400':
+          description: Invalid email/password supplied
+          content: 
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'     
     get:
       tags:
         - user
@@ -54,7 +60,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/AllUsers'
         '400':
-          description: fail
+          description: Incomplete Request
           content:
             application/json:
               schema:
@@ -69,7 +75,7 @@ paths:
     post:
       tags:
         - user
-      summary: Localhost Login
+      summary: Login
       description: ''
       operationId: loginUser
       requestBody:
@@ -87,7 +93,11 @@ paths:
                 $ref: '#/components/schemas/loginRes'
 
         '400':
-          description: Invalid username/password supplied
+          description: Incomplete Request
+          content: 
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
 
   /users/{id}:
     get:
@@ -118,14 +128,14 @@ paths:
                   data:
                     $ref: '#/components/schemas/User'
 
-        '400':
-          description: fail
+        '500':
+          description: Unable to get user
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
         '404':
-          description: fail
+          description: User not found by that id
           content:
             application/json:
               schema:
@@ -152,14 +162,26 @@ paths:
             schema:
               $ref: '#/components/schemas/UpdateUser'
       responses:
-        '201':
+        '200':
           description: Successful operation
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/CreatedUser'
-        '401':
-          description: fail
+        '400':
+          description: Incomplete Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '404':
+          description: A user does not exist with that id
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        '403':
+          description: User is unauthorised to make a change
           content:
             application/json:
               schema:
@@ -190,7 +212,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/Post'
         400:
-          description: fail
+          description: Incomplete Request
           content:
             application/json:
               schema:
@@ -216,17 +238,51 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+  /posts/{id}:
+    get:
+      tags:
+        - post
+      summary: Get post by ID
+      description: get post by id
+      operationId: getPost
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: id
+          in: path
+          description: ' '
+          required: true
+          schema:
+            type: int
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: object
+                properties: 
+                  status:
+                    type: string
+                  data:
+                    $ref: '#/components/schemas/Posts'
+        '401':
+          description: Post not found with that id
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
   /logs:
     post:
       tags:
-        - log
+        - logs
       summary: Create delivery log
-      description: This can only be done by an authorised teacher user.
-      operationId: createLog
+      description: This can only be done by an authorised user with role of TEACHER
+      operationId: createDeliveryLog
       security:
         - bearerAuth: []
       requestBody:
-        description: Created log object
+        description: Create log object
         content:
           application/json:
             schema:
@@ -250,12 +306,31 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Log'
-        '401':
+        400:
+          description: Incomplete Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        401:
           description: Unauthorised
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+        404:
+          description: Cohort not found by that id
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+        500:
+          description: An error occured while creating the delivery log
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+
   /cohorts:
     post:
       tags:
@@ -285,6 +360,12 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+        500:
+          description: Unable to create cohort
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
 
 components:
   securitySchemes:
@@ -349,7 +430,11 @@ components:
           type: string
         bio:
           type: string
-        githubUrl:
+        githubUsername:
+          type: string
+        username: 
+          type: string
+        mobile:
           type: string
 
     CreateUser:
@@ -363,10 +448,14 @@ components:
           type: string
         bio:
           type: string
-        githubUrl:
+        githubUsername:
           type: string
         password:
           type: string
+        username: 
+          type: string
+        mobile:
+          type: string
 
     UpdateUser:
       type: object
@@ -385,7 +474,11 @@ components:
           type: string
         bio:
           type: string
-        githubUrl:
+        githubUsername:
+          type: string
+        username: 
+          type: string
+        mobile:
           type: string
 
     Posts:
@@ -426,10 +519,14 @@ components:
                         type: string
                       bio:
                         type: string
-                      githubUrl:
+                      githubUsername:
                         type: string
                       profileImageUrl:
                         type: string
+                      username: 
+                        type: string
+                      mobile:
+                        type: string
 
     CreatedUser:
       type: object
@@ -455,7 +552,11 @@ components:
                   type: string
                 bio:
                   type: string
-                githubUrl:
+                githubUsername:
+                  type: string
+                username: 
+                  type: string
+                mobile:
                   type: string
     login:
       type: object
@@ -490,7 +591,11 @@ components:
                   type: string
                 bio:
                   type: string
-                githubUrl:
+                githubUsername:
+                  type: string
+                username: 
+                  type: string
+                mobile:
                   type: string
     Error:
       type: object