Update content of the OAS file and documentation - 2023-12-08.1

yapily · Dec 8, 2023 · 5295668 · 5295668
1 parent 57b4aa7
commit 5295668
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,10 @@ All notable changes to the API definition will be recorded here.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
 
+## [2.28.1] - 2023-12-08
+### Fixed
+- Fix Frequency and Alignment enums in VrpConfiguration
+
 ## [2.28.1] - 2023-12-06
 ### Added
 - Added `recurringPaymentCategory` for Non Sweeping VRPs. Add support for additional non sweeping VRP changes.

diff --git a/openapi.json b/openapi.json
@@ -3,7 +3,7 @@
   "info": {
     "description": "The Yapily API enables connections between your application and users' banks. For more information check out our [documentation](https://docs.yapily.com/).<br><br>In particular, make sure to view our [Getting Started](https://docs.yapily.com/pages/home/getting-started/) steps if this is your first time here.<br><br>While testing the API, our list of [sandbox credentials](https://docs.yapily.com/pages/key-concepts/sandbox-credentials/) maybe useful.",
     "title": "Yapily API",
-    "version": "2.28.0",
+    "version": "2.28.1",
     "contact": {
       "name": "Yapily Support",
       "url": "https://docs.yapily.com/pages/resources/support/",
@@ -13780,12 +13780,12 @@
           "SERVICES",
           "OTHER",
           "PERSON_TO_PERSON",
-          "BILL_IN_ADVANCE", 
-          "BILL_IN_ARREARS", 
-          "ECOMMERCE_MERCHANT", 
-          "FACE_TO_FACE_POS", 
+          "BILL_IN_ADVANCE",
+          "BILL_IN_ARREARS",
+          "ECOMMERCE_MERCHANT",
+          "FACE_TO_FACE_POS",
           "TRANSFER_TO_SELF",
-          "TRANSFER_TO_THIRD_PARTY", 
+          "TRANSFER_TO_THIRD_PARTY",
           "PISP_PAYEE"
         ]
       },
@@ -19732,29 +19732,35 @@
         ],
         "properties": {
           "maximumAmount": {
-            "description": "Maximum amount that can be specified in all payment instructions in a given period under this VRP consent. If the Alignment is Calendar, the limit is pro-rated in the first period to the remaining number of days.",
+            "description": "__Mandatory__. Maximum amount that can be specified in all payment instructions in a given period under this VRP consent. If the Alignment is Calendar, the limit is pro-rated in the first period to the remaining number of days.",
             "allOf": [
               {
                 "$ref": "#/components/schemas/Amount"
               }
             ]
           },
           "frequency": {
-            "type": "string",
-            "description": "Frequency for which the payment limits are enforced. Allowed values are [MONTHLY].",
-            "enum": [
-              "MONTHLY"
-            ]
+            "$ref": "#/components/schemas/FrequencyEnum"
           },
           "alignment": {
-            "type": "string",
-            "description": "Period alignment for which the payment limits are enforced. Allowed values are [CONSENT, CALENDAR]. If CONSENT, then period starts on consent creation date. If CALENDAR, then period lines up with the frequency e.g. WEEKLY period will begin at start of the week in question.",
-            "enum": [
-              "CONSENT",
-              "CALENDAR"
-            ]
+            "$ref": "#/components/schemas/AlignmentEnum"
           }
         }
+      },
+      "FrequencyEnum": {
+        "type": "string",
+        "description": "__Mandatory__. Frequency for which the payment limits are enforced. Allowed values are [MONTHLY].",
+        "enum": [
+            "MONTHLY"
+        ]
+      },
+      "AlignmentEnum": {
+        "type": "string",
+        "description": "__Mandatory__. Period alignment for which the payment limits are enforced. Allowed values are [CONSENT, CALENDAR]. If CONSENT, then period starts on consent creation date. If CALENDAR, then period lines up with the frequency e.g. WEEKLY period will begin at start of the week in question.",
+        "enum": [
+            "CONSENT",
+            "CALENDAR"
+        ]
       }
     },
     "securitySchemes": {