feat: [PAGOPA-1741] get pdf receipt (#2035)

* [PAGOPA-1741] get pdf: updated openapi and pdf receipt service sub key * [PAGOPA-1741] get pdf: typo * fix --------- Co-authored-by: Francesco Cesareo <[email protected]> Co-authored-by: aacitelli <[email protected]> Co-authored-by: pasqualespica <[email protected]>
pagopa · May 20, 2024 · a809c5a · a809c5a
1 parent 9b31213
commit a809c5a
Show file tree

Hide file tree

Showing 5 changed files with 373 additions and 54 deletions.
diff --git a/src/domains/bizevents-app/api/transaction-service/v1/_openapi-jwt.json.tpl b/src/domains/bizevents-app/api/transaction-service/v1/_openapi-jwt.json.tpl
@@ -4,7 +4,7 @@
     "title": "Biz-Events Transaction Service JWT",
     "description": "Microservice for exposing REST APIs about payment transaction.",
     "termsOfService": "https://www.pagopa.gov.it/",
-    "version": "0.1.24"
+    "version": "0.1.26"
   },
   "servers" : [ {
     "url": "${host}/bizevents/bizevents/tx-service-jwt/v1",
@@ -361,6 +361,132 @@
         }
       } ]
     },
+    "/transactions/{event-id}/pdf" : {
+      "get" : {
+        "tags" : [ "IO Transactions REST APIs" ],
+        "summary" : "Retrieve the PDF receipt given event id.",
+        "operationId" : "getPDFReceipt",
+        "parameters" : [ {
+          "name" : "x-fiscal-code",
+          "in" : "header",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        }, {
+          "name" : "event-id",
+          "in" : "path",
+          "description" : "The id of the event.",
+          "required" : true,
+          "schema" : {
+            "type" : "string"
+          }
+        } ],
+        "responses" : {
+          "429" : {
+            "description" : "Too many requests.",
+            "headers" : {
+              "X-Request-Id" : {
+                "description" : "This header identifies the call",
+                "schema" : {
+                  "type" : "string"
+                }
+              }
+            }
+          },
+          "422" : {
+            "description" : "Unprocessable recipt.",
+            "headers" : {
+              "X-Request-Id" : {
+                "description" : "This header identifies the call",
+                "schema" : {
+                  "type" : "string"
+                }
+              }
+            },
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/ProblemJson"
+                }
+              }
+            }
+          },
+          "404" : {
+            "description" : "Not found the receipt.",
+            "headers" : {
+              "X-Request-Id" : {
+                "description" : "This header identifies the call",
+                "schema" : {
+                  "type" : "string"
+                }
+              }
+            },
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/ProblemJson"
+                }
+              }
+            }
+          },
+          "500" : {
+            "description" : "Service unavailable.",
+            "headers" : {
+              "X-Request-Id" : {
+                "description" : "This header identifies the call",
+                "schema" : {
+                  "type" : "string"
+                }
+              }
+            },
+            "content" : {
+              "application/json" : {
+                "schema" : {
+                  "$ref" : "#/components/schemas/ProblemJson"
+                }
+              }
+            }
+          },
+          "200" : {
+            "description" : "Obtained the PDF receipt.",
+            "headers" : {
+              "X-Request-Id" : {
+                "description" : "This header identifies the call",
+                "schema" : {
+                  "type" : "string"
+                }
+              }
+            },
+            "content" : {
+              "application/pdf" : { }
+            }
+          },
+          "401" : {
+            "description" : "Wrong or missing function key.",
+            "headers" : {
+              "X-Request-Id" : {
+                "description" : "This header identifies the call",
+                "schema" : {
+                  "type" : "string"
+                }
+              }
+            }
+          }
+        },
+        "security" : [ {
+          "Authorization" : [ ]
+        } ]
+      },
+      "parameters" : [ {
+        "name" : "X-Request-Id",
+        "in" : "header",
+        "description" : "This header identifies the call, if not passed it is self-generated. This ID is returned in the response.",
+        "schema" : {
+          "type" : "string"
+        }
+      } ]
+    },
     "/info" : {
       "get" : {
         "tags" : [ "Home" ],
@@ -514,6 +640,9 @@
           },
           "isCart" : {
             "type" : "boolean"
+          },
+          "isPayer" : {
+            "type" : "boolean"
           }
         }
       },