feat: add documentation for get user by id endpoint

openapi/features/user/components/find-user-by-id-body.yaml

@@ -0,0 +1,18 @@
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        id:
+          type: string
+          example: '1'
+        name:
+          type: string
+          example: 'John Doe'
+        username:
+          type: string
+          example: 'johndoe123'
+        email:
+          type: string
+          example: 'johndoe@example.com'

openapi/features/user/components/find-user-by-id-parameters.yaml

@@ -0,0 +1,6 @@
+- in: path
+  name: id
+  required: true
+  schema:
+    type: string
+  description: The user ID.s

openapi/features/user/find-user-by-id-path.yaml

@@ -0,0 +1,19 @@
+get:
+  operationId: findUserById
+  summary: Find a user by id
+  description: This endpoint allows you to find a user by id.
+  tags:
+    - user
+
+  parameters:
+    - $ref: './components/find-user-by-id-parameters.yaml'
+
+  responses:
+    '200':
+      $ref: './components/find-user-by-id-body.yaml'
+    '400':
+      $ref: '../../shared/errors/validation-error.yaml'
+    '404':
+      $ref: '../../shared/errors/user-not-found-error.yaml'
+    '500':
+      $ref: '../../shared/errors/server-error.yaml'

openapi/main.yaml

@@ -15,3 +15,5 @@ paths:
     $ref: './features/user/user-create-path.yaml'
   /auth/login:
     $ref: './features/auth/login-path.yaml'
+  /api/users/{id}:
+    $ref: './features/user/find-user-by-id-path.yaml'

openapi/shared/errors/user-not-found-error.yaml

@@ -0,0 +1,22 @@
+description: User not found
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        code:
+          type: number
+          example: 404
+        message:
+          type: string
+          example: User not found
+        details:
+          type: string
+          example: The user with the provided ID does not exist in our records
+        errors:
+          type: array
+          items:
+            type: string
+            example:
+              - 'User ID is invalid'
+              - 'User does not exist'