Update openapi

pagopa · Sep 27, 2024 · 6997697 · 6997697
1 parent 4070379
commit 6997697
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 22 deletions.
diff --git a/infra/apim_v2/api/ms_internal_api/v1/openapi.prod.json b/infra/apim_v2/api/ms_internal_api/v1/openapi.prod.json
@@ -625,7 +625,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": [
           {
@@ -683,7 +684,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": [
           {

diff --git a/infra/apim_v2/api/selfcare_support_service/v1/openapi.prod.json b/infra/apim_v2/api/selfcare_support_service/v1/openapi.prod.json
@@ -910,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": [
           {
@@ -984,7 +985,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": [
           {
@@ -1042,7 +1044,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": [
           {
@@ -2498,7 +2501,7 @@
             "type": "string"
           },
           "institutionType": {
-            "$ref": "#/components/schemas/InstitutionType"
+            "type": "string"
           },
           "taxCode": {
             "type": "string"
@@ -2571,22 +2574,6 @@
           }
         }
       },
-      "InstitutionType": {
-        "enum": [
-          "PA",
-          "PG",
-          "GSP",
-          "SA",
-          "PT",
-          "SCP",
-          "PSP",
-          "AS",
-          "REC",
-          "CON",
-          "PRV"
-        ],
-        "type": "string"
-      },
       "InstitutionPaSubunitType": {
         "enum": [
           "AOO",
@@ -2840,6 +2827,12 @@
           },
           "origin": {
             "$ref": "#/components/schemas/Origin"
+          },
+          "users": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/UserRequest"
+            }
           }
         }
       },
@@ -2927,6 +2920,22 @@
           }
         }
       },
+      "InstitutionType": {
+        "enum": [
+          "PA",
+          "PG",
+          "GSP",
+          "SA",
+          "PT",
+          "SCP",
+          "PSP",
+          "AS",
+          "REC",
+          "CON",
+          "PRV"
+        ],
+        "type": "string"
+      },
       "BillingRequest1": {
         "type": "object",
         "properties": {