Updated Swagger's API Documentation

rubyforgood · Feb 8, 2025 · fb6dc3d · fb6dc3d
1 parent 0c9e62d
commit fb6dc3d
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 10 deletions.
diff --git a/spec/swagger_helper.rb b/spec/swagger_helper.rb
@@ -26,10 +26,15 @@
           login_success: {
             type: :object,
             properties: {
-              id: {type: :integer},
-              display_name: {type: :string},
-              email: {type: :string},
-              token: {type: :string}
+              api_token: {type: :string},
+              refresh_token: {type: :string},
+              user: {
+                id: {type: :integer},
+                display_name: {type: :string},
+                email: {type: :string},
+                token_expires_at: {type: :datetime},
+                refresh_token_expires_at: {type: :datetime}
+              }
             }
           },
           login_failure: {

diff --git a/swagger/v1/swagger.yaml b/swagger/v1/swagger.yaml
@@ -8,14 +8,21 @@ components:
     login_success:
       type: object
       properties:
-        id:
-          type: integer
-        display_name:
+        api_token:
           type: string
-        email:
-          type: string
-        token:
+        refresh_token:
           type: string
+        user:
+          id:
+            type: integer
+          display_name:
+            type: string
+          email:
+            type: string
+          api_token_expires_at:
+            type: datetime
+          refresh_token_expires_at:
+            type: datetime
     login_failure:
       type: object
       properties: