Skip to content

Commit 8c1fb67

Browse files
landonshumway-ialandonshumway-ia
committed
Update OpenAPI spec to latest
1 parent 3b11ac1 commit 8c1fb67

1 file changed

Lines changed: 225 additions & 35 deletions

File tree

‎backend/compact-connect/docs/internal/api-specification/latest-oas30.json‎

Lines changed: 225 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"openapi": "3.0.1",
33
"info": {
44
"title": "LicenseApi",
5-
"version": "2026-01-07T22:16:05Z"
5+
"version": "2026-01-14T16:16:32Z"
66
},
77
"servers": [
88
{
@@ -3225,6 +3225,144 @@
32253225
}
32263226
}
32273227
},
3228+
"/v1/compacts/{compact}/providers/{providerId}/militaryAudit": {
3229+
"options": {
3230+
"parameters": [
3231+
{
3232+
"name": "compact",
3233+
"in": "path",
3234+
"required": true,
3235+
"schema": {
3236+
"type": "string"
3237+
}
3238+
},
3239+
{
3240+
"name": "providerId",
3241+
"in": "path",
3242+
"required": true,
3243+
"schema": {
3244+
"type": "string"
3245+
}
3246+
}
3247+
],
3248+
"responses": {
3249+
"204": {
3250+
"description": "204 response",
3251+
"headers": {
3252+
"Access-Control-Allow-Origin": {
3253+
"schema": {
3254+
"type": "string"
3255+
}
3256+
},
3257+
"Access-Control-Allow-Methods": {
3258+
"schema": {
3259+
"type": "string"
3260+
}
3261+
},
3262+
"Vary": {
3263+
"schema": {
3264+
"type": "string"
3265+
}
3266+
},
3267+
"Access-Control-Allow-Headers": {
3268+
"schema": {
3269+
"type": "string"
3270+
}
3271+
}
3272+
},
3273+
"content": {}
3274+
}
3275+
}
3276+
},
3277+
"patch": {
3278+
"parameters": [
3279+
{
3280+
"name": "Authorization",
3281+
"in": "header",
3282+
"required": true,
3283+
"schema": {
3284+
"type": "string"
3285+
}
3286+
},
3287+
{
3288+
"name": "compact",
3289+
"in": "path",
3290+
"required": true,
3291+
"schema": {
3292+
"type": "string"
3293+
}
3294+
},
3295+
{
3296+
"name": "providerId",
3297+
"in": "path",
3298+
"required": true,
3299+
"schema": {
3300+
"type": "string"
3301+
}
3302+
}
3303+
],
3304+
"requestBody": {
3305+
"content": {
3306+
"application/json": {
3307+
"schema": {
3308+
"$ref": "#/components/schemas/SandboLicenZnCDqNvEXOu2"
3309+
}
3310+
}
3311+
},
3312+
"required": true
3313+
},
3314+
"responses": {
3315+
"200": {
3316+
"description": "200 response",
3317+
"content": {
3318+
"application/json": {
3319+
"schema": {
3320+
"$ref": "#/components/schemas/SandboLicenTMQQKAeKTKQR"
3321+
}
3322+
}
3323+
}
3324+
}
3325+
},
3326+
"security": [
3327+
{
3328+
"SandboxAPIStackLicenseApiStaffUsersPoolAuthorizer14A84A9B": [
3329+
"aslp/admin",
3330+
"al/aslp.admin",
3331+
"ak/aslp.admin",
3332+
"ar/aslp.admin",
3333+
"co/aslp.admin",
3334+
"de/aslp.admin",
3335+
"ky/aslp.admin",
3336+
"la/aslp.admin",
3337+
"me/aslp.admin",
3338+
"md/aslp.admin",
3339+
"mn/aslp.admin",
3340+
"ms/aslp.admin",
3341+
"mo/aslp.admin",
3342+
"ne/aslp.admin",
3343+
"oh/aslp.admin",
3344+
"octp/admin",
3345+
"al/octp.admin",
3346+
"ar/octp.admin",
3347+
"ky/octp.admin",
3348+
"la/octp.admin",
3349+
"ms/octp.admin",
3350+
"ne/octp.admin",
3351+
"oh/octp.admin",
3352+
"coun/admin",
3353+
"al/coun.admin",
3354+
"ar/coun.admin",
3355+
"fl/coun.admin",
3356+
"ga/coun.admin",
3357+
"ky/coun.admin",
3358+
"ne/coun.admin",
3359+
"oh/coun.admin",
3360+
"ut/coun.admin"
3361+
]
3362+
}
3363+
]
3364+
}
3365+
},
32283366
"/v1/provider-users/me/jurisdiction/{jurisdiction}": {
32293367
"options": {
32303368
"parameters": [
@@ -6420,6 +6558,28 @@
64206558
},
64216559
"components": {
64226560
"schemas": {
6561+
"SandboLicenZnCDqNvEXOu2": {
6562+
"required": [
6563+
"militaryStatus"
6564+
],
6565+
"type": "object",
6566+
"properties": {
6567+
"militaryStatusNote": {
6568+
"maxLength": 5000,
6569+
"type": "string",
6570+
"description": "Optional note from the admin (typically for declines)"
6571+
},
6572+
"militaryStatus": {
6573+
"type": "string",
6574+
"description": "The audit result for the military documentation",
6575+
"enum": [
6576+
"approved",
6577+
"declined"
6578+
]
6579+
}
6580+
},
6581+
"additionalProperties": false
6582+
},
64236583
"SandboLicenudbEF4n02FXU": {
64246584
"required": [
64256585
"newEmailAddress"
@@ -9146,6 +9306,42 @@
91469306
"coun"
91479307
]
91489308
},
9309+
"type": {
9310+
"type": "string",
9311+
"enum": [
9312+
"provider"
9313+
]
9314+
},
9315+
"suffix": {
9316+
"maxLength": 100,
9317+
"minLength": 1,
9318+
"type": "string"
9319+
},
9320+
"dateOfExpiration": {
9321+
"pattern": "^[12]{1}[0-9]{3}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$",
9322+
"type": "string",
9323+
"format": "date"
9324+
},
9325+
"providerId": {
9326+
"pattern": "[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab]{1}[0-9a-f]{3}-[0-9a-f]{12}",
9327+
"type": "string"
9328+
},
9329+
"familyName": {
9330+
"maxLength": 100,
9331+
"minLength": 1,
9332+
"type": "string"
9333+
},
9334+
"birthMonthDay": {
9335+
"pattern": "^[01]{1}[0-9]{1}-[0-3]{1}[0-9]{1}$",
9336+
"type": "string",
9337+
"format": "date"
9338+
},
9339+
"compactConnectRegisteredEmailAddress": {
9340+
"maxLength": 100,
9341+
"minLength": 5,
9342+
"type": "string",
9343+
"format": "email"
9344+
},
91499345
"npi": {
91509346
"pattern": "^[0-9]{10}$",
91519347
"type": "string"
@@ -9242,17 +9438,6 @@
92429438
]
92439439
}
92449440
},
9245-
"type": {
9246-
"type": "string",
9247-
"enum": [
9248-
"provider"
9249-
]
9250-
},
9251-
"suffix": {
9252-
"maxLength": 100,
9253-
"minLength": 1,
9254-
"type": "string"
9255-
},
92569441
"currentHomeJurisdiction": {
92579442
"type": "string",
92589443
"description": "The current jurisdiction postal abbreviation if known.",
@@ -9314,6 +9499,11 @@
93149499
"unknown"
93159500
]
93169501
},
9502+
"militaryStatusNote": {
9503+
"maxLength": 5000,
9504+
"type": "string",
9505+
"description": "Optional note about the military status (typically for declines)"
9506+
},
93179507
"licenses": {
93189508
"type": "array",
93199509
"items": {
@@ -10204,10 +10394,15 @@
1020410394
"pattern": "^[0-9]{4}$",
1020510395
"type": "string"
1020610396
},
10207-
"dateOfExpiration": {
10208-
"pattern": "^[12]{1}[0-9]{3}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$",
10397+
"militaryStatus": {
1020910398
"type": "string",
10210-
"format": "date"
10399+
"description": "Status of military affiliation on the provider record",
10400+
"enum": [
10401+
"notApplicable",
10402+
"tentative",
10403+
"approved",
10404+
"declined"
10405+
]
1021110406
},
1021210407
"militaryAffiliations": {
1021310408
"type": "array",
@@ -10292,38 +10487,18 @@
1029210487
}
1029310488
}
1029410489
},
10295-
"providerId": {
10296-
"pattern": "[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab]{1}[0-9a-f]{3}-[0-9a-f]{12}",
10297-
"type": "string"
10298-
},
1029910490
"licenseStatus": {
1030010491
"type": "string",
1030110492
"enum": [
1030210493
"active",
1030310494
"inactive"
1030410495
]
1030510496
},
10306-
"familyName": {
10307-
"maxLength": 100,
10308-
"minLength": 1,
10309-
"type": "string"
10310-
},
1031110497
"middleName": {
1031210498
"maxLength": 100,
1031310499
"minLength": 1,
1031410500
"type": "string"
1031510501
},
10316-
"birthMonthDay": {
10317-
"pattern": "^[01]{1}[0-9]{1}-[0-3]{1}[0-9]{1}$",
10318-
"type": "string",
10319-
"format": "date"
10320-
},
10321-
"compactConnectRegisteredEmailAddress": {
10322-
"maxLength": 100,
10323-
"minLength": 5,
10324-
"type": "string",
10325-
"format": "email"
10326-
},
1032710502
"dateOfUpdate": {
1032810503
"type": "string",
1032910504
"format": "date-time"
@@ -12489,6 +12664,11 @@
1248912664
"unknown"
1249012665
]
1249112666
},
12667+
"militaryStatusNote": {
12668+
"maxLength": 5000,
12669+
"type": "string",
12670+
"description": "Optional note about the military status (typically for declines)"
12671+
},
1249212672
"ssnLastFour": {
1249312673
"pattern": "^[0-9]{4}$",
1249412674
"type": "string"
@@ -12498,6 +12678,16 @@
1249812678
"type": "string",
1249912679
"format": "date"
1250012680
},
12681+
"militaryStatus": {
12682+
"type": "string",
12683+
"description": "Status of military affiliation on the provider record",
12684+
"enum": [
12685+
"notApplicable",
12686+
"tentative",
12687+
"approved",
12688+
"declined"
12689+
]
12690+
},
1250112691
"providerId": {
1250212692
"pattern": "[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab]{1}[0-9a-f]{3}-[0-9a-f]{12}",
1250312693
"type": "string"

0 commit comments

Comments
 (0)