Adding some examples to the OpenAPI spec

Arquisoft · Mar 17, 2024 · 78aecff · 78aecff
1 parent 6e9d94e
commit 78aecff
Showing 1 changed file with 35 additions and 1 deletion.
diff --git a/gatewayservice/openapi.yaml b/gatewayservice/openapi.yaml
@@ -23,12 +23,37 @@ paths:
                 username:
                   type: string
                   description: User ID.
+                  example: student
                 password:
                   type: string
                   description: User password.
+                  example: pass
       responses:
         '200':
           description: User added successfully.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  username:
+                    type: string
+                    description: User ID
+                  password:
+                    type: string
+                    description: Hashed password
+                    example: $2b$10$ZKdNYLWFQxzt5Rei/YTc/OsZNi12YiWz30JeUFHNdAt7MyfmkTuvC
+                  _id:
+                    type: string
+                    description: Identification
+                    example: 65f756db3fa22d227a4b7c7d
+                  createdAt:
+                    type: string
+                    description: Creation date.
+                    example: '2024-03-17T20:47:23.935Z'
+                  ___v:
+                    type: integer
+                    example: '0'                                        
         '400':
           description: Failed to add user.
           content:
@@ -39,6 +64,7 @@ paths:
                   error:
                     type: string
                     description: Error information.
+                    example: getaddrinfo EAI_AGAIN mongodb
   /health:
     get:
       summary: Check the health status of the service.
@@ -54,6 +80,7 @@ paths:
                   status:
                     type: string
                     description: Health status.
+                    example: OK
   /login:
     post:
       summary: Log in to the system.
@@ -68,9 +95,11 @@ paths:
                 username:
                   type: string
                   description: User ID.
+                  example: student
                 password:
                   type: string
                   description: User password.
+                  example: pass
       responses:
         '200':
           description: Login successful. Returns user token, username, and creation date.
@@ -82,12 +111,15 @@ paths:
                   token:
                     type: string
                     description: User token.
+                    example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI2NWY3NTZkYjNmYTIyZDIyN2E0YjdjN2QiLCJpYXQiOjE3MTA3MDg3NDUsImV4cCI6MTcxMDcxMjM0NX0.VMG_5DOyQ4GYlJQRcu1I6ICG1IGzuo2Xuei093ONHxw
                   username:
                     type: string
                     description: Username.
+                    example: student
                   createdAt:
                     type: string
                     description: Creation date.
+                    example: '2024-03-17T20:47:23.935Z'
         '401':
           description: Invalid credentials.
           content:
@@ -97,7 +129,8 @@ paths:
                 properties:
                   error:
                     type: string
-                    description: Invalid Credentials.
+                    description: Shows the error info..
+                    example: Invalid credentials
         '500':
           description: Internal server error.
           content:
@@ -108,3 +141,4 @@ paths:
                   error:
                     type: string
                     description: Error information.
+                    example: Internal Server Error