fix: Add new url for messageAcknowledge (#468)

pagopa · Oct 29, 2024 · 4ab1f42 · 4ab1f42
1 parent 3b30c58
commit 4ab1f42
Show file tree

Hide file tree

Showing 5 changed files with 165 additions and 33 deletions.
diff --git a/infra/apim_v2/api/api_key_fn_op_policy_message.xml.tpl b/infra/apim_v2/api/api_key_fn_op_policy_message.xml.tpl
@@ -0,0 +1,31 @@
+<policies>
+    <inbound>
+        <base/>
+        <choose>
+            <when condition="@(((string)context.Product.Id).Contains(" prod-fd"))">
+                <validate-jwt header-name="Authorization" failed-validation-httpcode="401"
+                              failed-validation-error-message="Unauthorized" require-expiration-time="false"
+                              require-scheme="Bearer" require-signed-tokens="true">
+                    <openid-config url="https://login.microsoftonline.com/${TENANT_ID}/.well-known/openid-configuration"/>
+                    <required-claims>
+                        <claim name="aud" match="all">
+                            <value>${EXTERNAL-OAUTH2-ISSUER}</value>
+                        </claim>
+                    </required-claims>
+                </validate-jwt>
+            </when>
+        </choose>
+        <set-variable name="fnkey" value="${FN_KEY}"/>
+        <set-header name="X-FUNCTIONS-KEY" exists-action="override">
+            <value>@((string)context.Variables["fnkey"])</value>
+        </set-header>
+        <set-backend-service base-url="${BACKEND_BASE_URL}"/>
+        <rewrite-uri template="@("/api/acknowledgment/" + (string)context.Variables["productId"] + "/message/{messageId}/status/{status}")" />
+    </inbound>
+    <backend>
+    <base/>
+    </backend>
+    <on-error>
+    <base/>
+    </on-error>
+</policies>
diff --git a/infra/apim_v2/api/ms_external_api/v2/openapi.dev.json b/infra/apim_v2/api/ms_external_api/v2/openapi.dev.json
@@ -1387,7 +1387,7 @@
         ]
       }
     },
-    "/api/acknowledgment/{productId}/message/{messageId}/status/{status}": {
+    "/message/{messageId}/status/{status}": {
       "post": {
         "tags": [],
         "summary": "messageAcknowledgment",

diff --git a/infra/apim_v2/api/ms_external_api/v2/openapi.prod.json b/infra/apim_v2/api/ms_external_api/v2/openapi.prod.json
@@ -487,7 +487,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": [
           {
@@ -1385,10 +1386,118 @@
           }
         ]
       }
+    },
+    "/message/{messageId}/status/{status}": {
+      "post": {
+        "tags": [],
+        "summary": "messageAcknowledgment",
+        "description": "Service to acknowledge message consumption by a consumer",
+        "operationId": "messageAcknowledgmentUsingPOST",
+        "parameters": [
+          {
+            "name": "productId",
+            "in": "path",
+            "description": "Product's unique identifier",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "messageId",
+            "in": "path",
+            "description": "Kafka message unique identifier",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "status",
+            "in": "path",
+            "description": "Kafka message consumption acknowledgment status",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "enum": [
+                "ACK",
+                "NACK"
+              ]
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/AckPayloadRequest"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK"
+          },
+          "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"
+            ]
+          }
+        ]
+      }
     }
   },
   "components": {
     "schemas": {
+      "AckPayloadRequest": {
+        "title": "AckPayloadRequest",
+        "required": [
+          "message"
+        ],
+        "type": "object",
+        "properties": {
+          "message": {
+            "type": "string",
+            "description": "Acknowledgment request payload message"
+          }
+        }
+      },
       "DelegationResponse": {
         "title": "DelegationResponse",
         "type": "object",
@@ -1422,19 +1531,7 @@
             "type": "string"
           },
           "institutionType": {
-            "type": "string",
-            "enum": [
-              "AS",
-              "CON",
-              "GSP",
-              "PA",
-              "PG",
-              "PSP",
-              "PT",
-              "REC",
-              "SA",
-              "SCP"
-            ]
+            "type": "string"
           },
           "productId": {
             "type": "string"
@@ -1593,19 +1690,7 @@
             "type": "boolean"
           },
           "institutionType": {
-            "type": "string",
-            "enum": [
-              "AS",
-              "CON",
-              "GSP",
-              "PA",
-              "PG",
-              "PSP",
-              "PT",
-              "REC",
-              "SA",
-              "SCP"
-            ]
+            "type": "string"
           },
           "istatCode": {
             "type": "string"
@@ -2010,6 +2095,12 @@
           "multiroleAllowed": {
             "type": "boolean"
           },
+          "phasesAdditionAllowed": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
           "roles": {
             "type": "array",
             "items": {
@@ -2030,6 +2121,9 @@
           },
           "label": {
             "type": "string"
+          },
+          "productLabel": {
+            "type": "string"
           }
         }
       },
@@ -2360,6 +2454,10 @@
             "type": "string",
             "description": "The specific role of the user related to the product."
           },
+          "productRoleLabel": {
+            "type": "string",
+            "description": "The specific role label of the user related to the product."
+          },
           "role": {
             "type": "string",
             "description": "Available values: MANAGER, DELEGATE, SUB_DELEGATE, OPERATOR, ADMIN_EA"
@@ -2693,7 +2791,8 @@
             "description": "Institution's share capital value"
           }
         }
-      },"DpoDataResource": {
+      },
+      "DpoDataResource": {
         "title": "DpoDataResource",
         "type": "object",
         "properties": {

diff --git a/infra/apim_v2/api/ms_external_api/v2/openapi.uat.json b/infra/apim_v2/api/ms_external_api/v2/openapi.uat.json
@@ -1387,7 +1387,7 @@
         ]
       }
     },
-    "/api/acknowledgment/{productId}/message/{messageId}/status/{status}": {
+    "/message/{messageId}/status/{status}": {
       "post": {
         "tags": [],
         "summary": "messageAcknowledgment",

diff --git a/infra/apim_v2/apim.tf b/infra/apim_v2/apim.tf
@@ -400,9 +400,11 @@ module "apim_external_api_ms_v2" {
     },
     {
       operation_id = "messageAcknowledgmentUsingPOST"
-      xml_content = templatefile("./api/api_key_fn_op_policy.xml.tpl", {
-        BACKEND_BASE_URL = "https://selc-${var.env_short}-onboarding-fn.azurewebsites.net"
-        FN_KEY           = data.azurerm_key_vault_secret.fn-onboarding-primary-key.value
+      xml_content = templatefile("./api/api_key_fn_op_policy_message.xml.tpl", {
+        BACKEND_BASE_URL           = "https://selc-${var.env_short}-onboarding-fn.azurewebsites.net"
+        FN_KEY                     = data.azurerm_key_vault_secret.fn-onboarding-primary-key.value
+        EXTERNAL-OAUTH2-ISSUER     = data.azurerm_key_vault_secret.external-oauth2-issuer.value
+        TENANT_ID                  = data.azurerm_client_config.current.tenant_id
       })
     }
   ]