Skip to content
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

Jump to bottom

Fix: Add retrieve backoffice to v2 #715

Merged
merged 1 commit into from
Apr 15, 2024
Merged

Fix: Add retrieve backoffice to v2 #715

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
233 changes: 218 additions & 15 deletions openApi/dashboard-api-docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1286,7 +1286,7 @@
"tags" : [ "institutions" ],
"summary" : "getInstitutions",
"description" : "Service to get all the institutions related to logged user",
"operationId" : "getInstitutionsUsingGET_1",
"operationId" : "v2RetrieveUserInstitutions",
"parameters" : [ {
"name" : "authenticated",
"in" : "query",
Expand Down Expand Up @@ -1391,9 +1391,9 @@
"/v2/institutions/{institutionId}" : {
"get" : {
"tags" : [ "institutions" ],
"summary" : "getInstitution",
"summary" : "Service to get a specific institution related to logged user",
"description" : "Service to get a specific institution related to logged user",
"operationId" : "getInstitutionUsingGET_1",
"operationId" : "v2GetInstitution",
"parameters" : [ {
"name" : "institutionId",
"in" : "path",
Expand Down Expand Up @@ -1461,12 +1461,176 @@
} ]
}
},
"/v2/institutions/{institutionId}/products/{productId}/users" : {
"post" : {
"tags" : [ "institutions" ],
"summary" : "createInstitutionProductUser",
"description" : "Service to Create a user related to a specific pair of institution-product",
"operationId" : "v2PostCreateInstitutionProductUser",
"parameters" : [ {
"name" : "institutionId",
"in" : "path",
"description" : "Institution's unique internal identifier",
"required" : true,
"style" : "simple",
"schema" : {
"type" : "string"
}
}, {
"name" : "productId",
"in" : "path",
"description" : "Product's unique identifier",
"required" : true,
"style" : "simple",
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/CreateUserDto"
}
}
}
},
"responses" : {
"201" : {
"description" : "Created",
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserIdResource"
}
}
}
},
"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"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
},
"security" : [ {
"bearerAuth" : [ "global" ]
} ]
}
},
"/v2/institutions/{institutionId}/products/{productId}/users/{userId}" : {
"put" : {
"tags" : [ "institutions" ],
"summary" : "addUserProductRoles",
"description" : "Service to add a new role/product to a specific user",
"operationId" : "v2AddUserProductRole",
"parameters" : [ {
"name" : "institutionId",
"in" : "path",
"description" : "Institution's unique internal identifier",
"required" : true,
"style" : "simple",
"schema" : {
"type" : "string"
}
}, {
"name" : "productId",
"in" : "path",
"description" : "Product's unique identifier",
"required" : true,
"style" : "simple",
"schema" : {
"type" : "string"
}
}, {
"name" : "userId",
"in" : "path",
"description" : "User's unique identifier",
"required" : true,
"style" : "simple",
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/UserProductRoles"
}
}
}
},
"responses" : {
"201" : {
"description" : "Created"
},
"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"
}
}
}
},
"500" : {
"description" : "Internal Server Error",
"content" : {
"application/problem+json" : {
"schema" : {
"$ref" : "#/components/schemas/Problem"
}
}
}
}
},
"security" : [ {
"bearerAuth" : [ "global" ]
} ]
}
},
"/v2/institutions/{institutionId}/users/{userId}" : {
"get" : {
"tags" : [ "institutions" ],
"summary" : "getInstitutionUser",
"description" : "Service to get the users with the given user id related to a specific institution",
"operationId" : "getInstitutionUserUsingGET_1",
"operationId" : "v2RetrieveInstitutionUser",
"parameters" : [ {
"name" : "authenticated",
"in" : "query",
Expand Down Expand Up @@ -2104,9 +2268,9 @@
"/v2/products/{productId}/back-office" : {
"get" : {
"tags" : [ "products" ],
"summary" : "retrieveProductBackoffice",
"summary" : "Service to trigger token exchange and redirect to product's back office URL",
"description" : "Service to trigger token exchange and redirect to product's back office URL",
"operationId" : "retrieveProductBackofficeUsingGET_1",
"operationId" : "v2RetrieveProductBackofficeUsingGET",
"parameters" : [ {
"name" : "productId",
"in" : "path",
Expand Down Expand Up @@ -2745,9 +2909,9 @@
"/v2/token/exchange" : {
"get" : {
"tags" : [ "token" ],
"summary" : "exchange",
"summary" : "Service create an 'Identity Token' based on a Self Care session token",
"description" : "Service create an 'Identity Token' based on a Self Care session token",
"operationId" : "exchangeUsingGET_1",
"operationId" : "v2Exchange",
"parameters" : [ {
"name" : "institutionId",
"in" : "query",
Expand Down Expand Up @@ -4610,7 +4774,7 @@
"tags" : [ "user" ],
"summary" : "getUsers",
"description" : "Service to get all the users related to a specific institution",
"operationId" : "getUsersUsingGET",
"operationId" : "v2GetUsersUsingGET",
"parameters" : [ {
"name" : "authenticated",
"in" : "query",
Expand Down Expand Up @@ -4669,6 +4833,16 @@
"schema" : {
"type" : "string"
}
}, {
"name" : "productRoles",
"in" : "query",
"description" : "productRoles",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
Expand Down Expand Up @@ -4735,7 +4909,17 @@
"tags" : [ "user" ],
"summary" : "search",
"description" : "Retrieve the user for a given fiscal code",
"operationId" : "searchUsingPOST_1",
"operationId" : "v2SearchUserByFiscalCodeUsingPOST",
"parameters" : [ {
"name" : "institutionId",
"in" : "query",
"description" : "Institution's unique internal identifier",
"required" : true,
"style" : "form",
"schema" : {
"type" : "string"
}
} ],
"requestBody" : {
"content" : {
"application/json" : {
Expand Down Expand Up @@ -4807,7 +4991,7 @@
"tags" : [ "user" ],
"summary" : "getUserById",
"description" : "Retrieve the user by internal id",
"operationId" : "getUserByIdUsingGET",
"operationId" : "v2GetUserByIdUsingGET",
"parameters" : [ {
"name" : "id",
"in" : "path",
Expand All @@ -4817,6 +5001,25 @@
"schema" : {
"type" : "string"
}
}, {
"name" : "institutionId",
"in" : "query",
"description" : "Institution's unique internal identifier",
"required" : true,
"style" : "form",
"schema" : {
"type" : "string"
}
}, {
"name" : "fields",
"in" : "query",
"description" : "Fields to retrieve from pdv when searching for user",
"required" : false,
"style" : "form",
"explode" : true,
"schema" : {
"type" : "string"
}
} ],
"responses" : {
"200" : {
Expand Down Expand Up @@ -4878,7 +5081,7 @@
"tags" : [ "user" ],
"summary" : "updateUser",
"description" : "Update previously added user",
"operationId" : "updateUserUsingPUT_1",
"operationId" : "v2UpdateUserUsingPUT",
"parameters" : [ {
"name" : "id",
"in" : "path",
Expand Down Expand Up @@ -4952,7 +5155,7 @@
"tags" : [ "user" ],
"summary" : "deleteRelationshipById",
"description" : "Delete the relationship",
"operationId" : "deleteRelationshipByIdUsingDELETE_1",
"operationId" : "v2DeleteRelationshipByIdUsingDELETE",
"parameters" : [ {
"name" : "userId",
"in" : "path",
Expand Down Expand Up @@ -5026,7 +5229,7 @@
"tags" : [ "user" ],
"summary" : "activateRelationship",
"description" : "Activate the relationship",
"operationId" : "activateRelationshipUsingPOST_1",
"operationId" : "v2ActivateRelationshipUsingPOST",
"parameters" : [ {
"name" : "userId",
"in" : "path",
Expand Down Expand Up @@ -5100,7 +5303,7 @@
"tags" : [ "user" ],
"summary" : "suspendRelationship",
"description" : "Suspend the relationship",
"operationId" : "suspendRelationshipUsingPOST_1",
"operationId" : "v2SuspendRelationshipUsingPOST",
"parameters" : [ {
"name" : "userId",
"in" : "path",
Expand Down
Loading
Loading