update swagger

Taehoya · Mar 3, 2024 · 6fc2df3 · 6fc2df3
1 parent f6d998c
commit 6fc2df3
Show file tree

Hide file tree

Showing 3 changed files with 311 additions and 17 deletions.
diff --git a/server/docs/docs.go b/server/docs/docs.go
diff --git a/server/docs/swagger.json b/server/docs/swagger.json
@@ -408,6 +408,66 @@
             }
         },
         "/v1/trips/{id}": {
+            "get": {
+                "security": [
+                    {
+                        "bearer": []
+                    }
+                ],
+                "description": "get trip by id",
+                "consumes": [
+                    "application/json"
+                ],
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "trip"
+                ],
+                "summary": "get trip by id",
+                "parameters": [
+                    {
+                        "type": "string",
+                        "description": "Authorization",
+                        "name": "Authorization",
+                        "in": "header",
+                        "required": true
+                    },
+                    {
+                        "type": "integer",
+                        "description": "id",
+                        "name": "id",
+                        "in": "path",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/dto.DetailedTripResponseDTO"
+                        }
+                    },
+                    "400": {
+                        "description": "Bad Request",
+                        "schema": {
+                            "$ref": "#/definitions/dto.ErrorResponseDTO"
+                        }
+                    },
+                    "401": {
+                        "description": "Unauthorized",
+                        "schema": {
+                            "$ref": "#/definitions/dto.ErrorResponseDTO"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/dto.ErrorResponseDTO"
+                        }
+                    }
+                }
+            },
             "put": {
                 "security": [
                     {
@@ -661,6 +721,60 @@
                 }
             }
         },
+        "dto.DetailedTripResponseDTO": {
+            "type": "object",
+            "required": [
+                "countryProperty"
+            ],
+            "properties": {
+                "budget": {
+                    "type": "number",
+                    "example": 12345.12
+                },
+                "countryProperty": {
+                    "$ref": "#/definitions/dto.CountryResponseDTO"
+                },
+                "description": {
+                    "type": "string",
+                    "example": "sample-description"
+                },
+                "endDateTime": {
+                    "type": "string",
+                    "example": "2024-01-02T15:04:05Z"
+                },
+                "id": {
+                    "type": "integer",
+                    "example": 1
+                },
+                "name": {
+                    "type": "string",
+                    "example": "sample-name"
+                },
+                "noteProperty": {
+                    "$ref": "#/definitions/dto.TripNoteProperty"
+                },
+                "startDateTime": {
+                    "type": "string",
+                    "example": "2024-01-02T15:04:05Z"
+                },
+                "top5Transactions": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/dto.TransactionResponseDTO"
+                    }
+                },
+                "totalExpense": {
+                    "type": "number",
+                    "example": 100.12
+                },
+                "transactions": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/dto.TransactionResponseDTO"
+                    }
+                }
+            }
+        },
         "dto.ErrorResponseDTO": {
             "type": "object",
             "properties": {
@@ -785,7 +899,7 @@
             "properties": {
                 "budget": {
                     "type": "number",
-                    "example": 2000.12
+                    "example": 2000.02
                 },
                 "countryId": {
                     "type": "integer",
@@ -820,15 +934,11 @@
             "properties": {
                 "budget": {
                     "type": "number",
-                    "example": 100.12
+                    "example": 12345.12
                 },
                 "countryProperty": {
                     "$ref": "#/definitions/dto.CountryResponseDTO"
                 },
-                "description": {
-                    "type": "string",
-                    "example": "sample-description"
-                },
                 "endDateTime": {
                     "type": "string",
                     "example": "2024-01-02T15:04:05Z"