Loredana benzar 40 get comments endpoint

.github/workflows/ci.yml

@@ -13,5 +13,5 @@ jobs:
         with:
           node-version: 'lts/*'
       - run: npm ci
-      - run: npx eslint src
-      - run: npx prisma migrate reset --force --skip-seed
+      - run: npm run lint
+      - run: npm run db-reset

Dockerfile

@@ -33,4 +33,6 @@ WORKDIR /app
 ENV NODE_ENV production
 ENV PATH /root/.volta/bin:$PATH
 
+RUN npm run migrate
+
 CMD [ "npm", "run", "start" ]

README.md

@@ -19,7 +19,7 @@ Once you have complete the above guide, continue to the steps below.
 ## API Spec
 
 [TODO]: <Deploy and update the link below>
-[Deployed API Spec](https://UPDATEME)
+[Deployed API Spec](https://boolean-team-dev-server.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.
 

docs/openapi.yml

@@ -2,7 +2,7 @@ openapi: 3.0.3
 info:
   title: Team Dev Server API
   description: |-
-  version: 1.0
+  version: '1.0'
 
 servers:
   - url: http://localhost:4000/
@@ -35,15 +35,15 @@ paths:
     get:
       tags:
         - user
-      summary: Get all users by first name if provided
+      summary: Get all users by name if provided
       description: ''
       operationId: getAllUsers
       security:
         - bearerAuth: []
       parameters:
-        - name: firstName
+        - name: name
           in: query
-          description: Search all users by first name if provided (case-sensitive and exact string matches only)
+          description: Search all users by name if provided. Name is case insensitive and will return matches for both first name and last name.
           schema:
             type: string
       responses:
@@ -88,7 +88,6 @@ paths:
 
         '400':
           description: Invalid username/password supplied
-
   /users/{id}:
     get:
       tags:
@@ -183,18 +182,78 @@ paths:
                 content:
                   type: string
       responses:
-        201:
+        '201':
           description: success
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Post'
-        400:
+        '400':
           description: fail
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
+    put:
+      tags:    
+       - post  
+      summary: Update post
+      description: you can update your own post
+      operationId: editPost
+      security:
+         - bearerAuth: []
+      requestBody: 
+        description: Updated post object
+        content: 
+          application/json: 
+            schema:
+              type: object
+              properties: 
+                content: 
+                  type: string
+      responses:
+        '200':
+          description: success
+          content: 
+            application/json: 
+              schema: 
+                $ref: '#/components/schemas/Post'
+        '400':
+          description: fail
+          content: 
+            application/json:
+              schema: 
+                $ref: '#/components/schemas/Error'
+    delete:
+          tags:    
+           - post  
+          summary: Delete post
+          description: you can delete your own post
+          operationId: deletePost
+          security:
+             - bearerAuth: []
+          requestBody: 
+            description: Updated post object
+            content: 
+              application/json: 
+                schema:   
+                  type: object
+                  properties: 
+                    content: 
+                      type: string
+          responses:            
+            '200':
+              description: success
+              content: 
+                application/json: 
+                  schema:   
+                    $ref: '#/components/schemas/Post'         
+            '500':   
+              description: fail
+              content: 
+                application/json: 
+                  schema:   
+                    $ref: '#/components/schemas/Error'                               
     get:
       tags:
         - post
@@ -204,13 +263,13 @@ paths:
       security:
         - bearerAuth: []
       responses:
-        '200':
+        200:
           description: Successful operation
           content:
             application/json:
               schema:
                 $ref: '#/components/schemas/Posts'
-        '401':
+        401:
           description: fail
           content:
             application/json:
@@ -285,7 +344,22 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Error'
-
+  /comments:
+    get:
+      tags: 
+        - comments
+      summary: Retrieve comments
+      description: only registered users can view these
+      operationId: getComments
+      security:
+        - bearerAuth: []
+      responses:
+        200:
+          description: success
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Comments'
 components:
   securitySchemes:
     bearerAuth:
@@ -405,11 +479,6 @@ components:
                     type: integer
                   content:
                     type: string
-                  createdAt:
-                    type: string
-                    format: string
-                  updatedAt:
-                    type: string
                     format: string
                   author:
                     type: object
@@ -430,7 +499,79 @@ components:
                         type: string
                       profileImageUrl:
                         type: string
-
+                  comments:
+                    type: array
+                    items:
+                        type: object
+                        properties:
+                          id:
+                            type: integer
+                          postId:
+                            type: integer
+                          userId:
+                            type: integer
+                          content: 
+                            type: string
+                            format: string
+                          author:
+                            type: object
+                            properties: 
+                              firstName: 
+                                type: string
+                              lastName:
+                                type: string
+                          createdAt:
+                            type: string
+                            format: string
+                          updatedAt:
+                            type: string
+                            format: string 
+                  likes: 
+                    type: array
+                    items:
+                      type: object
+                      properties: 
+                        id: 
+                          type: integer
+                        userId:
+                          type: integer
+                        postId:
+                          type: integer
+                  createdAt:
+                    type: string
+                    format: string
+                  updatedAt:
+                    type: string
+
+    Comments:
+        type: object
+        properties:
+          status:
+            type: string
+          data: 
+            type: object
+            properties:
+              comments:
+                type: array
+                items:
+                  type: object
+                  properties: 
+                    id:
+                      type: integer
+                    content:
+                      type: string
+                    postId:
+                      type: integer
+                    userId:
+                      type: integer
+                    author:
+                      type: object
+                      properties: 
+                        firstName: 
+                          type: string
+                        lastName:
+                          type: string
+
     CreatedUser:
       type: object
       properties:

fly.toml

@@ -1,9 +1,12 @@
-# fly.toml file generated for team-dev-backend-api on 2022-11-30T11:30:34Z
+# fly.toml app configuration file generated for boolean-team-dev-server on 2024-02-02T17:36:23+01:00
+#
+# See https://fly.io/docs/reference/configuration/ for information about how to use this file.
+#
 
-app = "team-dev-backend-api"
+app = 'boolean-team-dev-server'
 kill_signal = "SIGINT"
 kill_timeout = 5
-processes = []
+primary_region = "lhr"
 
 [env]
   PORT = "8080"
@@ -12,9 +15,6 @@ processes = []
   allowed_public_ports = []
   auto_rollback = true
 
-[deploy]
-  release_command = "npx prisma migrate deploy"
-
 [[services]]
   http_checks = []
   internal_port = 8080