feat: Add example values to DTOs for improved API documentation

This commit is contained in:
2025-03-12 06:29:10 +00:00
parent c3162756ad
commit 016078c1c3
11 changed files with 668 additions and 341 deletions
+214 -107
View File
@@ -4112,10 +4112,12 @@ const docTemplate = `{
"type": "object",
"properties": {
"billingRate": {
"type": "number"
"type": "number",
"example": 100
},
"name": {
"type": "string"
"type": "string",
"example": "Development"
}
}
},
@@ -4123,22 +4125,28 @@ const docTemplate = `{
"type": "object",
"properties": {
"billingRate": {
"type": "number"
"type": "number",
"example": 100
},
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"id": {
"type": "string"
"type": "string",
"example": "a1b2c3d4e5f6"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "u1v2w3x4y5z6"
},
"name": {
"type": "string"
"type": "string",
"example": "Development"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4146,22 +4154,28 @@ const docTemplate = `{
"type": "object",
"properties": {
"billingRate": {
"type": "number"
"type": "number",
"example": 100
},
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"id": {
"type": "string"
"type": "string",
"example": "a1b2c3d4e5f6"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "u1v2w3x4y5z6"
},
"name": {
"type": "string"
"type": "string",
"example": "Development"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4169,7 +4183,8 @@ const docTemplate = `{
"type": "object",
"properties": {
"name": {
"type": "string"
"type": "string",
"example": "Acme Corp"
}
}
},
@@ -4177,19 +4192,24 @@ const docTemplate = `{
"type": "object",
"properties": {
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"name": {
"type": "string"
"type": "string",
"example": "Acme Corp"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4197,19 +4217,24 @@ const docTemplate = `{
"type": "object",
"properties": {
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"name": {
"type": "string"
"type": "string",
"example": "Acme Corp"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4217,10 +4242,12 @@ const docTemplate = `{
"type": "object",
"properties": {
"companyId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"name": {
"type": "string"
"type": "string",
"example": "John Doe"
}
}
},
@@ -4228,22 +4255,28 @@ const docTemplate = `{
"type": "object",
"properties": {
"companyId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"name": {
"type": "string"
"type": "string",
"example": "John Doe"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4251,22 +4284,28 @@ const docTemplate = `{
"type": "object",
"properties": {
"companyId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"name": {
"type": "string"
"type": "string",
"example": "John Doe"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4274,10 +4313,12 @@ const docTemplate = `{
"type": "object",
"properties": {
"email": {
"type": "string"
"type": "string",
"example": "admin@example.com"
},
"password": {
"type": "string"
"type": "string",
"example": "Admin@123456"
}
}
},
@@ -4285,10 +4326,12 @@ const docTemplate = `{
"type": "object",
"properties": {
"customerId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"name": {
"type": "string"
"type": "string",
"example": "Time Tracking App"
}
}
},
@@ -4296,22 +4339,28 @@ const docTemplate = `{
"type": "object",
"properties": {
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"customerId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"name": {
"type": "string"
"type": "string",
"example": "Time Tracking App"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4319,22 +4368,28 @@ const docTemplate = `{
"type": "object",
"properties": {
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"customerId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"name": {
"type": "string"
"type": "string",
"example": "Time Tracking App"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4342,26 +4397,33 @@ const docTemplate = `{
"type": "object",
"properties": {
"activityId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"billable": {
"description": "Percentage (0-100)",
"type": "integer"
"type": "integer",
"example": 100
},
"description": {
"type": "string"
"type": "string",
"example": "Working on the Time Tracking App"
},
"end": {
"type": "string"
"type": "string",
"example": "2024-01-01T17:00:00Z"
},
"projectId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"start": {
"type": "string"
"type": "string",
"example": "2024-01-01T08:00:00Z"
},
"userId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
}
}
},
@@ -4369,38 +4431,49 @@ const docTemplate = `{
"type": "object",
"properties": {
"activityId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"billable": {
"description": "Percentage (0-100)",
"type": "integer"
"type": "integer",
"example": 100
},
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"description": {
"type": "string"
"type": "string",
"example": "Working on the Time Tracking App"
},
"end": {
"type": "string"
"type": "string",
"example": "2024-01-01T17:00:00Z"
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"projectId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"start": {
"type": "string"
"type": "string",
"example": "2024-01-01T08:00:00Z"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"userId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
}
}
},
@@ -4408,38 +4481,49 @@ const docTemplate = `{
"type": "object",
"properties": {
"activityId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"billable": {
"description": "Percentage (0-100)",
"type": "integer"
"type": "integer",
"example": 100
},
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"description": {
"type": "string"
"type": "string",
"example": "Working on the Time Tracking App"
},
"end": {
"type": "string"
"type": "string",
"example": "2024-01-01T17:00:00Z"
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"projectId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"start": {
"type": "string"
"type": "string",
"example": "2024-01-01T08:00:00Z"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"userId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
}
}
},
@@ -4447,7 +4531,8 @@ const docTemplate = `{
"type": "object",
"properties": {
"token": {
"type": "string"
"type": "string",
"example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
},
"user": {
"$ref": "#/definitions/dto.UserDto"
@@ -4458,19 +4543,24 @@ const docTemplate = `{
"type": "object",
"properties": {
"companyId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"email": {
"type": "string"
"type": "string",
"example": "test@example.com"
},
"hourlyRate": {
"type": "number"
"type": "number",
"example": 50
},
"password": {
"type": "string"
"type": "string",
"example": "password123"
},
"role": {
"type": "string"
"type": "string",
"example": "admin"
}
}
},
@@ -4478,28 +4568,36 @@ const docTemplate = `{
"type": "object",
"properties": {
"companyId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"email": {
"type": "string"
"type": "string",
"example": "test@example.com"
},
"hourlyRate": {
"type": "number"
"type": "number",
"example": 50
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"role": {
"type": "string"
"type": "string",
"example": "admin"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4507,31 +4605,40 @@ const docTemplate = `{
"type": "object",
"properties": {
"companyId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"email": {
"type": "string"
"type": "string",
"example": "test@example.com"
},
"hourlyRate": {
"type": "number"
"type": "number",
"example": 50
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"password": {
"type": "string"
"type": "string",
"example": "password123"
},
"role": {
"type": "string"
"type": "string",
"example": "admin"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
+214 -107
View File
@@ -4106,10 +4106,12 @@
"type": "object",
"properties": {
"billingRate": {
"type": "number"
"type": "number",
"example": 100
},
"name": {
"type": "string"
"type": "string",
"example": "Development"
}
}
},
@@ -4117,22 +4119,28 @@
"type": "object",
"properties": {
"billingRate": {
"type": "number"
"type": "number",
"example": 100
},
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"id": {
"type": "string"
"type": "string",
"example": "a1b2c3d4e5f6"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "u1v2w3x4y5z6"
},
"name": {
"type": "string"
"type": "string",
"example": "Development"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4140,22 +4148,28 @@
"type": "object",
"properties": {
"billingRate": {
"type": "number"
"type": "number",
"example": 100
},
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"id": {
"type": "string"
"type": "string",
"example": "a1b2c3d4e5f6"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "u1v2w3x4y5z6"
},
"name": {
"type": "string"
"type": "string",
"example": "Development"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4163,7 +4177,8 @@
"type": "object",
"properties": {
"name": {
"type": "string"
"type": "string",
"example": "Acme Corp"
}
}
},
@@ -4171,19 +4186,24 @@
"type": "object",
"properties": {
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"name": {
"type": "string"
"type": "string",
"example": "Acme Corp"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4191,19 +4211,24 @@
"type": "object",
"properties": {
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"name": {
"type": "string"
"type": "string",
"example": "Acme Corp"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4211,10 +4236,12 @@
"type": "object",
"properties": {
"companyId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"name": {
"type": "string"
"type": "string",
"example": "John Doe"
}
}
},
@@ -4222,22 +4249,28 @@
"type": "object",
"properties": {
"companyId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"name": {
"type": "string"
"type": "string",
"example": "John Doe"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4245,22 +4278,28 @@
"type": "object",
"properties": {
"companyId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"name": {
"type": "string"
"type": "string",
"example": "John Doe"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4268,10 +4307,12 @@
"type": "object",
"properties": {
"email": {
"type": "string"
"type": "string",
"example": "admin@example.com"
},
"password": {
"type": "string"
"type": "string",
"example": "Admin@123456"
}
}
},
@@ -4279,10 +4320,12 @@
"type": "object",
"properties": {
"customerId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"name": {
"type": "string"
"type": "string",
"example": "Time Tracking App"
}
}
},
@@ -4290,22 +4333,28 @@
"type": "object",
"properties": {
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"customerId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"name": {
"type": "string"
"type": "string",
"example": "Time Tracking App"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4313,22 +4362,28 @@
"type": "object",
"properties": {
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"customerId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"name": {
"type": "string"
"type": "string",
"example": "Time Tracking App"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4336,26 +4391,33 @@
"type": "object",
"properties": {
"activityId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"billable": {
"description": "Percentage (0-100)",
"type": "integer"
"type": "integer",
"example": 100
},
"description": {
"type": "string"
"type": "string",
"example": "Working on the Time Tracking App"
},
"end": {
"type": "string"
"type": "string",
"example": "2024-01-01T17:00:00Z"
},
"projectId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"start": {
"type": "string"
"type": "string",
"example": "2024-01-01T08:00:00Z"
},
"userId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
}
}
},
@@ -4363,38 +4425,49 @@
"type": "object",
"properties": {
"activityId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"billable": {
"description": "Percentage (0-100)",
"type": "integer"
"type": "integer",
"example": 100
},
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"description": {
"type": "string"
"type": "string",
"example": "Working on the Time Tracking App"
},
"end": {
"type": "string"
"type": "string",
"example": "2024-01-01T17:00:00Z"
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"projectId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"start": {
"type": "string"
"type": "string",
"example": "2024-01-01T08:00:00Z"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"userId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
}
}
},
@@ -4402,38 +4475,49 @@
"type": "object",
"properties": {
"activityId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"billable": {
"description": "Percentage (0-100)",
"type": "integer"
"type": "integer",
"example": 100
},
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"description": {
"type": "string"
"type": "string",
"example": "Working on the Time Tracking App"
},
"end": {
"type": "string"
"type": "string",
"example": "2024-01-01T17:00:00Z"
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"projectId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"start": {
"type": "string"
"type": "string",
"example": "2024-01-01T08:00:00Z"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"userId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
}
}
},
@@ -4441,7 +4525,8 @@
"type": "object",
"properties": {
"token": {
"type": "string"
"type": "string",
"example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
},
"user": {
"$ref": "#/definitions/dto.UserDto"
@@ -4452,19 +4537,24 @@
"type": "object",
"properties": {
"companyId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"email": {
"type": "string"
"type": "string",
"example": "test@example.com"
},
"hourlyRate": {
"type": "number"
"type": "number",
"example": 50
},
"password": {
"type": "string"
"type": "string",
"example": "password123"
},
"role": {
"type": "string"
"type": "string",
"example": "admin"
}
}
},
@@ -4472,28 +4562,36 @@
"type": "object",
"properties": {
"companyId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"email": {
"type": "string"
"type": "string",
"example": "test@example.com"
},
"hourlyRate": {
"type": "number"
"type": "number",
"example": 50
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"role": {
"type": "string"
"type": "string",
"example": "admin"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
@@ -4501,31 +4599,40 @@
"type": "object",
"properties": {
"companyId": {
"type": "integer"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"createdAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
},
"email": {
"type": "string"
"type": "string",
"example": "test@example.com"
},
"hourlyRate": {
"type": "number"
"type": "number",
"example": 50
},
"id": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"lastEditorID": {
"type": "string"
"type": "string",
"example": "01HGW2BBG0000000000000000"
},
"password": {
"type": "string"
"type": "string",
"example": "password123"
},
"role": {
"type": "string"
"type": "string",
"example": "admin"
},
"updatedAt": {
"type": "string"
"type": "string",
"example": "2024-01-01T00:00:00Z"
}
}
},
+125 -18
View File
@@ -3,225 +3,310 @@ definitions:
dto.ActivityCreateDto:
properties:
billingRate:
example: 100
type: number
name:
example: Development
type: string
type: object
dto.ActivityDto:
properties:
billingRate:
example: 100
type: number
createdAt:
example: "2024-01-01T00:00:00Z"
type: string
id:
example: a1b2c3d4e5f6
type: string
lastEditorID:
example: u1v2w3x4y5z6
type: string
name:
example: Development
type: string
updatedAt:
example: "2024-01-01T00:00:00Z"
type: string
type: object
dto.ActivityUpdateDto:
properties:
billingRate:
example: 100
type: number
createdAt:
example: "2024-01-01T00:00:00Z"
type: string
id:
example: a1b2c3d4e5f6
type: string
lastEditorID:
example: u1v2w3x4y5z6
type: string
name:
example: Development
type: string
updatedAt:
example: "2024-01-01T00:00:00Z"
type: string
type: object
dto.CompanyCreateDto:
properties:
name:
example: Acme Corp
type: string
type: object
dto.CompanyDto:
properties:
createdAt:
example: "2024-01-01T00:00:00Z"
type: string
id:
example: 01HGW2BBG0000000000000000
type: string
lastEditorID:
example: 01HGW2BBG0000000000000000
type: string
name:
example: Acme Corp
type: string
updatedAt:
example: "2024-01-01T00:00:00Z"
type: string
type: object
dto.CompanyUpdateDto:
properties:
createdAt:
example: "2024-01-01T00:00:00Z"
type: string
id:
example: 01HGW2BBG0000000000000000
type: string
lastEditorID:
example: 01HGW2BBG0000000000000000
type: string
name:
example: Acme Corp
type: string
updatedAt:
example: "2024-01-01T00:00:00Z"
type: string
type: object
dto.CustomerCreateDto:
properties:
companyId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
name:
example: John Doe
type: string
type: object
dto.CustomerDto:
properties:
companyId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
createdAt:
example: "2024-01-01T00:00:00Z"
type: string
id:
example: 01HGW2BBG0000000000000000
type: string
lastEditorID:
example: 01HGW2BBG0000000000000000
type: string
name:
example: John Doe
type: string
updatedAt:
example: "2024-01-01T00:00:00Z"
type: string
type: object
dto.CustomerUpdateDto:
properties:
companyId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
createdAt:
example: "2024-01-01T00:00:00Z"
type: string
id:
example: 01HGW2BBG0000000000000000
type: string
lastEditorID:
example: 01HGW2BBG0000000000000000
type: string
name:
example: John Doe
type: string
updatedAt:
example: "2024-01-01T00:00:00Z"
type: string
type: object
dto.LoginDto:
properties:
email:
example: admin@example.com
type: string
password:
example: Admin@123456
type: string
type: object
dto.ProjectCreateDto:
properties:
customerId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
name:
example: Time Tracking App
type: string
type: object
dto.ProjectDto:
properties:
createdAt:
example: "2024-01-01T00:00:00Z"
type: string
customerId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
id:
example: 01HGW2BBG0000000000000000
type: string
lastEditorID:
example: 01HGW2BBG0000000000000000
type: string
name:
example: Time Tracking App
type: string
updatedAt:
example: "2024-01-01T00:00:00Z"
type: string
type: object
dto.ProjectUpdateDto:
properties:
createdAt:
example: "2024-01-01T00:00:00Z"
type: string
customerId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
id:
example: 01HGW2BBG0000000000000000
type: string
lastEditorID:
example: 01HGW2BBG0000000000000000
type: string
name:
example: Time Tracking App
type: string
updatedAt:
example: "2024-01-01T00:00:00Z"
type: string
type: object
dto.TimeEntryCreateDto:
properties:
activityId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
billable:
description: Percentage (0-100)
example: 100
type: integer
description:
example: Working on the Time Tracking App
type: string
end:
example: "2024-01-01T17:00:00Z"
type: string
projectId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
start:
example: "2024-01-01T08:00:00Z"
type: string
userId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
type: object
dto.TimeEntryDto:
properties:
activityId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
billable:
description: Percentage (0-100)
example: 100
type: integer
createdAt:
example: "2024-01-01T00:00:00Z"
type: string
description:
example: Working on the Time Tracking App
type: string
end:
example: "2024-01-01T17:00:00Z"
type: string
id:
example: 01HGW2BBG0000000000000000
type: string
lastEditorID:
example: 01HGW2BBG0000000000000000
type: string
projectId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
start:
example: "2024-01-01T08:00:00Z"
type: string
updatedAt:
example: "2024-01-01T00:00:00Z"
type: string
userId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
type: object
dto.TimeEntryUpdateDto:
properties:
activityId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
billable:
description: Percentage (0-100)
example: 100
type: integer
createdAt:
example: "2024-01-01T00:00:00Z"
type: string
description:
example: Working on the Time Tracking App
type: string
end:
example: "2024-01-01T17:00:00Z"
type: string
id:
example: 01HGW2BBG0000000000000000
type: string
lastEditorID:
example: 01HGW2BBG0000000000000000
type: string
projectId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
start:
example: "2024-01-01T08:00:00Z"
type: string
updatedAt:
example: "2024-01-01T00:00:00Z"
type: string
userId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
type: object
dto.TokenDto:
properties:
token:
example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
type: string
user:
$ref: '#/definitions/dto.UserDto'
@@ -229,54 +314,76 @@ definitions:
dto.UserCreateDto:
properties:
companyId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
email:
example: test@example.com
type: string
hourlyRate:
example: 50
type: number
password:
example: password123
type: string
role:
example: admin
type: string
type: object
dto.UserDto:
properties:
companyId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
createdAt:
example: "2024-01-01T00:00:00Z"
type: string
email:
example: test@example.com
type: string
hourlyRate:
example: 50
type: number
id:
example: 01HGW2BBG0000000000000000
type: string
lastEditorID:
example: 01HGW2BBG0000000000000000
type: string
role:
example: admin
type: string
updatedAt:
example: "2024-01-01T00:00:00Z"
type: string
type: object
dto.UserUpdateDto:
properties:
companyId:
type: integer
example: 01HGW2BBG0000000000000000
type: string
createdAt:
example: "2024-01-01T00:00:00Z"
type: string
email:
example: test@example.com
type: string
hourlyRate:
example: 50
type: number
id:
example: 01HGW2BBG0000000000000000
type: string
lastEditorID:
example: 01HGW2BBG0000000000000000
type: string
password:
example: password123
type: string
role:
example: admin
type: string
updatedAt:
example: "2024-01-01T00:00:00Z"
type: string
type: object
utils.ErrorInfo: