[Update OpenAPI] Merge openapi dev using openapi-merge-cli (#374)

Co-authored-by: manuraf <[email protected]>
pagopa · Sep 20, 2024 · 263a705 · 263a705
1 parent 29ccb3c
commit 263a705
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 14 deletions.
diff --git a/infra/apim_v2/api/ms_internal_api/v1/openapi.dev.json b/infra/apim_v2/api/ms_internal_api/v1/openapi.dev.json
@@ -236,7 +236,8 @@
         "tags": [
           "User"
         ],
-        "summary": "Update user status with optional filter for institution, product, role and productRole",
+        "summary": "Update a user's product status with optional filters",
+        "description": "Update user status with optional filter for institution, product, role and productRole",
         "operationId": "updateUserStatusUsingPUT",
         "parameters": [
           {
@@ -624,8 +625,9 @@
     "/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.",
-        "operationId": "completeOnboardingUsingPUT",
+        "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": "complete",
         "parameters": [
           {
             "name": "onboardingId",
@@ -682,8 +684,9 @@
         "tags": [
           "Onboarding"
         ],
-        "summary": "Perform complete operation of an onboarding request as /complete but without signature verification of the contract",
-        "operationId": "completeOnboardingTokenConsume",
+        "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": "consume",
         "parameters": [
           {
             "name": "onboardingId",

diff --git a/infra/apim_v2/api/selfcare_support_service/v1/openapi.dev.json b/infra/apim_v2/api/selfcare_support_service/v1/openapi.dev.json
@@ -274,7 +274,8 @@
         "tags": [
           "Institution"
         ],
-        "summary": "The API retrieves user's info including details of roles on products",
+        "summary": "Retrieve user's information including product role details",
+        "description": "Fetches detailed information about users associated with a specific institution, including their roles on various products. This endpoint is useful for administrators to obtain comprehensive user-role mappings within an institution.",
         "operationId": "getInstitutionUsersUsingGET",
         "parameters": [
           {
@@ -355,7 +356,8 @@
         "tags": [
           "User"
         ],
-        "summary": "Retrieves user given userId and optional ProductId",
+        "summary": "Retrieve user information by userId and optional ProductId",
+        "description": "Retrieves user given userId and optional ProductId",
         "operationId": "getUserInfoUsingGET",
         "parameters": [
           {
@@ -908,7 +910,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,8 +985,9 @@
         "tags": [
           "Onboarding"
         ],
-        "summary": "Perform complete operation of an onboarding request as /complete but without signature verification of the contract",
-        "operationId": "completeOnboardingTokenConsume",
+        "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": "consume",
         "parameters": [
           {
             "name": "onboardingId",
@@ -1040,8 +1044,9 @@
         "tags": [
           "Onboarding"
         ],
-        "summary": "Update onboarding request receiving onboarding id.Function can change some values. ",
-        "operationId": "updateOnboardiUsingPUT",
+        "summary": "Update onboarding request with new values.",
+        "description": "Update onboarding request receiving onboarding id.Function can change some values.",
+        "operationId": "update",
         "parameters": [
           {
             "name": "onboardingId",

diff --git a/infra/apim_v2/api_pnpg/pnpg_support_service/v1/openapi.dev.json b/infra/apim_v2/api_pnpg/pnpg_support_service/v1/openapi.dev.json
@@ -121,7 +121,8 @@
         "tags": [
           "Institution"
         ],
-        "summary": "The API retrieves user's info including details of roles on products",
+        "summary": "Retrieve user's information including product role details",
+        "description": "Fetches detailed information about users associated with a specific institution, including their roles on various products. This endpoint is useful for administrators to obtain comprehensive user-role mappings within an institution.",
         "operationId": "getInstitutionUsersUsingGET",
         "parameters": [
           {
@@ -202,7 +203,8 @@
         "tags": [
           "User"
         ],
-        "summary": "Retrieves user given userId and optional ProductId",
+        "summary": "Retrieve user information by userId and optional ProductId",
+        "description": "Retrieves user given userId and optional ProductId",
         "operationId": "getUserInfoUsingGET",
         "parameters": [
           {