Skip to content

Commit 648b3c1

Browse files
stiehlrodstiehlrod
authored
API-45171-poa-req-doc-cleanup (#21107)
* Updates 200.json to update the response schema for consumer docs, and updates the swagger docs. * Moves address out from under claimant. * Corrects spelling on 200.json, and re-runs the rake task for the swagger.dev file. * Updates the index and decide, and the swagger file.
1 parent b779b4c commit 648b3c1

File tree

5 files changed

+212
-74
lines changed

5 files changed

+212
-74
lines changed

‎modules/claims_api/app/swagger/claims_api/v2/dev/swagger.json

+106-37
Original file line numberDiff line numberDiff line change
@@ -9331,7 +9331,7 @@
93319331
"status": "422",
93329332
"detail": "Could not retrieve Power of Attorney due to multiple representatives with code: A1Q",
93339333
"source": {
9334-
"pointer": "/modules/claims_api/app/controllers/claims_api/v2/veterans/power_of_attorney/base_controller.rb:163:in `representative'"
9334+
"pointer": "/modules/claims_api/app/controllers/claims_api/v2/veterans/power_of_attorney/base_controller.rb:164:in `representative'"
93359335
}
93369336
}
93379337
]
@@ -10440,39 +10440,56 @@
1044010440
"type": "object",
1044110441
"properties": {
1044210442
"firstName": {
10443+
"description": "First name for the veteran.",
1044310444
"type": "string"
1044410445
},
1044510446
"lastName": {
10447+
"description": "Last name for the veteran.",
1044610448
"type": "string"
1044710449
},
1044810450
"middleName": {
10451+
"description": "Middle name for the veteran.",
1044910452
"type": "string"
1045010453
}
1045110454
}
1045210455
},
1045310456
"claimant": {
1045410457
"type": "object",
1045510458
"properties": {
10456-
"city": {
10457-
"type": "string"
10458-
},
10459-
"country": {
10460-
"type": "string"
10461-
},
10462-
"militaryPo": {
10463-
"type": "string"
10464-
},
10465-
"militaryPostalCode": {
10459+
"firstName": {
10460+
"description": "First name for the dependent claimant.",
1046610461
"type": "string"
1046710462
},
10468-
"state": {
10463+
"lastName": {
10464+
"description": "Last name for the dependent claimant.",
1046910465
"type": "string"
1047010466
},
10471-
"zip": {
10467+
"middleName": {
10468+
"description": "Middle name for the dependent claimant.",
1047210469
"type": "string"
1047310470
}
1047410471
}
1047510472
},
10473+
"address": {
10474+
"city": {
10475+
"type": "string"
10476+
},
10477+
"country": {
10478+
"type": "string"
10479+
},
10480+
"militaryPo": {
10481+
"type": "string"
10482+
},
10483+
"militaryPostalCode": {
10484+
"type": "string"
10485+
},
10486+
"state": {
10487+
"type": "string"
10488+
},
10489+
"zip": {
10490+
"type": "string"
10491+
}
10492+
},
1047610493
"representative": {
1047710494
"type": "object",
1047810495
"properties": {
@@ -10491,27 +10508,33 @@
1049110508
}
1049210509
},
1049310510
"receivedDate": {
10511+
"description": "Date the request for representation was established.",
1049410512
"type": "string",
1049510513
"format": "date-time"
1049610514
},
1049710515
"actionedDate": {
10516+
"description": "Date the request for representation was accepted or declined by a representative.",
1049810517
"type": "string",
1049910518
"format": "date-time"
1050010519
},
1050110520
"status": {
10521+
"description": "Status of the request for representation.",
1050210522
"type": "string"
1050310523
},
1050410524
"declinedReason": {
10525+
"description": "Reason for declining the request for representation.",
1050510526
"type": "string"
1050610527
},
1050710528
"consentAddressChange": {
10529+
"description": "Authorization for Representative to Act on Claimant's Behalf to Change Claimant's Address.",
1050810530
"type": "boolean",
1050910531
"enum": [
1051010532
true,
1051110533
false
1051210534
]
1051310535
},
1051410536
"recordConsent": {
10537+
"description": "Authorization for Representative's Access to Records Protected by Section 7332, Title 38, U.S.C.",
1051510538
"type": "boolean",
1051610539
"enum": [
1051710540
true,
@@ -10846,39 +10869,56 @@
1084610869
"type": "object",
1084710870
"properties": {
1084810871
"firstName": {
10872+
"description": "First name for the veteran.",
1084910873
"type": "string"
1085010874
},
1085110875
"lastName": {
10876+
"description": "Last name for the veteran.",
1085210877
"type": "string"
1085310878
},
1085410879
"middleName": {
10880+
"description": "Middle name for the veteran.",
1085510881
"type": "string"
1085610882
}
1085710883
}
1085810884
},
1085910885
"claimant": {
1086010886
"type": "object",
1086110887
"properties": {
10862-
"city": {
10863-
"type": "string"
10864-
},
10865-
"country": {
10866-
"type": "string"
10867-
},
10868-
"militaryPo": {
10869-
"type": "string"
10870-
},
10871-
"militaryPostalCode": {
10888+
"firstName": {
10889+
"description": "First name for the dependent claimant.",
1087210890
"type": "string"
1087310891
},
10874-
"state": {
10892+
"lastName": {
10893+
"description": "Last name for the dependent claimant.",
1087510894
"type": "string"
1087610895
},
10877-
"zip": {
10896+
"middleName": {
10897+
"description": "Middle name for the dependent claimant.",
1087810898
"type": "string"
1087910899
}
1088010900
}
1088110901
},
10902+
"address": {
10903+
"city": {
10904+
"type": "string"
10905+
},
10906+
"country": {
10907+
"type": "string"
10908+
},
10909+
"militaryPo": {
10910+
"type": "string"
10911+
},
10912+
"militaryPostalCode": {
10913+
"type": "string"
10914+
},
10915+
"state": {
10916+
"type": "string"
10917+
},
10918+
"zip": {
10919+
"type": "string"
10920+
}
10921+
},
1088210922
"representative": {
1088310923
"type": "object",
1088410924
"properties": {
@@ -10897,27 +10937,33 @@
1089710937
}
1089810938
},
1089910939
"receivedDate": {
10940+
"description": "Date the request for representation was established.",
1090010941
"type": "string",
1090110942
"format": "date-time"
1090210943
},
1090310944
"actionedDate": {
10945+
"description": "Date the request for representation was accepted or declined by a representative.",
1090410946
"type": "string",
1090510947
"format": "date-time"
1090610948
},
1090710949
"status": {
10950+
"description": "Status of the request for representation.",
1090810951
"type": "string"
1090910952
},
1091010953
"declinedReason": {
10954+
"description": "Reason for declining the request for representation.",
1091110955
"type": "string"
1091210956
},
1091310957
"consentAddressChange": {
10958+
"description": "Authorization for Representative to Act on Claimant's Behalf to Change Claimant's Address.",
1091410959
"type": "boolean",
1091510960
"enum": [
1091610961
true,
1091710962
false
1091810963
]
1091910964
},
1092010965
"recordConsent": {
10966+
"description": "Authorization for Representative's Access to Records Protected by Section 7332, Title 38, U.S.C.",
1092110967
"type": "boolean",
1092210968
"enum": [
1092310969
true,
@@ -11153,39 +11199,56 @@
1115311199
"type": "object",
1115411200
"properties": {
1115511201
"firstName": {
11202+
"description": "First name for the veteran.",
1115611203
"type": "string"
1115711204
},
1115811205
"lastName": {
11206+
"description": "Last name for the veteran.",
1115911207
"type": "string"
1116011208
},
1116111209
"middleName": {
11210+
"description": "Middle name for the veteran.",
1116211211
"type": "string"
1116311212
}
1116411213
}
1116511214
},
1116611215
"claimant": {
1116711216
"type": "object",
1116811217
"properties": {
11169-
"city": {
11170-
"type": "string"
11171-
},
11172-
"country": {
11173-
"type": "string"
11174-
},
11175-
"militaryPo": {
11176-
"type": "string"
11177-
},
11178-
"militaryPostalCode": {
11218+
"firstName": {
11219+
"description": "First name for the dependent claimant.",
1117911220
"type": "string"
1118011221
},
11181-
"state": {
11222+
"lastName": {
11223+
"description": "Last name for the dependent claimant.",
1118211224
"type": "string"
1118311225
},
11184-
"zip": {
11226+
"middleName": {
11227+
"description": "Middle name for the dependent claimant.",
1118511228
"type": "string"
1118611229
}
1118711230
}
1118811231
},
11232+
"address": {
11233+
"city": {
11234+
"type": "string"
11235+
},
11236+
"country": {
11237+
"type": "string"
11238+
},
11239+
"militaryPo": {
11240+
"type": "string"
11241+
},
11242+
"militaryPostalCode": {
11243+
"type": "string"
11244+
},
11245+
"state": {
11246+
"type": "string"
11247+
},
11248+
"zip": {
11249+
"type": "string"
11250+
}
11251+
},
1118911252
"representative": {
1119011253
"type": "object",
1119111254
"properties": {
@@ -11204,27 +11267,33 @@
1120411267
}
1120511268
},
1120611269
"receivedDate": {
11270+
"description": "Date the request for representation was established.",
1120711271
"type": "string",
1120811272
"format": "date-time"
1120911273
},
1121011274
"actionedDate": {
11275+
"description": "Date the request for representation was accepted or declined by a representative.",
1121111276
"type": "string",
1121211277
"format": "date-time"
1121311278
},
1121411279
"status": {
11280+
"description": "Status of the request for representation.",
1121511281
"type": "string"
1121611282
},
1121711283
"declinedReason": {
11284+
"description": "Reason for declining the request for representation.",
1121811285
"type": "string"
1121911286
},
1122011287
"consentAddressChange": {
11288+
"description": "Authorization for Representative to Act on Claimant's Behalf to Change Claimant's Address.",
1122111289
"type": "boolean",
1122211290
"enum": [
1122311291
true,
1122411292
false
1122511293
]
1122611294
},
1122711295
"recordConsent": {
11296+
"description": "Authorization for Representative's Access to Records Protected by Section 7332, Title 38, U.S.C.",
1122811297
"type": "boolean",
1122911298
"enum": [
1123011299
true,

‎modules/claims_api/app/swagger/claims_api/v2/production/swagger.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -9331,7 +9331,7 @@
93319331
"status": "422",
93329332
"detail": "Could not retrieve Power of Attorney due to multiple representatives with code: A1Q",
93339333
"source": {
9334-
"pointer": "/modules/claims_api/app/controllers/claims_api/v2/veterans/power_of_attorney/base_controller.rb:163:in `representative'"
9334+
"pointer": "/modules/claims_api/app/controllers/claims_api/v2/veterans/power_of_attorney/base_controller.rb:164:in `representative'"
93359335
}
93369336
}
93379337
]

0 commit comments

Comments
 (0)