Skip to content

Commit cb77b49

Browse files
[Update OpenAPI] Merge openapi dev using openapi-merge-cli (#1011)
Co-authored-by: pierpaolodidato89 <137791912+pierpaolodidato89@users.noreply.github.com>
1 parent f6a38d6 commit cb77b49

File tree

1 file changed

+46
-11
lines changed

1 file changed

+46
-11
lines changed

infra/apim_v2/api/selfcare_support_service/v1/openapi.dev.json

Lines changed: 46 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2435,20 +2435,30 @@
24352435
"title": "OnboardingInstitutionUsersRequest",
24362436
"type": "object",
24372437
"properties": {
2438+
"institutionId": {
2439+
"type": "string",
2440+
"description": "The institution ID where users will be added. This takes precedence over the tax code"
2441+
},
24382442
"institutionSubunitCode": {
2439-
"type": "string"
2443+
"type": "string",
2444+
"description": "Add users to the institution via subunit code. Can be used in combination with institutionTaxCode"
24402445
},
24412446
"institutionTaxCode": {
2442-
"type": "string"
2447+
"type": "string",
2448+
"description": "Add users to the institution via tax code. Can be used in combination with institutionSubunitCode"
24432449
},
24442450
"productId": {
2445-
"type": "string"
2451+
"type": "string",
2452+
"description": "Product to add roles to"
24462453
},
24472454
"sendCreateUserNotificationEmail": {
2448-
"type": "boolean"
2455+
"type": "boolean",
2456+
"description": "Send an email notification to the user. By default it's set to true",
2457+
"example": false
24492458
},
24502459
"users": {
24512460
"type": "array",
2461+
"description": "List of users to add",
24522462
"items": {
24532463
"$ref": "#/components/schemas/Person"
24542464
}
@@ -2460,10 +2470,12 @@
24602470
"type": "object",
24612471
"properties": {
24622472
"email": {
2463-
"type": "string"
2473+
"type": "string",
2474+
"description": "The email address of the user to add / create. If id is present, the field is ignored"
24642475
},
24652476
"env": {
24662477
"type": "string",
2478+
"description": "Environment. The field is currently not used to create users. It's only returned in response",
24672479
"enum": [
24682480
"COLL",
24692481
"DEV",
@@ -2472,16 +2484,20 @@
24722484
]
24732485
},
24742486
"id": {
2475-
"type": "string"
2487+
"type": "string",
2488+
"description": "User ID of a user already in the registry. A role will be added to the institution/product for the user. It takes precedence over taxCode"
24762489
},
24772490
"name": {
2478-
"type": "string"
2491+
"type": "string",
2492+
"description": "The name of the user to add / create. If id is present, the field is ignored"
24792493
},
24802494
"productRole": {
2481-
"type": "string"
2495+
"type": "string",
2496+
"description": "The product role to assign to the user based on the product specifications"
24822497
},
24832498
"role": {
24842499
"type": "string",
2500+
"description": "The role to assign to the user",
24852501
"enum": [
24862502
"ADMIN_EA",
24872503
"DELEGATE",
@@ -2491,13 +2507,20 @@
24912507
]
24922508
},
24932509
"roleLabel": {
2494-
"type": "string"
2510+
"type": "string",
2511+
"description": "The product role label based on the product specifications. The field is currently not used to create users"
24952512
},
24962513
"surname": {
2497-
"type": "string"
2514+
"type": "string",
2515+
"description": "The surname of the user to add / create. If id is present, the field is ignored"
24982516
},
24992517
"taxCode": {
2500-
"type": "string"
2518+
"type": "string",
2519+
"description": "The tax code of the user to add / create. If id is present, the field is ignored"
2520+
},
2521+
"userMailUuid": {
2522+
"type": "string",
2523+
"description": "The email ID of the user already in the registry to be assigned to the institution/product. This field is only used when adding a user by ID"
25012524
}
25022525
}
25032526
},
@@ -3092,6 +3115,12 @@
30923115
},
30933116
"dataProtectionOfficer": {
30943117
"$ref": "#/components/schemas/DataProtectionOfficerRequest1"
3118+
},
3119+
"atecoCodes": {
3120+
"type": "array",
3121+
"items": {
3122+
"type": "string"
3123+
}
30953124
}
30963125
}
30973126
},
@@ -3486,6 +3515,12 @@
34863515
},
34873516
"imported": {
34883517
"type": "boolean"
3518+
},
3519+
"atecoCodes": {
3520+
"type": "array",
3521+
"items": {
3522+
"type": "string"
3523+
}
34893524
}
34903525
}
34913526
},

0 commit comments

Comments
 (0)