Skip to content

chore: update settlements examples and descriptions #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
damilola-paystack merged 1 commit into from
Oct 24, 2025
Merged

chore: update settlements examples and descriptions #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions dist/paystack.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3710,7 +3710,7 @@
default:
description: Server error
/storefront:
post:

Check warning on line 3713 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Create Storefront
Expand All @@ -3730,7 +3730,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 3733 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: List Storefronts
Expand Down Expand Up @@ -3767,7 +3767,7 @@
required: true
schema:
type: string
get:

Check warning on line 3770 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Fetch Storefront
Expand All @@ -3781,7 +3781,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 3784 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Update Storefront
Expand All @@ -3803,7 +3803,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
delete:

Check warning on line 3806 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Delete Storefront
Expand All @@ -3824,7 +3824,7 @@
required: true
schema:
type: string
get:

Check warning on line 3827 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Verify Storefront Slug
Expand Down Expand Up @@ -3866,7 +3866,7 @@
required: true
schema:
type: string
post:

Check warning on line 3869 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Add Products to Storefront
Expand All @@ -3888,7 +3888,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
get:

Check warning on line 3891 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: List Products in Storefront
Expand All @@ -3909,7 +3909,7 @@
required: true
schema:
type: string
post:

Check warning on line 3912 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Publish Storefront
Expand All @@ -3930,7 +3930,7 @@
required: true
schema:
type: string
post:

Check warning on line 3933 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Storefront
summary: Duplicate Storefront
Expand All @@ -3945,7 +3945,7 @@
default:
description: Server error
/order:
post:

Check warning on line 3948 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Order
summary: Create Order
Expand All @@ -3965,7 +3965,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 3968 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Order
summary: List Orders
Expand Down Expand Up @@ -4009,7 +4009,7 @@
required: true
schema:
type: string
get:

Check warning on line 4012 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Order
summary: Fetch Order
Expand All @@ -4030,7 +4030,7 @@
required: true
schema:
type: string
get:

Check warning on line 4033 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Order
summary: Fetch Products Order
Expand All @@ -4051,7 +4051,7 @@
required: true
schema:
type: string
get:

Check warning on line 4054 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Order
summary: Validate pay for me order
Expand All @@ -4066,7 +4066,7 @@
default:
description: Server error
/page:
post:

Check warning on line 4069 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: Create Page
Expand All @@ -4086,7 +4086,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 4089 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: List Pages
Expand Down Expand Up @@ -4130,7 +4130,7 @@
required: true
schema:
type: string
get:

Check warning on line 4133 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: Fetch Page
Expand All @@ -4144,7 +4144,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 4147 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: Update Page
Expand Down Expand Up @@ -4173,7 +4173,7 @@
required: true
schema:
type: string
get:

Check warning on line 4176 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: Check Slug Availability
Expand All @@ -4194,7 +4194,7 @@
required: true
schema:
type: string
post:

Check warning on line 4197 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Page
summary: Add Products
Expand All @@ -4218,15 +4218,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
Expand All @@ -4240,18 +4243,21 @@
$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'
Expand All @@ -4262,7 +4268,7 @@
default:
description: Server error
/integration/payment_session_timeout:
get:

Check warning on line 4271 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Integration
summary: Fetch Payment Session Timeout
Expand All @@ -4280,7 +4286,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 4289 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Integration
summary: Update Payment Session Timeout
Expand All @@ -4304,7 +4310,7 @@
default:
description: Server error
/refund:
post:

Check warning on line 4313 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Refund
summary: Create Refund
Expand All @@ -4324,7 +4330,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 4333 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Refund
summary: List Refunds
Expand Down Expand Up @@ -4362,7 +4368,7 @@
default:
description: Server error
/refund/{id}:
get:

Check warning on line 4371 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Refund
summary: Fetch Refund
Expand All @@ -4383,7 +4389,7 @@
default:
description: Server error
/dispute:
get:

Check warning on line 4392 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: List Disputes
Expand Down Expand Up @@ -4438,7 +4444,7 @@
required: true
schema:
type: string
get:

Check warning on line 4447 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Fetch Dispute
Expand All @@ -4452,7 +4458,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 4461 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Update Dispute
Expand All @@ -4475,7 +4481,7 @@
default:
description: Server error
/dispute/{id}/upload_url:
get:

Check warning on line 4484 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Get Upload URL
Expand All @@ -4497,7 +4503,7 @@
default:
description: Server error
/dispute/export:
get:

Check warning on line 4506 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Export Disputes
Expand Down Expand Up @@ -4539,7 +4545,7 @@
default:
description: Server error
/dispute/transaction/{id}:
get:

Check warning on line 4548 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: List Transaction Disputes
Expand All @@ -4561,7 +4567,7 @@
default:
description: Server error
/dispute/{id}/resolve:
put:

Check warning on line 4570 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Resolve a Dispute
Expand Down Expand Up @@ -4591,7 +4597,7 @@
default:
description: Server error
/dispute/{id}/evidence:
post:

Check warning on line 4600 in dist/paystack.yaml

View workflow job for this annotation

GitHub Actions / Lint (pull_request)

operation-description 

Operation "description" must be present and non-empty string.
tags:
- Dispute
summary: Add Evidence
Expand Down
4 changes: 2 additions & 2 deletions src/assets/openapi/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
5 changes: 4 additions & 1 deletion src/assets/openapi/paths/settlement.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 5 additions & 2 deletions ...pi/paths/settlement_{id}_transaction.yaml → ...i/paths/settlement_{id}_transactions.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Loading