Skip to content

Commit 27ff555

Browse files
morremeyermorremeyer
authored
fix: type of IDs in API docs (#184)
1 parent 33d81dd commit 27ff555

File tree

9 files changed

+182
-182
lines changed

9 files changed

+182
-182
lines changed

‎api/docs.go‎

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,8 @@ const docTemplate = `{
186186
"summary": "Get account",
187187
"parameters": [
188188
{
189-
"type": "integer",
190-
"description": "ID of the account",
189+
"type": "string",
190+
"description": "ID formatted as string",
191191
"name": "accountId",
192192
"in": "path",
193193
"required": true
@@ -228,8 +228,8 @@ const docTemplate = `{
228228
"summary": "Delete account",
229229
"parameters": [
230230
{
231-
"type": "integer",
232-
"description": "ID of the account",
231+
"type": "string",
232+
"description": "ID formatted as string",
233233
"name": "accountId",
234234
"in": "path",
235235
"required": true
@@ -264,8 +264,8 @@ const docTemplate = `{
264264
"summary": "Allowed HTTP verbs",
265265
"parameters": [
266266
{
267-
"type": "integer",
268-
"description": "ID of the account",
267+
"type": "string",
268+
"description": "ID formatted as string",
269269
"name": "accountId",
270270
"in": "path",
271271
"required": true
@@ -297,8 +297,8 @@ const docTemplate = `{
297297
"summary": "Update account",
298298
"parameters": [
299299
{
300-
"type": "integer",
301-
"description": "ID of the account",
300+
"type": "string",
301+
"description": "ID formatted as string",
302302
"name": "accountId",
303303
"in": "path",
304304
"required": true
@@ -441,8 +441,8 @@ const docTemplate = `{
441441
"summary": "Get allocation",
442442
"parameters": [
443443
{
444-
"type": "integer",
445-
"description": "ID of the allocation",
444+
"type": "string",
445+
"description": "ID formatted as string",
446446
"name": "allocationId",
447447
"in": "path",
448448
"required": true
@@ -480,8 +480,8 @@ const docTemplate = `{
480480
"summary": "Delete an allocation",
481481
"parameters": [
482482
{
483-
"type": "integer",
484-
"description": "ID of the allocation",
483+
"type": "string",
484+
"description": "ID formatted as string",
485485
"name": "allocationId",
486486
"in": "path",
487487
"required": true
@@ -516,8 +516,8 @@ const docTemplate = `{
516516
"summary": "Allowed HTTP verbs",
517517
"parameters": [
518518
{
519-
"type": "integer",
520-
"description": "ID of the allocation",
519+
"type": "string",
520+
"description": "ID formatted as string",
521521
"name": "allocationId",
522522
"in": "path",
523523
"required": true
@@ -543,8 +543,8 @@ const docTemplate = `{
543543
"summary": "Update an allocation",
544544
"parameters": [
545545
{
546-
"type": "integer",
547-
"description": "ID of the allocation",
546+
"type": "string",
547+
"description": "ID formatted as string",
548548
"name": "allocationId",
549549
"in": "path",
550550
"required": true
@@ -684,8 +684,8 @@ const docTemplate = `{
684684
"summary": "Get a budget",
685685
"parameters": [
686686
{
687-
"type": "integer",
688-
"description": "ID of the budget",
687+
"type": "string",
688+
"description": "ID formatted as string",
689689
"name": "budgetId",
690690
"in": "path",
691691
"required": true
@@ -723,8 +723,8 @@ const docTemplate = `{
723723
"summary": "Delete a budget",
724724
"parameters": [
725725
{
726-
"type": "integer",
727-
"description": "ID of the budget",
726+
"type": "string",
727+
"description": "ID formatted as string",
728728
"name": "budgetId",
729729
"in": "path",
730730
"required": true
@@ -759,8 +759,8 @@ const docTemplate = `{
759759
"summary": "Allowed HTTP verbs",
760760
"parameters": [
761761
{
762-
"type": "integer",
763-
"description": "ID of the budget",
762+
"type": "string",
763+
"description": "ID formatted as string",
764764
"name": "budgetId",
765765
"in": "path",
766766
"required": true
@@ -801,8 +801,8 @@ const docTemplate = `{
801801
"summary": "Update a budget",
802802
"parameters": [
803803
{
804-
"type": "integer",
805-
"description": "ID of the budget",
804+
"type": "string",
805+
"description": "ID formatted as string",
806806
"name": "budgetId",
807807
"in": "path",
808808
"required": true
@@ -854,8 +854,8 @@ const docTemplate = `{
854854
"summary": "Get Budget month data",
855855
"parameters": [
856856
{
857-
"type": "integer",
858-
"description": "ID of the budget",
857+
"type": "string",
858+
"description": "ID formatted as string",
859859
"name": "budgetId",
860860
"in": "path",
861861
"required": true
@@ -1005,8 +1005,8 @@ const docTemplate = `{
10051005
"summary": "Get category",
10061006
"parameters": [
10071007
{
1008-
"type": "integer",
1009-
"description": "ID of the category",
1008+
"type": "string",
1009+
"description": "ID formatted as string",
10101010
"name": "categoryId",
10111011
"in": "path",
10121012
"required": true
@@ -1044,8 +1044,8 @@ const docTemplate = `{
10441044
"summary": "Delete a category",
10451045
"parameters": [
10461046
{
1047-
"type": "integer",
1048-
"description": "ID of the category",
1047+
"type": "string",
1048+
"description": "ID formatted as string",
10491049
"name": "categoryId",
10501050
"in": "path",
10511051
"required": true
@@ -1080,8 +1080,8 @@ const docTemplate = `{
10801080
"summary": "Allowed HTTP verbs",
10811081
"parameters": [
10821082
{
1083-
"type": "integer",
1084-
"description": "ID of the category",
1083+
"type": "string",
1084+
"description": "ID formatted as string",
10851085
"name": "categoryId",
10861086
"in": "path",
10871087
"required": true
@@ -1116,8 +1116,8 @@ const docTemplate = `{
11161116
"summary": "Update a category",
11171117
"parameters": [
11181118
{
1119-
"type": "integer",
1120-
"description": "ID of the category",
1119+
"type": "string",
1120+
"description": "ID formatted as string",
11211121
"name": "categoryId",
11221122
"in": "path",
11231123
"required": true
@@ -1260,8 +1260,8 @@ const docTemplate = `{
12601260
"summary": "Get envelope",
12611261
"parameters": [
12621262
{
1263-
"type": "integer",
1264-
"description": "ID of the envelope",
1263+
"type": "string",
1264+
"description": "ID formatted as string",
12651265
"name": "envelopeId",
12661266
"in": "path",
12671267
"required": true
@@ -1299,8 +1299,8 @@ const docTemplate = `{
12991299
"summary": "Delete an envelope",
13001300
"parameters": [
13011301
{
1302-
"type": "integer",
1303-
"description": "ID of the envelope",
1302+
"type": "string",
1303+
"description": "ID formatted as string",
13041304
"name": "envelopeId",
13051305
"in": "path",
13061306
"required": true
@@ -1335,8 +1335,8 @@ const docTemplate = `{
13351335
"summary": "Allowed HTTP verbs",
13361336
"parameters": [
13371337
{
1338-
"type": "integer",
1339-
"description": "ID of the envelope",
1338+
"type": "string",
1339+
"description": "ID formatted as string",
13401340
"name": "envelopeId",
13411341
"in": "path",
13421342
"required": true
@@ -1362,8 +1362,8 @@ const docTemplate = `{
13621362
"summary": "Update an envelope",
13631363
"parameters": [
13641364
{
1365-
"type": "integer",
1366-
"description": "ID of the envelope",
1365+
"type": "string",
1366+
"description": "ID formatted as string",
13671367
"name": "envelopeId",
13681368
"in": "path",
13691369
"required": true
@@ -1415,8 +1415,8 @@ const docTemplate = `{
14151415
"summary": "Get Envelope month data",
14161416
"parameters": [
14171417
{
1418-
"type": "integer",
1419-
"description": "ID of the envelope",
1418+
"type": "string",
1419+
"description": "ID formatted as string",
14201420
"name": "envelopeId",
14211421
"in": "path",
14221422
"required": true
@@ -1557,8 +1557,8 @@ const docTemplate = `{
15571557
"summary": "Get transaction",
15581558
"parameters": [
15591559
{
1560-
"type": "integer",
1561-
"description": "ID of the transaction",
1560+
"type": "string",
1561+
"description": "ID formatted as string",
15621562
"name": "transactionId",
15631563
"in": "path",
15641564
"required": true
@@ -1596,8 +1596,8 @@ const docTemplate = `{
15961596
"summary": "Delete a transaction",
15971597
"parameters": [
15981598
{
1599-
"type": "integer",
1600-
"description": "ID of the transaction",
1599+
"type": "string",
1600+
"description": "ID formatted as string",
16011601
"name": "transactionId",
16021602
"in": "path",
16031603
"required": true
@@ -1632,8 +1632,8 @@ const docTemplate = `{
16321632
"summary": "Allowed HTTP verbs",
16331633
"parameters": [
16341634
{
1635-
"type": "integer",
1636-
"description": "ID of the transaction",
1635+
"type": "string",
1636+
"description": "ID formatted as string",
16371637
"name": "transactionId",
16381638
"in": "path",
16391639
"required": true
@@ -1659,8 +1659,8 @@ const docTemplate = `{
16591659
"summary": "Update a transaction",
16601660
"parameters": [
16611661
{
1662-
"type": "integer",
1663-
"description": "ID of the transaction",
1662+
"type": "string",
1663+
"description": "ID formatted as string",
16641664
"name": "transactionId",
16651665
"in": "path",
16661666
"required": true

0 commit comments

Comments
 (0)