Skip to content

[SELC- 7329] feat: update API documentation and client to include 'toAddOnAggregates' field for user management #558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 24, 2025
Merged

[SELC- 7329] feat: update API documentation and client to include 'toAddOnAggregates' field for user management #558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0324caf
[SELC- 7329] feat: update API documentation and client to include 'to…
OraldoDoci Sep 24, 2025
e653dac
chore: update @pagopa/selfcare-common-frontend dependency to version …
OraldoDoci Sep 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 132 additions & 5 deletions openApi/dashboard-api-docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi" : "3.0.3",
"info" : {
"title" : "selc-starter-parent",
"title" : "${openapi_title}",
"description" : "Self Care Dashboard API documentation",
"version" : "0.0.1-SNAPSHOT"
},
Expand Down Expand Up @@ -2150,13 +2150,13 @@
"get" : {
"tags" : [ "user-groups" ],
"summary" : "getUserGroups",
"description" : "Service that allows to get a list of UserGroup entities",
"description" : "Service that allows to get a list of UserGroup entities even if you are not member of it",
"operationId" : "getUserGroupsUsingGET",
"parameters" : [ {
"name" : "institutionId",
"in" : "query",
"description" : "Users group's institutionId",
"required" : false,
"required" : true,
"style" : "form",
"schema" : {
"type" : "string"
Expand Down Expand Up @@ -2200,7 +2200,7 @@
"name" : "productId",
"in" : "query",
"description" : "Users group's productId",
"required" : false,
"required" : true,
"style" : "form",
"schema" : {
"type" : "string"
Expand Down Expand Up @@ -2338,6 +2338,123 @@
} ]
}
},
"/v2/user-groups/me" : {
"get" : {
"tags" : [ "user-groups" ],
"summary" : "getMyUserGroups",
"description" : "Service that allows to get a list of UserGroup entities but only if you are member of it",
"operationId" : "getMyUserGroupsUsingGET",
"parameters" : [ {
"name" : "institutionId",
"in" : "query",
"description" : "Users group's institutionId",
"required" : true,
"style" : "form",
"schema" : {
"type" : "string"
}
}, {
"name" : "page",
"in" : "query",
"description" : "The page number to access (0 indexed, defaults to 0)",
"required" : false,
"style" : "form",
"allowReserved" : true,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "size",
"in" : "query",
"description" : "Number of records per page (defaults to 20, max 2000)",
"required" : false,
"style" : "form",
"allowReserved" : true,
"schema" : {
"type" : "integer",
"format" : "int32"
}
}, {
"name" : "sort",
"in" : "query",
"description" : "Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
"required" : false,
"style" : "form",
"allowReserved" : true,
"schema" : {
"type" : "array",
"items" : {
"type" : "string"
}
}
}, {
"name" : "productId",
"in" : "query",
"description" : "Users group's productId",
"required" : true,
"style" : "form",
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
"description" : "OK",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/PageOfUserGroupPlainResource"
}
}
}
},
"400" : {
"description" : "Bad Request",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"401" : {
"description" : "Unauthorized",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"404" : {
"description" : "Not Found",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
},
"security" : [ {
"bearerAuth" : [ "global" ]
} ]
}
},
"/v2/user-groups/me/{id}" : {
"get" : {
"tags" : [ "user-groups" ],
Expand Down Expand Up @@ -3574,6 +3691,11 @@
"taxCode" : {
"type" : "string",
"description" : "User's fiscal code"
},
"toAddOnAggregates" : {
"type" : "boolean",
"description" : "Enabling automatic management of group assignment",
"example" : false
}
}
},
Expand Down Expand Up @@ -4985,6 +5107,11 @@
"role" : {
"type" : "string",
"description" : "User's role, available values: [MANAGER, DELEGATE, SUBDELEGATE, OPERATOR, ADMIN_EA]"
},
"toAddOnAggregates" : {
"type" : "boolean",
"description" : "Enabling automatic management of group assignment",
"example" : false
}
}
},
Expand Down Expand Up @@ -5046,4 +5173,4 @@
}
}
}
}
}
114 changes: 110 additions & 4 deletions openApi/generated-dashboard/dashboard-swagger20.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"swagger": "2.0",
"info": {
"description": "Self Care Dashboard API documentation",
"title": "selc-starter-parent",
"title": "${openapi_title}",
"version": "0.0.1-SNAPSHOT"
},
"host": "localhost:80",
Expand Down Expand Up @@ -1797,7 +1797,7 @@
"description": "Users group's institutionId",
"in": "query",
"name": "institutionId",
"required": false,
"required": true,
"type": "string"
},
{
Expand Down Expand Up @@ -1831,7 +1831,7 @@
"description": "Users group's productId",
"in": "query",
"name": "productId",
"required": false,
"required": true,
"type": "string"
},
{
Expand Down Expand Up @@ -1885,7 +1885,7 @@
"tags": [
"user-groups"
],
"description": "Service that allows to get a list of UserGroup entities",
"description": "Service that allows to get a list of UserGroup entities even if you are not member of it",
"operationId": "getUserGroupsUsingGET",
"summary": "getUserGroups"
}
Expand Down Expand Up @@ -1952,6 +1952,102 @@
"summary": "createUserGroup"
}
},
"/v2/user-groups/me": {
"get": {
"produces": [
"application/json",
"application/problem+json"
],
"parameters": [
{
"description": "Users group's institutionId",
"in": "query",
"name": "institutionId",
"required": true,
"type": "string"
},
{
"description": "The page number to access (0 indexed, defaults to 0)",
"format": "int32",
"in": "query",
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "Number of records per page (defaults to 20, max 2000)",
"format": "int32",
"in": "query",
"name": "size",
"required": false,
"type": "integer"
},
{
"collectionFormat": "multi",
"description": "Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
"in": "query",
"items": {
"type": "string"
},
"name": "sort",
"required": false,
"type": "array"
},
{
"description": "Users group's productId",
"in": "query",
"name": "productId",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PageOfUserGroupPlainResource"
}
},
"400": {
"description": "Bad Request",
"schema": {
"$ref": "#/definitions/Problem"
}
},
"401": {
"description": "Unauthorized",
"schema": {
"$ref": "#/definitions/Problem"
}
},
"404": {
"description": "Not Found",
"schema": {
"$ref": "#/definitions/Problem"
}
},
"500": {
"description": "Internal Server Error",
"schema": {
"$ref": "#/definitions/Problem"
}
}
},
"security": [
{
"bearerAuth": [
"global"
]
}
],
"tags": [
"user-groups"
],
"description": "Service that allows to get a list of UserGroup entities but only if you are member of it",
"operationId": "getMyUserGroupsUsingGET",
"summary": "getMyUserGroups"
}
},
"/v2/user-groups/me/{id}": {
"get": {
"produces": [
Expand Down Expand Up @@ -3050,6 +3146,11 @@
"taxCode": {
"description": "User's fiscal code",
"type": "string"
},
"toAddOnAggregates": {
"description": "Enabling automatic management of group assignment",
"example": false,
"type": "boolean"
}
},
"required": [
Expand Down Expand Up @@ -4613,6 +4714,11 @@
"role": {
"description": "User's role, available values: [MANAGER, DELEGATE, SUBDELEGATE, OPERATOR, ADMIN_EA]",
"type": "string"
},
"toAddOnAggregates": {
"description": "Enabling automatic management of group assignment",
"example": false,
"type": "boolean"
}
},
"title": "UserProductRoles",
Expand Down
2 changes: 1 addition & 1 deletion openApi/generated-onboarding/onboarding-swagger20.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2823,7 +2823,7 @@
}
}
},
"definitions" : {"InstitutionOnboardingResourceArray":{"type": "array", "items": {"$ref": "#/definitions/InstitutionOnboardingResource"}},"InstitutionResourceArray":{"type": "array", "items": {"$ref": "#/definitions/InstitutionResource"}},"ProductResourceArray":{"type": "array", "items": {"$ref": "#/definitions/ProductResource"}},"ProductResourceArray":{"type": "array", "items": {"$ref": "#/definitions/ProductResource"}},"GeographicTaxonomyResourceArray":{"type": "array", "items": {"$ref": "#/definitions/GeographicTaxonomyResource"}},"STRINGWrapper":{"type": "string"},"GeographicTaxonomyResourceArray":{"type": "array", "items": {"$ref": "#/definitions/GeographicTaxonomyResource"}},"STRINGArray":{"type": "array", "items": {"type": "string"}},"InstitutionResourceArray":{"type": "array", "items": {"$ref": "#/definitions/InstitutionResource"}},
"definitions" : {"InstitutionOnboardingResourceArray":{"type": "array", "items": {"$ref": "#/definitions/InstitutionOnboardingResource"}},"InstitutionResourceArray":{"type": "array", "items": {"$ref": "#/definitions/InstitutionResource"}},"ProductResourceArray":{"type": "array", "items": {"$ref": "#/definitions/ProductResource"}},"ProductResourceArray":{"type": "array", "items": {"$ref": "#/definitions/ProductResource"}},"GeographicTaxonomyResourceArray":{"type": "array", "items": {"$ref": "#/definitions/GeographicTaxonomyResource"}},"GeographicTaxonomyResourceArray":{"type": "array", "items": {"$ref": "#/definitions/GeographicTaxonomyResource"}},"STRINGWrapper":{"type": "string"},"STRINGArray":{"type": "array", "items": {"type": "string"}},"InstitutionResourceArray":{"type": "array", "items": {"$ref": "#/definitions/InstitutionResource"}},
"AdditionalInformations": {
"properties": {
"agentOfPublicService": {
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"@mui/x-data-grid": "^5.0.1",
"@mui/x-data-grid-generator": "^5.0.1",
"@pagopa/mui-italia": "^1.7.2",
"@pagopa/selfcare-common-frontend": "^1.34.71",
"@pagopa/selfcare-common-frontend": "^1.34.72",
"@types/react": "^18.2.0",
"@types/react-dom": "^18.2.0",
"@types/react-router-dom": "^5.1.8",
Expand Down Expand Up @@ -108,4 +108,4 @@
"src/api/generated"
]
}
}
}
2 changes: 2 additions & 0 deletions src/api/DashboardApiClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ export const DashboardApi = {
email: (user.certifiedMail ? undefined : user.email) as EmailString,
surname: user.certifiedSurname ? undefined : user.surname,
name: user.certifiedName ? undefined : user.name,
toAddOnAggregates: user.toAddOnAggregates,
},
});
return extractResponse(result, 201, onRedirectToLogin);
Expand All @@ -125,6 +126,7 @@ export const DashboardApi = {
body: {
productRoles: user.productRoles,
role: partyRole,
toAddOnAggregates: user.toAddOnAggregates,
},
});
return extractResponse(result, 201, onRedirectToLogin);
Expand Down
Loading
Loading