From 4af92938dfc8594177245a411d440d5e88dac889 Mon Sep 17 00:00:00 2001 From: Damilola Odujoko Date: Fri, 24 Oct 2025 12:49:33 +0100 Subject: [PATCH] chore: update settlements examples and descriptions --- dist/paystack.yaml | 14 ++++++++++---- src/assets/openapi/openapi.yaml | 4 ++-- src/assets/openapi/paths/settlement.yaml | 5 ++++- ...tion.yaml => settlement_{id}_transactions.yaml} | 7 +++++-- 4 files changed, 21 insertions(+), 9 deletions(-) rename src/assets/openapi/paths/{settlement_{id}_transaction.yaml => settlement_{id}_transactions.yaml} (61%) diff --git a/dist/paystack.yaml b/dist/paystack.yaml index 1d202f2..699e320 100644 --- a/dist/paystack.yaml +++ b/dist/paystack.yaml @@ -4218,15 +4218,18 @@ paths: get: tags: - Settlement - summary: Fetch Settlements + summary: List Settlements + description: List settlements made to your settlement accounts operationId: settlements_fetch parameters: - name: perPage + description: The number of records to fetch per request in: query schema: type: integer example: 50 - name: page + description: The offset to retrieve data from in: query schema: type: integer @@ -4240,18 +4243,21 @@ paths: $ref: '#/components/responses/NotFound' default: description: Server error - /settlement/{id}/transaction: + /settlement/{id}/transactions: get: tags: - Settlement - summary: Settlement Transactions + summary: Fetch Settlement Transactions + description: Get the transactions that make up a particular settlement operationId: settlements_transaction parameters: - name: id + description: The settlement ID in which you want to fetch its transactions in: path required: true schema: - type: string + type: integer + example: 8610870 responses: '200': $ref: '#/components/responses/Ok' diff --git a/src/assets/openapi/openapi.yaml b/src/assets/openapi/openapi.yaml index df6166c..23a483d 100644 --- a/src/assets/openapi/openapi.yaml +++ b/src/assets/openapi/openapi.yaml @@ -352,8 +352,8 @@ paths: $ref: paths/page_{id}_product.yaml /settlement: $ref: paths/settlement.yaml - /settlement/{id}/transaction: - $ref: paths/settlement_{id}_transaction.yaml + /settlement/{id}/transactions: + $ref: paths/settlement_{id}_transactions.yaml /integration/payment_session_timeout: $ref: paths/integration_payment_session_timeout.yaml /refund: diff --git a/src/assets/openapi/paths/settlement.yaml b/src/assets/openapi/paths/settlement.yaml index d7e0445..89f945d 100644 --- a/src/assets/openapi/paths/settlement.yaml +++ b/src/assets/openapi/paths/settlement.yaml @@ -1,15 +1,18 @@ get: tags: - Settlement - summary: Fetch Settlements + summary: List Settlements + description: List settlements made to your settlement accounts operationId: settlements_fetch parameters: - name: perPage + description: The number of records to fetch per request in: query schema: type: integer example: 50 - name: page + description: The offset to retrieve data from in: query schema: type: integer diff --git a/src/assets/openapi/paths/settlement_{id}_transaction.yaml b/src/assets/openapi/paths/settlement_{id}_transactions.yaml similarity index 61% rename from src/assets/openapi/paths/settlement_{id}_transaction.yaml rename to src/assets/openapi/paths/settlement_{id}_transactions.yaml index bfada86..dfdce7f 100644 --- a/src/assets/openapi/paths/settlement_{id}_transaction.yaml +++ b/src/assets/openapi/paths/settlement_{id}_transactions.yaml @@ -1,14 +1,17 @@ get: tags: - Settlement - summary: Settlement Transactions + summary: Fetch Settlement Transactions + description: Get the transactions that make up a particular settlement operationId: settlements_transaction parameters: - name: id + description: The settlement ID in which you want to fetch its transactions in: path required: true schema: - type: string + type: integer + example: 8610870 responses: '200': $ref: ../components/responses/Ok.yaml