-
Notifications
You must be signed in to change notification settings - Fork 26
/
openapi.json
3412 lines (3412 loc) · 126 KB
/
openapi.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"openapi": "3.0.0",
"info": {
"title": "CMS HITECH APD API",
"description": "The API for the CMS HITECH APD app.",
"version": "0.0.1"
},
"paths": {
"/affiliations/me": {
"get": {
"tags": ["Affiliations"],
"description": "Get the current affiliations for the logged in user",
"responses": {
"200": {
"description": "A list of affiliations for the logged in user",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "ID of record"
},
"userId": {
"type": "string",
"description": "ID of user"
},
"displayName": {
"type": "string",
"description": "The full name of the user"
},
"email": {
"type": "string",
"description": "The email address of the user"
},
"stateId": {
"type": "string",
"description": "2-letter US State or Territory abbreviation, lowercase"
},
"status": {
"type": "string",
"description": "The status of the user role for this US State",
"enum": ["requested", "approved", "denied", "revoked"]
},
"role": {
"type": "string",
"description": "The role applied to this user for this US State"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of record creation"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp of last update"
}
}
}
}
}
}
},
"401": { "description": "The user is not logged in" }
},
"security": [{ "bearerAuth": [] }]
}
},
"/apds": {
"get": {
"tags": ["APDs"],
"summary": "Get all of the APDs available to the user",
"description": "Get a list of all apds associated with requesting user",
"responses": {
"200": {
"description": "The list of a user’s apds",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "number", "description": "APD ID" },
"created": {
"type": "string",
"format": "date-time",
"description": "Timestamp of when this APD was created"
},
"status": {
"type": "string",
"description": "Current status of the APD; e.g., \"draft\", \"archived\", etc."
},
"updated": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the last save to this APD"
},
"years": {
"type": "array",
"items": { "type": "number" }
}
}
}
}
}
}
},
"401": { "description": "The user is not logged in" },
"403": {
"description": "The user does not have permission to perform this activity"
}
},
"security": [{ "bearerAuth": [] }]
},
"post": {
"tags": ["APDs"],
"summary": "Create a new draft APD associated with the user's state",
"description": "Create a new draft APD for the current user's state",
"responses": {
"200": {
"description": "The new APD",
"content": {
"application/json": {
"schema": {
"oneOf": [
{ "$ref": "#/components/schemas/hitech" },
{ "$ref": "#/components/schemas/mmis" }
]
}
}
}
},
"401": { "description": "The user is not logged in" },
"403": {
"description": "The user does not have permission to perform this activity"
}
},
"security": [{ "bearerAuth": [] }]
}
},
"/apds/{id}": {
"get": {
"tags": ["APDs"],
"summary": "Get a single, complete APD",
"description": "Where the /apds GET method only returns a small portion of all APDs, this method returns all of one",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the apd to get",
"required": true,
"schema": { "type": "number" }
}
],
"responses": {
"200": {
"description": "The APD",
"content": {
"application/json": {
"schema": {
"oneOf": [
{ "$ref": "#/components/schemas/hitech" },
{ "$ref": "#/components/schemas/mmis" }
]
}
}
}
},
"401": { "description": "The user is not logged in" },
"403": {
"description": "The apd ID does not match any known apds for the user"
},
"404": { "description": "The apd does not exist" }
},
"security": [{ "bearerAuth": [] }]
},
"patch": {
"tags": ["APDs"],
"summary": "Update a specific APD",
"description": "Update an APD in the system using a set of JSON Patch objects. If state profile information is included, the profile information is also updated for the APD's state.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the apd to update",
"required": true,
"schema": { "type": "number" }
}
],
"requestBody": {
"description": "A set of JSON Patch objects to be applied to the APD to change it",
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"description": "A JSON Patch object",
"properties": {
"op": {
"type": "string",
"enum": ["add", "remove", "replace"],
"description": "The JSON Patch operation. This API only supports add, remove, and replace."
},
"path": {
"type": "string",
"description": "The path of the value to be operated on, specified as a JSON Pointer"
},
"value": {
"description": "For add or replace operations, the new value to be applied"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "The update was successful",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"apd": {
"oneOf": [
{ "$ref": "#/components/schemas/hitech" },
{ "$ref": "#/components/schemas/mmis" }
]
},
"budget": {
"oneOf": [
{ "$ref": "#/components/schemas/hitechBudget" },
{ "$ref": "#/components/schemas/mmisBudget" }
]
},
"adminCheck": { "$ref": "#/components/schemas/adminCheck" }
}
}
}
}
},
"400": {
"description": "The update failed due to a problem with the input data",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"description": "If the requested patch caused a validation failure, the API will return a list of invalid paths",
"properties": {
"path": {
"type": "string",
"description": "A JSON Pointer path whose patched value is invalid"
}
}
}
}
}
}
},
"401": { "description": "The user is not logged in" },
"403": {
"description": "The apd ID does not match any known apds for the user"
},
"404": { "description": "The apd does not exist" }
},
"security": [{ "bearerAuth": [] }]
},
"delete": {
"tags": ["APDs"],
"summary": "Archive an APD",
"description": "Updates an APD's status to \"archive\" and prevents it from being edited",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the apd to archive",
"required": true,
"schema": { "type": "number" }
}
],
"responses": {
"204": { "description": "The APD was archived" },
"400": { "description": "The apd is not in draft" },
"401": { "description": "The user is not logged in" },
"403": {
"description": "The apd ID does not match any known apds for the user"
},
"404": {
"description": "Invalid request, such as requesting to archive an APD that is not editable"
}
},
"security": [{ "bearerAuth": [] }]
}
},
"/apds/{id}/files": {
"post": {
"tags": ["APDs", "files"],
"summary": "Upload a file associated with an APD",
"description": "Uploads a file, associates it with a given APD, and stores any provided metadata.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the apd the file is associated with",
"required": true,
"schema": { "type": "number" }
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"metadata": {
"type": "object",
"description": "arbitrary metadata to attach to the file"
},
"file": {
"type": "string",
"format": "binary",
"description": "The file body"
}
}
}
}
}
},
"responses": {
"200": {
"description": "The URL of the uploaded file, absolute, relative to the API host",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL of the uploaded file, absolute, relative to the API host"
}
}
}
}
}
},
"400": {
"description": "Invalid request, such as requesting to archive an APD that is not editable"
},
"401": { "description": "The user is not logged in" },
"403": {
"description": "The apd ID does not match any known apds for the user"
},
"404": { "description": "The apd ID does not match any known apds" },
"415": { "description": "The file is not a valid format" }
},
"security": [{ "bearerAuth": [] }]
}
},
"/apds/{id}/files/{fileID}": {
"get": {
"tags": ["APDs", "files"],
"summary": "Get a file associated with an APD",
"description": "Returns a file that is associated with a given APD. This method returns a data blob with no information about the contents (such as the content-type); it is the responsibility of the consumer to understand the context of the file.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the apd the file is associated with",
"required": true,
"schema": { "type": "number" }
},
{
"name": "fileID",
"in": "path",
"description": "The ID of the file to get",
"required": true,
"schema": { "type": "number" }
}
],
"responses": {
"200": {
"description": "The file",
"content": {
"*/*": { "schema": { "type": "string", "format": "binary" } }
}
},
"400": {
"description": "The file does not belong to the APD or does not exist"
},
"401": { "description": "The user is not logged in" },
"403": {
"description": "The user does not have permission to perform this activity"
}
},
"security": [{ "bearerAuth": [] }]
}
},
"/apds/{id}/events": {
"post": {
"tags": ["APDs", "events"],
"summary": "Log an event performed on an APD",
"description": "Posts an event, associates it with a given APD, and stores any provided metadata.",
"parameters": [
{
"name": "id",
"in": "path",
"description": "The ID of the apd the event is associated with",
"required": true,
"schema": { "type": "number" }
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"eventType": {
"type": "string",
"description": "the type of the event performed"
},
"metadata": {
"type": "object",
"description": "anny additional metadata to add to the log"
}
}
}
}
}
},
"responses": {
"200": {
"description": "The status of the event being logged",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"success": {
"type": "boolean",
"description": "whether the event was successfully logged"
}
}
}
}
}
},
"401": { "description": "The user is not logged in" },
"403": {
"description": "The apd ID does not match any known apds for the user"
},
"404": { "description": "The apd ID does not match any known apds" }
},
"security": [{ "bearerAuth": [] }]
}
},
"/auth/activities": {
"get": {
"tags": ["Authentication and authorization"],
"summary": "Gets the list of all activities",
"description": "Get a list of all activities in the system",
"responses": {
"200": {
"description": "The list of activities known to the system",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "number", "description": "Activity ID" },
"name": {
"type": "string",
"description": "Activity name"
}
}
}
}
}
}
},
"401": { "description": "The user is not logged in" },
"403": {
"description": "The user does not have permission to perform this activity"
}
},
"security": [{ "bearerAuth": [] }]
}
},
"/auth/roles": {
"get": {
"tags": ["Authentication and authorization"],
"summary": "Gets the list of all roles",
"description": "Get a list of all roles in the system",
"responses": {
"200": {
"description": "The list of roles known to the system",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": { "type": "number", "description": "Role ID" },
"name": { "type": "string", "description": "Role name" },
"activities": {
"type": "array",
"items": {
"type": "string",
"description": "Activity name"
}
}
}
}
}
}
}
},
"401": { "description": "The user is not logged in" },
"403": {
"description": "The user does not have permission to perform this activity"
}
},
"security": [{ "bearerAuth": [] }]
}
},
"/auth/state/{stateId}": {
"get": {
"tags": ["Authentication and authorization"],
"parameters": [
{
"name": "stateId",
"in": "path",
"description": "2-letter US State or Territory abbreviation, lowercase",
"required": true,
"schema": { "type": "string" }
}
],
"summary": "Exchanges a user's token from one state to another.",
"description": "Switch from using one state to another, with updated and accurate permissions.",
"responses": {
"200": {
"description": "A JWT containing the new claims",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"jwt": { "type": "string", "description": "a JWT" }
}
}
}
}
},
"401": { "description": "The user is not logged in" },
"403": { "description": "The user can not switch to this state" }
},
"security": [{ "bearerAuth": [] }]
}
},
"/auth/certifications": {
"get": {
"tags": ["Certifications"],
"summary": "Retrieve the Add State Certifications and additional details",
"description": "get the state admin certifications and potential matches for loading up the state admin certification table",
"responses": {
"200": {
"description": "State Admin Certification form successfully saved"
},
"401": { "description": "Unauthorized" },
"403": {
"description": "The user does not have sufficient authorization to upload certification letters"
}
},
"security": [{ "bearerAuth": [] }]
},
"post": {
"tags": ["Certifications"],
"summary": "Submit the Add State Certification and additional details",
"description": "Handle the submission of the state admin certification form which includes the URL of the file from the related /files endpoint as well as additional details that are added manually.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"ffy": {
"type": "integer",
"description": "Federal Fiscal Year (FFY) that the certification is valid for"
},
"name": {
"type": "string",
"description": "Name of individual being certified"
},
"email": {
"type": "string",
"description": "Email of individual being certified"
},
"state": {
"type": "string",
"description": "State of individual being certified"
},
"fileUrl": {
"type": "string",
"description": "URL provided from the /certifications/files endpoint"
}
}
}
}
}
},
"responses": {
"200": {
"description": "State Admin Certification form successfully saved"
},
"400": { "description": "Invalid request" },
"401": { "description": "The user is not logged in" },
"403": {
"description": "The user does not have sufficient authorization to upload certification letters"
}
},
"security": [{ "bearerAuth": [] }]
},
"put": {
"tags": ["Certifications"],
"summary": "Match a state admin certification letter to an affiliation",
"description": "update a state admin certification to associate it with an affiliation and approve that affiliation as a state admin",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"certificationId": {
"type": "string",
"description": "ID of the certification letter"
},
"certificationFfy": {
"type": "string",
"description": "Federal Fiscal Year (FFY) from the certification upload form"
},
"affiliationId": {
"type": "string",
"description": "ID of the affiliation to be matched"
},
"stateId": {
"type": "string",
"description": "ID of the state associated with the affiliation"
}
}
}
}
}
},
"responses": {
"200": {
"description": "State Admin Certification match successful"
},
"400": { "description": "Invalid request" },
"401": { "description": "Unauthorized" },
"403": {
"description": "The user does not have sufficient authorization to match certification letters"
}
},
"security": [{ "bearerAuth": [] }]
},
"delete": {
"tags": ["Certifications"],
"summary": "Archives a previously uploaded state admin certification letter.",
"description": "Archives a previously uploaded state admin certification letter. Only non-matched letters can be archived/deleted.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"certificationId": {
"type": "string",
"description": "ID of the certification letter"
}
}
}
}
}
},
"responses": {
"200": {
"description": "State Admin Certification archived successfully"
},
"400": { "description": "Invalid request" },
"401": { "description": "Unauthorized" },
"403": {
"description": "The user does not have sufficient authorization to archive certification letters"
}
},
"security": [{ "bearerAuth": [] }]
}
},
"/auth/certifications/files/{fileID}": {
"get": {
"tags": ["files"],
"summary": "Get a state admin certification letter",
"description": "Returns a state admin certification letter",
"parameters": [
{
"name": "fileID",
"in": "path",
"description": "The ID of the file to get",
"required": true,
"schema": { "type": "number" }
}
],
"responses": {
"200": {
"description": "The file",
"content": {
"*/*": { "schema": { "type": "string", "format": "binary" } }
}
},
"400": { "description": "The file does not exist" },
"401": { "description": "The user is not logged in" },
"403": {
"description": "The user does not have permission to perform this activity"
}
},
"security": [{ "bearerAuth": [] }]
}
},
"/auth/certifications/files": {
"post": {
"tags": ["files"],
"summary": "Upload a state admin certification file",
"description": "Uploads a state admin certification letter.",
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "The file body"
}
}
}
}
}
},
"responses": {
"200": {
"description": "The URL of the uploaded file, absolute, relative to the API host",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "The URL of the uploaded file, absolute, relative to the API host"
}
}
}
}
}
},
"400": { "description": "Invalid request" },
"401": { "description": "The user is not logged in" },
"403": {
"description": "The user does not have sufficient authorization to upload certification letters"
},
"415": { "description": "The file is not a valid format" }
},
"security": [{ "bearerAuth": [] }]
}
},
"/docs/account-registration": {
"get": {
"tags": ["Docs"],
"description": "Get the account registration documentation",
"responses": {
"200": {
"description": "The file",
"content": {
"application/pdf": {
"schema": { "type": "string", "format": "binary" }
}
}
}
}
}
},
"/docs/system-access": {
"get": {
"tags": ["Docs"],
"description": "Get the eAPD system access documentation",
"responses": {
"200": {
"description": "The file",
"content": {
"application/pdf": {
"schema": { "type": "string", "format": "binary" }
}
}
}
}
}
},
"/me": {
"get": {
"tags": ["Users"],
"summary": "Gets the current user's information",
"description": "Get information about the current user",
"responses": {
"200": {
"description": "The current user",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "User's unique ID, used internally and for identifying the user when interacting with the API"
},
"name": {
"type": "string",
"description": "The user's name, if defined"
},
"username": {
"type": "string",
"description": "User's unique username"
},
"role": {
"type": "string",
"description": "The user's access role"
},
"state": {
"type": "object",
"description": "The state/territory/district that this user is assigned to",
"properties": {
"id": {
"type": "string",
"description": "Lowercase 2-letter code"
},
"name": {
"type": "string",
"description": "State/territory/district full name"
},
"medicaid_office": {
"type": "object",
"properties": {
"address1": { "type": "string" },
"city": { "type": "string" },
"zip": { "type": "string" },
"state": { "type": "string" },
"director": {
"type": "object",
"properties": {
"name": { "type": "string" },
"email": { "type": "string" },
"phone": { "type": "string" }
}
}
}
}
}
},
"states": {
"type": "object",
"properties": {
"{state_id}": {
"type": "string",
"description": "The affiliation status for the state in the field",
"enum": ["requested", "approved", "denied", "revoked"]
}
}
},
"permissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"{state_id}": {
"type": "array",
"items": {
"type": "string",
"description": "Names of system activities this user can perform for that state"
}
}
}
}
},
"activities": {
"type": "array",
"items": {
"type": "string",
"description": "Names of system activities this user can perform for the selected state"
}
},
"affiliation": {
"type": "object",
"properties": {
"id": { "type": "string" },
"user_id": { "type": "string" },
"username": { "type": "string" },
"state_id": { "type": "string" },
"role_id": { "type": "string" },
"state": { "type": "string" },
"created_at": { "type": "string" },
"updated_at": { "type": "string" },
"expires_at": { "type": "string" }
}
}
}
}
}
}
},
"401": { "description": "The user is not logged in" }
},
"security": [{ "bearerAuth": [] }]
}
},
"/roles": {
"get": {
"tags": ["Roles"],
"description": "Get a list of all of the active roles",
"responses": {
"200": {
"description": "List of Active Roles",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Integer ID for a role"
},
"name": {
"type": "string",
"description": "Full name of the Role"
}
}
}
}
}
}
},
"401": { "description": "The user is not logged in" },
"403": {
"description": "The user does not have permission to perform this activity"
}
},
"security": [{ "bearerAuth": [] }]
}
},
"/states": {
"get": {
"tags": ["States"],
"description": "Get a list of all US States and Territories",
"responses": {
"200": {
"description": "List of US States and Territories",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "2-letter US State or Territory abbreviation, lowercase"
},
"name": {
"type": "string",
"description": "Full name of US State or Territory"
}
}
}
}