@rivascva/dt-idl 1.1.104 → 1.1.105

package/dist/index.d.ts

@@ -1073,7 +1073,7 @@ interface operations$2 {
  * Do not make direct changes to the file.
  */
 interface paths$1 {
-    "/login": {
+    "/auth/login": {
         parameters: {
             query?: never;
             header?: never;
@@ -1090,7 +1090,7 @@ interface paths$1 {
         patch?: never;
         trace?: never;
     };
-    "/login/by-provider": {
+    "/auth/login/by-provider": {
         parameters: {
             query?: never;
             header?: never;
@@ -1107,7 +1107,7 @@ interface paths$1 {
         patch?: never;
         trace?: never;
     };
-    "/logout": {
+    "/auth/logout": {
         parameters: {
             query?: never;
             header?: never;
@@ -1124,6 +1124,23 @@ interface paths$1 {
         patch?: never;
         trace?: never;
     };
+    "/auth/refresh": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Refreshes a user access token */
+        post: operations$1["refreshAccessToken"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/users": {
         parameters: {
             query?: never;
@@ -1177,6 +1194,16 @@ interface components$1 {
             /** @example 123456 */
             authorizationCode: string;
         };
+        /** @description Payload to log out a user */
+        LogoutPayload: {
+            /** @example ABCD.1234.abcd */
+            refreshToken: string;
+        };
+        /** @description Payload to refresh a user access token */
+        RefreshAccessTokenPayload: {
+            /** @example ABCD.1234.abcd */
+            refreshToken: string;
+        };
         /** @description Payload to add a new user */
         AddUserPayload: {
             /** @example sam.smith@example.com */
@@ -1237,6 +1264,18 @@ interface components$1 {
                 };
             };
         };
+        /** @description Refresh access token success */
+        RefreshAccessTokenSuccess: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": {
+                    /** @example ABCD.1234.abcd */
+                    accessToken: string;
+                };
+            };
+        };
         /** @description No content */
         NoContent: {
             headers: {
@@ -1244,6 +1283,24 @@ interface components$1 {
             };
             content?: never;
         };
+        /** @description The user is not authenticated */
+        Unauthorized: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components$1["schemas"]["Error"];
+            };
+        };
+        /** @description The user is not authorized to perform the action */
+        Forbidden: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components$1["schemas"]["Error"];
+            };
+        };
         /** @description The resource was not found */
         NotFound: {
             headers: {
@@ -1313,7 +1370,6 @@ interface operations$1 {
         responses: {
             200: components$1["responses"]["LoginSuccess"];
             400: components$1["responses"]["BadRequest"];
-            404: components$1["responses"]["NotFound"];
             500: components$1["responses"]["InternalServerError"];
         };
     };
@@ -1324,10 +1380,36 @@ interface operations$1 {
             path?: never;
             cookie?: never;
         };
-        requestBody?: never;
+        /** @description The request body to log out a user */
+        requestBody: {
+            content: {
+                "application/json": components$1["schemas"]["LogoutPayload"];
+            };
+        };
         responses: {
             204: components$1["responses"]["NoContent"];
             400: components$1["responses"]["BadRequest"];
+            401: components$1["responses"]["Unauthorized"];
+            500: components$1["responses"]["InternalServerError"];
+        };
+    };
+    refreshAccessToken: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description The request body to refresh an access token */
+        requestBody: {
+            content: {
+                "application/json": components$1["schemas"]["RefreshAccessTokenPayload"];
+            };
+        };
+        responses: {
+            200: components$1["responses"]["RefreshAccessTokenSuccess"];
+            400: components$1["responses"]["BadRequest"];
+            401: components$1["responses"]["Unauthorized"];
             500: components$1["responses"]["InternalServerError"];
         };
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rivascva/dt-idl",
-  "version": "1.1.104",
+  "version": "1.1.105",
   "description": "Dream Trade - Interface Definition Language",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",

package/services/dt-user-service.yaml

@@ -8,7 +8,7 @@ servers:
   - url: http://localhost:8084/v1
 
 paths:
-  /login:
+  /auth/login:
     post:
       description: Logs in a user
       operationId: login
@@ -29,7 +29,7 @@ paths:
         500:
           $ref: '#/components/responses/InternalServerError'
 
-  /login/by-provider:
+  /auth/login/by-provider:
     post:
       description: Logs in a user by a provider
       operationId: loginByProvider
@@ -47,22 +47,52 @@ paths:
           $ref: '#/components/responses/LoginSuccess'
         400:
           $ref: '#/components/responses/BadRequest'
-        404:
-          $ref: '#/components/responses/NotFound'
         500:
           $ref: '#/components/responses/InternalServerError'
 
-  /logout:
+  /auth/logout:
     post:
       description: Logs out a user
       operationId: logout
       tags:
         - Auth
+      requestBody:
+        description: The request body to log out a user
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/LogoutPayload'
       responses:
         204:
           $ref: '#/components/responses/NoContent'
         400:
           $ref: '#/components/responses/BadRequest'
+        401:
+          $ref: '#/components/responses/Unauthorized'
+        500:
+          $ref: '#/components/responses/InternalServerError'
+
+  /auth/refresh:
+    post:
+      description: Refreshes a user access token
+      operationId: refreshAccessToken
+      tags:
+        - Auth
+      requestBody:
+        description: The request body to refresh an access token
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/RefreshAccessTokenPayload'
+      responses:
+        200:
+          $ref: '#/components/responses/RefreshAccessTokenSuccess'
+        400:
+          $ref: '#/components/responses/BadRequest'
+        401:
+          $ref: '#/components/responses/Unauthorized'
         500:
           $ref: '#/components/responses/InternalServerError'
 
@@ -197,6 +227,24 @@ components:
         - provider
         - authorizationCode
 
+    LogoutPayload:
+      description: Payload to log out a user
+      properties:
+        refreshToken:
+          type: string
+          example: ABCD.1234.abcd
+      required:
+        - refreshToken
+
+    RefreshAccessTokenPayload:
+      description: Payload to refresh a user access token
+      properties:
+        refreshToken:
+          type: string
+          example: ABCD.1234.abcd
+      required:
+        - refreshToken
+
     AddUserPayload:
       description: Payload to add a new user
       properties:
@@ -289,9 +337,35 @@ components:
               - accessToken
               - refreshToken
 
+    RefreshAccessTokenSuccess:
+      description: Refresh access token success
+      content:
+        application/json:
+          schema:
+            properties:
+              accessToken:
+                type: string
+                example: ABCD.1234.abcd
+            required:
+              - accessToken
+
     NoContent:
       description: No content
 
+    Unauthorized:
+      description: The user is not authenticated
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+
+    Forbidden:
+      description: The user is not authorized to perform the action
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+
     NotFound:
       description: The resource was not found
       content:

package/ts/services/dt-user-service.ts

@@ -4,7 +4,7 @@
  */
 
 export interface paths {
-    "/login": {
+    "/auth/login": {
         parameters: {
             query?: never;
             header?: never;
@@ -21,7 +21,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/login/by-provider": {
+    "/auth/login/by-provider": {
         parameters: {
             query?: never;
             header?: never;
@@ -38,7 +38,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/logout": {
+    "/auth/logout": {
         parameters: {
             query?: never;
             header?: never;
@@ -55,6 +55,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/auth/refresh": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** @description Refreshes a user access token */
+        post: operations["refreshAccessToken"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/users": {
         parameters: {
             query?: never;
@@ -109,6 +126,16 @@ export interface components {
             /** @example 123456 */
             authorizationCode: string;
         };
+        /** @description Payload to log out a user */
+        LogoutPayload: {
+            /** @example ABCD.1234.abcd */
+            refreshToken: string;
+        };
+        /** @description Payload to refresh a user access token */
+        RefreshAccessTokenPayload: {
+            /** @example ABCD.1234.abcd */
+            refreshToken: string;
+        };
         /** @description Payload to add a new user */
         AddUserPayload: {
             /** @example sam.smith@example.com */
@@ -169,6 +196,18 @@ export interface components {
                 };
             };
         };
+        /** @description Refresh access token success */
+        RefreshAccessTokenSuccess: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": {
+                    /** @example ABCD.1234.abcd */
+                    accessToken: string;
+                };
+            };
+        };
         /** @description No content */
         NoContent: {
             headers: {
@@ -176,6 +215,24 @@ export interface components {
             };
             content?: never;
         };
+        /** @description The user is not authenticated */
+        Unauthorized: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
+        /** @description The user is not authorized to perform the action */
+        Forbidden: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": components["schemas"]["Error"];
+            };
+        };
         /** @description The resource was not found */
         NotFound: {
             headers: {
@@ -246,7 +303,6 @@ export interface operations {
         responses: {
             200: components["responses"]["LoginSuccess"];
             400: components["responses"]["BadRequest"];
-            404: components["responses"]["NotFound"];
             500: components["responses"]["InternalServerError"];
         };
     };
@@ -257,10 +313,36 @@ export interface operations {
             path?: never;
             cookie?: never;
         };
-        requestBody?: never;
+        /** @description The request body to log out a user */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["LogoutPayload"];
+            };
+        };
         responses: {
             204: components["responses"]["NoContent"];
             400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
+            500: components["responses"]["InternalServerError"];
+        };
+    };
+    refreshAccessToken: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** @description The request body to refresh an access token */
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["RefreshAccessTokenPayload"];
+            };
+        };
+        responses: {
+            200: components["responses"]["RefreshAccessTokenSuccess"];
+            400: components["responses"]["BadRequest"];
+            401: components["responses"]["Unauthorized"];
             500: components["responses"]["InternalServerError"];
         };
     };