Refactor charge_response and charge_payment_method_cash_response schemas

- Removed agreement property from charge_response and charge_payment_method_cash_response schemas - Removed product_type property from charge_response schema
conekta · Oct 25, 2024 · 7cdef43 · 7cdef43
1 parent 6e448c1
commit 7cdef43
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 17 deletions.
diff --git a/_build/api.yaml b/_build/api.yaml
@@ -12293,10 +12293,6 @@ components:
       type: object
     charge_response:
       properties:
-        agreement:
-          description: Agreement ID
-          example: agreement_2tN73UdUSNrYRPD9r
-          type: string
         amount:
           example: 4321
           type: integer
@@ -12347,11 +12343,6 @@ components:
           type: integer
         payment_method:
           $ref: '#/components/schemas/charge_response_payment_method'
-        product_type:
-          description: "Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in,\
-            \ etc."
-          example: bbva_cash_in
-          type: string
         reference_id:
           description: Reference ID of the charge
           example: ref_2tN73UdUSNrYRPD9r
@@ -14662,6 +14653,10 @@ components:
       - $ref: '#/components/schemas/payment_method'
       - description: use for cash responses
         properties:
+          agreement:
+            description: Agreement ID
+            example: agreement_2tN73UdUSNrYRPD9r
+            type: string
           auth_code:
             example: 542563
             nullable: true
@@ -14680,6 +14675,11 @@ components:
             example: 0
             format: int64
             type: integer
+          product_type:
+            description: "Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in,\
+              \ etc."
+            example: bbva_cash_in
+            type: string
           service_name:
             example: OxxoPay
             type: string

diff --git a/schemas/charges/charge_payment_method_cash_response.yml b/schemas/charges/charge_payment_method_cash_response.yml
@@ -5,6 +5,10 @@ payment_method_cash:
       title: charge_data_payment_method_cash_response
       description: use for cash responses
       properties:
+        agreement:
+          type: string
+          example: "agreement_2tN73UdUSNrYRPD9r"
+          description: "Agreement ID"
         auth_code:
           type: integer
           example: 542563
@@ -23,6 +27,10 @@ payment_method_cash:
           type: integer
           format: int64
           example: 0
+        product_type:
+          type: string
+          example: "bbva_cash_in"
+          description: "Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in, etc."
         service_name:
           type: string
           example: "OxxoPay"

diff --git a/schemas/charges/charge_response.yml b/schemas/charges/charge_response.yml
@@ -1,10 +1,6 @@
 title: charges_data_response
 type: object
 properties:
-  agreement:
-    type: string
-    example: "agreement_2tN73UdUSNrYRPD9r"
-    description: "Agreement ID"
   amount: 
     type: integer
     example: 4321
@@ -77,10 +73,6 @@ properties:
         cash_payment: payment_method_cash
         card_payment: payment_method_card
         bank_transfer_payment: payment_method_bank_transfer
-  product_type:
-    type: string
-    example: "bbva_cash_in"
-    description: "Product type, e.g. bbva_cash_in, cash_in, pespay_cash_in, etc."
   reference_id:
     type: string
     description: "Reference ID of the charge"