feature(profile): view user profile

write using test to view user profile by username
create a route to view profile
create user controller to view

README.md

@@ -4,7 +4,6 @@
 
 # Authors Haven - A Social platform for the creative at heart.
 
-
 # Team Dahlia
 
 ## Vision

docs/swagger.yaml

@@ -23,14 +23,14 @@ tags:
 - name: Users
   description: Operations available for user endpoints
 
-security:
-- ApiKeyAuth: []
 paths:
   /users:
     post:
       tags:
         - Users
-      summary: Creates a new user
+      summary: Creates a new user.
+      security:
+      - ApiKeyAuth: []
       requestBody:
         description: fields containing user data
         content:
@@ -112,7 +112,7 @@ paths:
                   type: string
       responses:
         200:
-          description: succesful request
+          description: successful request
           content:
             application/json:
               schema:
@@ -129,15 +129,47 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/StandardServerResponse'
-
+  '/profiles/{userId}':
+    get:
+      summary: View a user profile.
+      parameters:
+        - name: userId
+          in: path
+          required: true
+          schema:
+            type: integer
+            example: '1'
+      responses:
+        200:
+          description: profile details of user
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/Profile'
+        404:
+          description: user not found
+          content:
+            application/json:
+              schema:
+                type: object
+                properties: 
+                  error:
+                    type: object
+                    properties:
+                      message:
+                          type: string
+                          example: 'user not found'
+
+
 components:
   schemas:
     User:
       required:
       - firstName
       - lastName
       - email
-      - username
       type: object
       properties:
         firstName:
@@ -149,9 +181,9 @@ components:
         email:
           type: string
           example: johndoe@email.com
-        username:
-          type: string
-          example: johnnydoe12
+        id:
+          type: integer
+          example: 1
         bio:
           type: string
           example: I am awesome
@@ -178,9 +210,6 @@ components:
         lastName:
           type: string
           example: doe
-        username:
-          type: string
-          example: johnnydoe12
         email:
           type: string
           example: johndoe@email.com
@@ -199,8 +228,8 @@ components:
       properties:
         token:
           type: string
-        username:
-          type: string
+        id:
+          type: integer
         bio:
           type: string
     ForgotPasswordUser:
@@ -219,7 +248,27 @@ components:
           example: success
         message:
           type: string
-          example: internal server error   
+          example: internal server error 
+    Profile:
+      required:
+      - id
+      - bio
+      - image
+      - following
+      type: object
+      properties:
+        id:
+          type: integer
+          example: 1
+        bio:
+          type: string
+          example: I love novels
+        image:
+          type: string
+          example: ''
+        following:
+          type: boolean
+          example: true
   securitySchemes:
     ApiKeyAuth:
       type: apiKey