From 48ca960583a77dca13e43c4f679cf53db51577e3 Mon Sep 17 00:00:00 2001 From: selfcare-github-bot <146744076+selfcare-github-bot@users.noreply.github.com> Date: Fri, 20 Sep 2024 17:12:53 +0200 Subject: [PATCH] [Update OpenAPI] Merge openapi uat using openapi-merge-cli (#377) Co-authored-by: manuraf <12083207+manuraf@users.noreply.github.com> --- .../api/ms_internal_api/v1/openapi.uat.json | 34 +---- .../v1/openapi.uat.json | 77 ++++------ .../external_api_for_pnpg/v2/openapi.uat.json | 14 +- .../pnpg_support_service/v1/openapi.uat.json | 140 ++++++++++++++++-- 4 files changed, 165 insertions(+), 100 deletions(-) diff --git a/infra/apim_v2/api/ms_internal_api/v1/openapi.uat.json b/infra/apim_v2/api/ms_internal_api/v1/openapi.uat.json index ca664c85..6a260ccb 100644 --- a/infra/apim_v2/api/ms_internal_api/v1/openapi.uat.json +++ b/infra/apim_v2/api/ms_internal_api/v1/openapi.uat.json @@ -624,7 +624,8 @@ "/onboarding/{onboardingId}/complete": { "put": { "tags": [], - "summary": "Perform complete operation of an onboarding request receiving onboarding id and contract signed by the institution.It checks the contract's signature and upload the contract on an azure storageAt the end, function triggers async activities related to complete onboarding that consist of create the institution, activate the onboarding and sending data to notification queue.", + "summary": "Complete onboarding by verifying and uploading contract, then trigger async activities.", + "description": "Perform complete operation of an onboarding request receiving onboarding id and contract signed by the institution.It checks the contract's signature and upload the contract on an azure storageAt the end, function triggers async activities related to complete onboarding that consist of create the institution, activate the onboarding and sending data to notification queue.", "operationId": "completeOnboardingUsingPUT", "parameters": [ { @@ -682,7 +683,8 @@ "tags": [ "Onboarding" ], - "summary": "Perform complete operation of an onboarding request as /complete but without signature verification of the contract", + "summary": "Complete onboarding without verifying contract signature.", + "description": "Perform complete operation of an onboarding request as /complete but without signature verification of the contract", "operationId": "completeOnboardingTokenConsume", "parameters": [ { @@ -771,19 +773,7 @@ "type": "string" }, "institutionType": { - "type": "string", - "enum": [ - "AS", - "CON", - "GSP", - "PA", - "PG", - "PSP", - "PT", - "REC", - "SA", - "SCP" - ] + "type": "string" }, "productId": { "type": "string" @@ -965,19 +955,7 @@ "type": "boolean" }, "institutionType": { - "type": "string", - "enum": [ - "AS", - "CON", - "GSP", - "PA", - "PG", - "PSP", - "PT", - "REC", - "SA", - "SCP" - ] + "type": "string" }, "istatCode": { "type": "string" diff --git a/infra/apim_v2/api/selfcare_support_service/v1/openapi.uat.json b/infra/apim_v2/api/selfcare_support_service/v1/openapi.uat.json index 223fba92..4b385e7c 100644 --- a/infra/apim_v2/api/selfcare_support_service/v1/openapi.uat.json +++ b/infra/apim_v2/api/selfcare_support_service/v1/openapi.uat.json @@ -908,7 +908,8 @@ "tags": [ "Onboarding" ], - "summary": "Returns onboardings record by institution taxCode/subunitCode/origin/originId", + "summary": "Get onboardings by institution taxCode, subunitCode, origin, or originId.", + "description": "Returns onboardings record by institution taxCode/subunitCode/origin/originId", "operationId": "onboardingInstitutionUsingGET", "parameters": [ { @@ -982,7 +983,8 @@ "tags": [ "Onboarding" ], - "summary": "Perform complete operation of an onboarding request as /complete but without signature verification of the contract", + "summary": "Complete onboarding without verifying contract signature.", + "description": "Perform complete operation of an onboarding request as /complete but without signature verification of the contract", "operationId": "completeOnboardingTokenConsume", "parameters": [ { @@ -1040,7 +1042,8 @@ "tags": [ "Onboarding" ], - "summary": "Update onboarding request receiving onboarding id.Function can change some values. ", + "summary": "Update onboarding request with new values.", + "description": "Update onboarding request receiving onboarding id.Function can change some values.", "operationId": "updateOnboardiUsingPUT", "parameters": [ { @@ -1283,19 +1286,7 @@ "type": "string" }, "institutionType": { - "type": "string", - "enum": [ - "AS", - "CON", - "GSP", - "PA", - "PG", - "PSP", - "PT", - "REC", - "SA", - "SCP" - ] + "type": "string" }, "productId": { "type": "string" @@ -1454,19 +1445,7 @@ "type": "boolean" }, "institutionType": { - "type": "string", - "enum": [ - "AS", - "CON", - "GSP", - "PA", - "PG", - "PSP", - "PT", - "REC", - "SA", - "SCP" - ] + "type": "string" }, "istatCode": { "type": "string" @@ -2520,7 +2499,7 @@ "type": "string" }, "institutionType": { - "$ref": "#/components/schemas/InstitutionType" + "type": "string" }, "taxCode": { "type": "string" @@ -2593,22 +2572,6 @@ } } }, - "InstitutionType": { - "enum": [ - "PA", - "PG", - "GSP", - "SA", - "PT", - "SCP", - "PSP", - "AS", - "REC", - "CON", - "PRV" - ], - "type": "string" - }, "InstitutionPaSubunitType": { "enum": [ "AOO", @@ -2862,6 +2825,12 @@ }, "origin": { "$ref": "#/components/schemas/Origin" + }, + "users": { + "type": "array", + "items": { + "$ref": "#/components/schemas/UserRequest" + } } } }, @@ -2949,6 +2918,22 @@ } } }, + "InstitutionType": { + "enum": [ + "PA", + "PG", + "GSP", + "SA", + "PT", + "SCP", + "PSP", + "AS", + "REC", + "CON", + "PRV" + ], + "type": "string" + }, "BillingRequest1": { "type": "object", "properties": { diff --git a/infra/apim_v2/api_pnpg/external_api_for_pnpg/v2/openapi.uat.json b/infra/apim_v2/api_pnpg/external_api_for_pnpg/v2/openapi.uat.json index 0008440e..fd5f63f0 100644 --- a/infra/apim_v2/api_pnpg/external_api_for_pnpg/v2/openapi.uat.json +++ b/infra/apim_v2/api_pnpg/external_api_for_pnpg/v2/openapi.uat.json @@ -775,19 +775,7 @@ "type": "boolean" }, "institutionType": { - "type": "string", - "enum": [ - "AS", - "CON", - "GSP", - "PA", - "PG", - "PSP", - "PT", - "REC", - "SA", - "SCP" - ] + "type": "string" }, "istatCode": { "type": "string" diff --git a/infra/apim_v2/api_pnpg/pnpg_support_service/v1/openapi.uat.json b/infra/apim_v2/api_pnpg/pnpg_support_service/v1/openapi.uat.json index 69827832..c539ea61 100644 --- a/infra/apim_v2/api_pnpg/pnpg_support_service/v1/openapi.uat.json +++ b/infra/apim_v2/api_pnpg/pnpg_support_service/v1/openapi.uat.json @@ -197,6 +197,98 @@ ] } }, + "/users/{id}": { + "get": { + "tags": [ + "User" + ], + "summary": "Retrieves user given userId and optional ProductId", + "operationId": "getUserInfoUsingGET", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "institutionId", + "in": "query", + "schema": { + "type": "string" + } + }, + { + "name": "productId", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UserResponse" + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/Problem1" + } + } + } + }, + "401": { + "description": "Not Authorized", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/Problem1" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/Problem1" + } + } + } + }, + "404": { + "description": "Not Found", + "content": { + "application/problem+json": { + "schema": { + "$ref": "#/components/schemas/Problem1" + } + } + } + } + }, + "security": [ + { + "bearerAuth": [ + "global" + ] + } + ] + } + }, "/national-registries/legal-tax/verification": { "post": { "tags": [ @@ -584,19 +676,7 @@ "type": "boolean" }, "institutionType": { - "type": "string", - "enum": [ - "AS", - "CON", - "GSP", - "PA", - "PG", - "PSP", - "PT", - "REC", - "SA", - "SCP" - ] + "type": "string" }, "istatCode": { "type": "string" @@ -956,6 +1036,40 @@ } } }, + "UserResponse": { + "required": [ + "id", + "name", + "surname" + ], + "type": "object", + "properties": { + "id": { + "minLength": 1, + "type": "string" + }, + "taxCode": { + "type": "string" + }, + "name": { + "pattern": "\\S", + "type": "string" + }, + "surname": { + "pattern": "\\S", + "type": "string" + }, + "email": { + "type": "string" + }, + "workContacts": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, "LegalVerificationResource": { "title": "LegalVerificationResource", "type": "object",