Skip to content

Commit fd2cddd

Browse files
committed
Generate docs
1 parent 28500a9 commit fd2cddd

3 files changed

Lines changed: 150 additions & 79 deletions

File tree

api/docs/docs.go

Lines changed: 56 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2191,17 +2191,14 @@ const docTemplate = `{
21912191
"application/json"
21922192
],
21932193
"tags": [
2194-
"Send Schedules"
2194+
"SendSchedules"
21952195
],
21962196
"summary": "List send schedules",
21972197
"responses": {
21982198
"200": {
21992199
"description": "OK",
22002200
"schema": {
2201-
"type": "array",
2202-
"items": {
2203-
"$ref": "#/definitions/entities.MessageSendSchedule"
2204-
}
2201+
"$ref": "#/definitions/responses.MessageSendSchedulesResponse"
22052202
}
22062203
},
22072204
"401": {
@@ -2232,7 +2229,7 @@ const docTemplate = `{
22322229
"application/json"
22332230
],
22342231
"tags": [
2235-
"Send Schedules"
2232+
"SendSchedules"
22362233
],
22372234
"summary": "Create send schedule",
22382235
"parameters": [
@@ -2268,7 +2265,7 @@ const docTemplate = `{
22682265
"402": {
22692266
"description": "Payment Required",
22702267
"schema": {
2271-
"$ref": "#/definitions/responses.BadRequest"
2268+
"$ref": "#/definitions/responses.PaymentRequired"
22722269
}
22732270
},
22742271
"422": {
@@ -2301,7 +2298,7 @@ const docTemplate = `{
23012298
"application/json"
23022299
],
23032300
"tags": [
2304-
"Send Schedules"
2301+
"SendSchedules"
23052302
],
23062303
"summary": "Update send schedule",
23072304
"parameters": [
@@ -2372,7 +2369,7 @@ const docTemplate = `{
23722369
"application/json"
23732370
],
23742371
"tags": [
2375-
"Send Schedules"
2372+
"SendSchedules"
23762373
],
23772374
"summary": "Delete send schedule",
23782375
"parameters": [
@@ -3529,7 +3526,6 @@ const docTemplate = `{
35293526
"required": [
35303527
"created_at",
35313528
"id",
3532-
"is_active",
35333529
"name",
35343530
"timezone",
35353531
"updated_at",
@@ -3545,10 +3541,6 @@ const docTemplate = `{
35453541
"type": "string",
35463542
"example": "32343a19-da5e-4b1b-a767-3298a73703cb"
35473543
},
3548-
"is_active": {
3549-
"type": "boolean",
3550-
"example": true
3551-
},
35523544
"name": {
35533545
"type": "string",
35543546
"example": "Business Hours"
@@ -3669,9 +3661,9 @@ const docTemplate = `{
36693661
"id",
36703662
"max_send_attempts",
36713663
"message_expiration_seconds",
3664+
"message_send_schedule_id",
36723665
"messages_per_minute",
36733666
"phone_number",
3674-
"schedule_id",
36753667
"sim",
36763668
"updated_at",
36773669
"user_id"
@@ -3698,6 +3690,10 @@ const docTemplate = `{
36983690
"description": "MessageExpirationSeconds is the duration in seconds after sending a message when it is considered to be expired.",
36993691
"type": "integer"
37003692
},
3693+
"message_send_schedule_id": {
3694+
"type": "string",
3695+
"example": "32343a19-da5e-4b1b-a767-3298a73703cb"
3696+
},
37013697
"messages_per_minute": {
37023698
"type": "integer",
37033699
"example": 1
@@ -3710,10 +3706,6 @@ const docTemplate = `{
37103706
"type": "string",
37113707
"example": "+18005550199"
37123708
},
3713-
"schedule_id": {
3714-
"type": "string",
3715-
"example": "32343a19-da5e-4b1b-a767-3298a73703cb"
3716-
},
37173709
"sim": {
37183710
"$ref": "#/definitions/entities.SIM"
37193711
},
@@ -4255,15 +4247,11 @@ const docTemplate = `{
42554247
"requests.MessageSendScheduleStore": {
42564248
"type": "object",
42574249
"required": [
4258-
"is_active",
42594250
"name",
42604251
"timezone",
42614252
"windows"
42624253
],
42634254
"properties": {
4264-
"is_active": {
4265-
"type": "boolean"
4266-
},
42674255
"name": {
42684256
"type": "string"
42694257
},
@@ -4353,7 +4341,6 @@ const docTemplate = `{
43534341
"messages_per_minute",
43544342
"missed_call_auto_reply",
43554343
"phone_number",
4356-
"schedule_id",
43574344
"sim"
43584345
],
43594346
"properties": {
@@ -4371,6 +4358,10 @@ const docTemplate = `{
43714358
"type": "integer",
43724359
"example": 12345
43734360
},
4361+
"message_send_schedule_id": {
4362+
"type": "string",
4363+
"example": "32343a19-da5e-4b1b-a767-3298a73703cb"
4364+
},
43744365
"messages_per_minute": {
43754366
"type": "integer",
43764367
"example": 1
@@ -4383,10 +4374,6 @@ const docTemplate = `{
43834374
"type": "string",
43844375
"example": "+18005550199"
43854376
},
4386-
"schedule_id": {
4387-
"type": "string",
4388-
"example": "32343a19-da5e-4b1b-a767-3298a73703cb"
4389-
},
43904377
"sim": {
43914378
"description": "SIM is the SIM slot of the phone in case the phone has more than 1 SIM slot",
43924379
"type": "string",
@@ -4762,6 +4749,30 @@ const docTemplate = `{
47624749
}
47634750
}
47644751
},
4752+
"responses.MessageSendSchedulesResponse": {
4753+
"type": "object",
4754+
"required": [
4755+
"data",
4756+
"message",
4757+
"status"
4758+
],
4759+
"properties": {
4760+
"data": {
4761+
"type": "array",
4762+
"items": {
4763+
"$ref": "#/definitions/entities.MessageSendSchedule"
4764+
}
4765+
},
4766+
"message": {
4767+
"type": "string",
4768+
"example": "Request handled successfully"
4769+
},
4770+
"status": {
4771+
"type": "string",
4772+
"example": "success"
4773+
}
4774+
}
4775+
},
47654776
"responses.MessageThreadsResponse": {
47664777
"type": "object",
47674778
"required": [
@@ -4865,6 +4876,23 @@ const docTemplate = `{
48654876
}
48664877
}
48674878
},
4879+
"responses.PaymentRequired": {
4880+
"type": "object",
4881+
"required": [
4882+
"message",
4883+
"status"
4884+
],
4885+
"properties": {
4886+
"message": {
4887+
"type": "string",
4888+
"example": "You have reached the maximum number of allowed resources. Please upgrade your plan."
4889+
},
4890+
"status": {
4891+
"type": "string",
4892+
"example": "error"
4893+
}
4894+
}
4895+
},
48684896
"responses.PhoneAPIKeyResponse": {
48694897
"type": "object",
48704898
"required": [

0 commit comments

Comments
 (0)