Skip to content

Commit b54cde8

Browse files
brettmortensenbrettmortensen
committed
Add nullable
Adds `nullable: true` to response fields to handle cases in our test data where a field might be nil.
1 parent 23c8808 commit b54cde8

1 file changed

Lines changed: 50 additions & 4 deletions

File tree

‎openapi/mx_platform_api.yml‎

Lines changed: 50 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,23 @@ components:
55
properties:
66
account_guid:
77
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
8+
nullable: true
89
type: string
910
account_number:
1011
example: '10001'
1112
nullable: true
1213
type: string
1314
guid:
1415
example: ACN-8899832e-e5b4-42cd-aa25-bbf1dc889a8f
16+
nullable: true
1517
type: string
1618
institution_number:
1719
example: '123'
1820
nullable: true
1921
type: string
2022
member_guid:
2123
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
24+
nullable: true
2225
type: string
2326
routing_number:
2427
example: '68899990000000'
@@ -30,6 +33,7 @@ components:
3033
type: string
3134
user_guid:
3235
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
36+
nullable: true
3337
type: string
3438
type: object
3539
AccountNumbersResponseBody:
@@ -45,6 +49,7 @@ components:
4549
properties:
4650
account_guid:
4751
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
52+
nullable: true
4853
type: string
4954
address:
5055
example: 123 This Way
@@ -64,9 +69,11 @@ components:
6469
type: string
6570
guid:
6671
example: ACO-63dc7714-6fc0-4aa2-a069-c06cdccd1af9
72+
nullable: true
6773
type: string
6874
member_guid:
6975
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
76+
nullable: true
7077
type: string
7178
owner_name:
7279
example: Donnie Darko
@@ -86,6 +93,7 @@ components:
8693
type: string
8794
user_guid:
8895
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
96+
nullable: true
8997
type: string
9098
type: object
9199
AccountOwnersResponseBody:
@@ -153,6 +161,7 @@ components:
153161
type: integer
154162
guid:
155163
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
164+
nullable: true
156165
type: string
157166
holdings_value:
158167
example: 1000.0
@@ -204,6 +213,7 @@ components:
204213
type: string
205214
member_guid:
206215
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
216+
nullable: true
207217
type: string
208218
member_id:
209219
example: member123
@@ -279,6 +289,7 @@ components:
279289
type: string
280290
user_guid:
281291
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
292+
nullable: true
282293
type: string
283294
user_id:
284295
example: user123
@@ -346,6 +357,7 @@ components:
346357
type: string
347358
guid:
348359
example: CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874
360+
nullable: true
349361
type: string
350362
is_default:
351363
example: true
@@ -365,6 +377,7 @@ components:
365377
type: string
366378
parent_guid:
367379
example: CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874
380+
nullable: true
368381
type: string
369382
updated_at:
370383
example: '2015-05-13T18:01:23.000Z'
@@ -398,6 +411,7 @@ components:
398411
type: string
399412
guid:
400413
example: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
414+
nullable: true
401415
type: string
402416
image_data:
403417
example: Who is this guy?
@@ -478,6 +492,7 @@ components:
478492
type: string
479493
guid:
480494
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
495+
nullable: true
481496
type: string
482497
type: object
483498
ConnectWidgetResponseBody:
@@ -492,7 +507,6 @@ components:
492507
type: string
493508
value:
494509
example: password
495-
nullable: true
496510
type: string
497511
type: object
498512
CredentialResponse:
@@ -511,9 +525,11 @@ components:
511525
type: string
512526
guid:
513527
example: CRD-1ec152cd-e628-e81a-e852-d1e7104624da
528+
nullable: true
514529
type: string
515530
label:
516531
example: Username
532+
nullable: true
517533
type: string
518534
type: object
519535
CredentialsResponseBody:
@@ -605,6 +621,7 @@ components:
605621
type: integer
606622
merchant_guid:
607623
example: MCH-14f25b63-ef47-a38e-b2b6-d02b280b6e4e
624+
nullable: true
608625
type: string
609626
merchant_location_guid:
610627
example: MCL-00024e59-18b5-4d79-b879-2a7896726fea
@@ -663,7 +680,8 @@ components:
663680
HoldingResponse:
664681
properties:
665682
account_guid:
666-
example: HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2
683+
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
684+
nullable: true
667685
type: string
668686
cost_basis:
669687
example: 827.0
@@ -691,6 +709,7 @@ components:
691709
type: string
692710
guid:
693711
example: HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2
712+
nullable: true
694713
type: string
695714
holding_type:
696715
example: MONEY_MARKET
@@ -706,6 +725,7 @@ components:
706725
type: number
707726
member_guid:
708727
example: MBR-d65683e8-9eab-26bb-bcfd-ced159c9abe
728+
nullable: true
709729
type: string
710730
metadata:
711731
example: metadata
@@ -729,6 +749,7 @@ components:
729749
type: string
730750
user_guid:
731751
example: USR-743e5d7f-1116-28fa-5de1-d3ba02e41d8d
752+
nullable: true
732753
type: string
733754
type: object
734755
HoldingResponseBody:
@@ -1255,6 +1276,7 @@ components:
12551276
type: string
12561277
guid:
12571278
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
1279+
nullable: true
12581280
type: string
12591281
id:
12601282
example: unique_id
@@ -1294,6 +1316,7 @@ components:
12941316
type: string
12951317
user_guid:
12961318
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
1319+
nullable: true
12971320
type: string
12981321
user_id:
12991322
example: user123
@@ -1333,6 +1356,7 @@ components:
13331356
type: string
13341357
guid:
13351358
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
1359+
nullable: true
13361360
type: string
13371361
has_processed_accounts:
13381362
example: true
@@ -1409,6 +1433,7 @@ components:
14091433
type: string
14101434
guid:
14111435
example: MCL-00024e59-18b5-4d79-b879-2a7896726fea
1436+
nullable: true
14121437
type: string
14131438
latitude:
14141439
example: 39.5963005
@@ -1420,6 +1445,7 @@ components:
14201445
type: number
14211446
merchant_guid:
14221447
example: MCH-09466f0a-fb58-9d1a-bae2-2af0afbea621
1448+
nullable: true
14231449
type: string
14241450
phone_number:
14251451
example: "(303) 689-0728"
@@ -1455,6 +1481,7 @@ components:
14551481
type: string
14561482
guid:
14571483
example: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b
1484+
nullable: true
14581485
type: string
14591486
logo_url:
14601487
example: https://s3.amazonaws.com/MD_Assets/merchant_logos/comcast.png
@@ -1491,6 +1518,7 @@ components:
14911518
properties:
14921519
guid:
14931520
example: MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f
1521+
nullable: true
14941522
type: string
14951523
oauth_window_uri:
14961524
example: int-widgets.moneydesktop.com/oauth/predirect_to/MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f/zgknnw5k7dmztn2njmwlgz574mZlnft6vdrv7kzn9ptj325th6c5p0w6c7j83Ap1bqg01mhsr1bqjgf2fry3ly9wff497c6fcczbyrfgj7s39cygw95Akl7vlpmcAy2kmvh1mlkytg7jA1z3vnw1w3zx2r1wt65s6f6r3ryqqrysl9qA1kr6cAj6vhr1zl325Azz6hx52j1ll3vwbvvbv5xzy7d6csplyw25brA7147vAfq29ArjjAj4qmc6r6h457hkcj2946m0kjp2xzpkz6hz55lsp3Avmdb8dsq4xzqmzzqk68s6bp5tj9jsskw4wvcb95vm4fwh9w8phgp67hfj2flrtwcy5bxbtk74?skip_aggregation=false
@@ -1532,6 +1560,7 @@ components:
15321560
properties:
15331561
account_guid:
15341562
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
1563+
nullable: true
15351564
type: string
15361565
content_hash:
15371566
example: ca53785b812d00ef821c3d94bfd6e5bbc0020504410589b7ea8552169f021981
@@ -1543,9 +1572,11 @@ components:
15431572
type: string
15441573
guid:
15451574
example: STA-737a344b-caae-0f6e-1384-01f52e75dcb1
1575+
nullable: true
15461576
type: string
15471577
member_guid:
15481578
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
1579+
nullable: true
15491580
type: string
15501581
updated_at:
15511582
example: '2016-10-13T18:09:00+00:00'
@@ -1557,6 +1588,7 @@ components:
15571588
type: string
15581589
user_guid:
15591590
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
1591+
nullable: true
15601592
type: string
15611593
type: object
15621594
StatementResponseBody:
@@ -1590,13 +1622,15 @@ components:
15901622
properties:
15911623
guid:
15921624
example: TAG-aef36e72-6294-4c38-844d-e573e80aed52
1625+
nullable: true
15931626
type: string
15941627
name:
15951628
example: MY TAG
15961629
nullable: true
15971630
type: string
15981631
user_guid:
15991632
example: USR-11141024-90b3-1bce-cac9-c06ced52ab4c
1633+
nullable: true
16001634
type: string
16011635
type: object
16021636
TagResponseBody:
@@ -1638,19 +1672,23 @@ components:
16381672
properties:
16391673
guid:
16401674
example: TGN-007f5486-17e1-45fc-8b87-8f03984430fe
1675+
nullable: true
16411676
type: string
16421677
member_is_managed_by_user:
16431678
example: false
16441679
nullable: true
16451680
type: boolean
16461681
tag_guid:
16471682
example: TAG-40faf068-abb4-405c-8f6a-e883ed541fff
1683+
nullable: true
16481684
type: string
16491685
transaction_guid:
16501686
example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4
1687+
nullable: true
16511688
type: string
16521689
user_guid:
16531690
example: USR-11141024-90b3-1bce-cac9-c06ced52ab4c
1691+
nullable: true
16541692
type: string
16551693
type: object
16561694
TaggingResponseBody:
@@ -1693,6 +1731,7 @@ components:
16931731
properties:
16941732
account_guid:
16951733
example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
1734+
nullable: true
16961735
type: string
16971736
account_id:
16981737
example: account123
@@ -1736,6 +1775,7 @@ components:
17361775
type: string
17371776
guid:
17381777
example: TRN-265abee9-889b-af6a-c69b-25157db2bdd9
1778+
nullable: true
17391779
type: string
17401780
id:
17411781
example: transaction-265abee9-889b-af6a-c69b-25157db2bdd9
@@ -1799,6 +1839,7 @@ components:
17991839
type: number
18001840
member_guid:
18011841
example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
1842+
nullable: true
18021843
type: string
18031844
member_is_managed_by_user:
18041845
example: false
@@ -1814,9 +1855,11 @@ components:
18141855
type: integer
18151856
merchant_guid:
18161857
example: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b
1858+
nullable: true
18171859
type: string
18181860
merchant_location_guid:
18191861
example: MCL-00024e59-18b5-4d79-b879-2a7896726fea
1862+
nullable: true
18201863
type: string
18211864
metadata:
18221865
example: some metadata
@@ -1852,6 +1895,7 @@ components:
18521895
type: string
18531896
user_guid:
18541897
example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
1898+
nullable: true
18551899
type: string
18561900
user_id:
18571901
example: user123
@@ -1887,6 +1931,7 @@ components:
18871931
properties:
18881932
category_guid:
18891933
example: CAT-b1de2a04-db08-b6ed-f6fe-ca2f5b11c2d0
1934+
nullable: true
18901935
type: string
18911936
created_at:
18921937
example: '2018-10-02T22:00:50+00:00'
@@ -1898,6 +1943,7 @@ components:
18981943
type: string
18991944
guid:
19001945
example: TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3
1946+
nullable: true
19011947
type: string
19021948
match_description:
19031949
example: Wal-mart
@@ -1909,6 +1955,7 @@ components:
19091955
type: string
19101956
user_guid:
19111957
example: USR-22fc3203-b3e6-8340-43db-8e50b2f56995
1958+
nullable: true
19121959
type: string
19131960
type: object
19141961
TransactionRuleResponseBody:
@@ -1923,11 +1970,9 @@ components:
19231970
type: string
19241971
description:
19251972
example: Wal-mart food storage
1926-
nullable: true
19271973
type: string
19281974
match_description:
19291975
example: Wal-mart
1930-
nullable: true
19311976
type: string
19321977
type: object
19331978
TransactionRuleUpdateRequestBody:
@@ -1994,6 +2039,7 @@ components:
19942039
type: string
19952040
guid:
19962041
example: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
2042+
nullable: true
19972043
type: string
19982044
id:
19992045
example: My-Unique-ID

0 commit comments

Comments
 (0)