Update gpd_payments.yaml

pagopa · Nov 22, 2024 · b533476 · b533476
1 parent 895817a
commit b533476
Showing 1 changed file with 30 additions and 31 deletions.
diff --git a/openapi/gpd_payments.yaml b/openapi/gpd_payments.yaml
@@ -4,11 +4,11 @@
     "title": "PagoPA API Payments",
     "description": "Payments",
     "termsOfService": "https://www.pagopa.gov.it/",
-    "version": "0.12.6"
+    "version": "0.12.30"
   },
   "servers": [
     {
-      "url": "http://localhost",
+      "url": "https://api.platform.pagopa.it/gpd/payments-receipts-service/v1",
       "description": "Generated server url"
     }
   ],
@@ -155,24 +155,25 @@
           {
             "name": "pageNum",
             "in": "query",
-            "description": "Page number",
-            "required": true,
+            "description": "Page number, starts from 0",
+            "required": false,
             "schema": {
               "minimum": 0,
               "type": "integer",
-              "format": "int32"
+              "format": "int32",
+              "default": 0
             }
           },
           {
             "name": "pageSize",
             "in": "query",
-            "description": "Number of elements per page. Default = 50",
+            "description": "Number of elements per page. Default = 20",
             "required": false,
             "schema": {
               "maximum": 100,
               "type": "integer",
               "format": "int32",
-              "default": 50
+              "default": 20
             }
           },
           {
@@ -220,6 +221,15 @@
               "pattern": "\\d{2}(,\\d{2})*",
               "type": "string"
             }
+          },
+          {
+            "name": "debtorOrIuv",
+            "in": "query",
+            "description": "Filter start of debtor or IUV",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
           }
         ],
         "responses": {
@@ -236,7 +246,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "$ref": "#/components/schemas/ReceiptsInfo"
+                  "$ref": "#/components/schemas/PaymentsResult"
                 }
               }
             }
@@ -488,36 +498,25 @@
           }
         }
       },
-      "ReceiptModelResponse": {
+      "PaymentsResult": {
         "type": "object",
         "properties": {
-          "organizationFiscalCode": {
-            "type": "string"
-          },
-          "iuv": {
-            "type": "string"
+          "currentPageNumber": {
+            "type": "integer",
+            "format": "int32"
           },
-          "debtor": {
-            "type": "string"
+          "length": {
+            "type": "integer",
+            "format": "int32"
           },
-          "paymentDateTime": {
-            "type": "string"
+          "totalPages": {
+            "type": "integer",
+            "format": "int32"
           },
-          "status": {
-            "type": "string"
-          }
-        }
-      },
-      "ReceiptsInfo": {
-        "required": [
-          "receipts_list"
-        ],
-        "type": "object",
-        "properties": {
-          "receipts_list": {
+          "results": {
             "type": "array",
             "items": {
-              "$ref": "#/components/schemas/ReceiptModelResponse"
+              "type": "object"
             }
           }
         }