Skip to content

chore: add examples to the product endpoints #56

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 22, 2025
+44 −2
Merged

chore: add examples to the product endpoints #56

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
23 changes: 22 additions & 1 deletion dist/paystack.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3350,6 +3350,7 @@
tags:
- Product
summary: Create Product
description: Create a new product on your integration
operationId: product_create
requestBody:
content:
Expand All @@ -3370,20 +3371,25 @@
tags:
- Product
summary: List Products
description: List all previously created products
operationId: product_list
parameters:
- name: perPage
description: Number of records to fetch per page
in: query
schema:
type: integer
- name: page
description: The section to retrieve
in: query
schema:
type: integer
- name: active
description: The state of the product
in: query
schema:
type: boolean
example: true
- in: query
name: from
schema:
Expand All @@ -3408,14 +3414,17 @@
/product/{id}:
parameters:
- name: id
description: The unique identifier of the product
in: path
required: true
schema:
type: string
type: integer
example: 2196244
get:
tags:
- Product
summary: Fetch Product
description: Fetch a previously created product
operationId: product_fetch
responses:
'200':
Expand All @@ -3430,6 +3439,7 @@
tags:
- Product
summary: Update product
description: Update a previously created product
operationId: product_update
requestBody:
content:
Expand All @@ -3452,6 +3462,7 @@
tags:
- Product
summary: Delete Product
description: Delete a previously created product
operationId: product_delete
responses:
'200':
Expand All @@ -3463,7 +3474,7 @@
default:
description: Server error
/storefront:
post:

Check warning on line 3477 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 @@ -3483,7 +3494,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 3497 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 @@ -3520,7 +3531,7 @@
required: true
schema:
type: string
get:

Check warning on line 3534 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 @@ -3534,7 +3545,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 3548 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 @@ -3556,7 +3567,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
delete:

Check warning on line 3570 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 @@ -3577,7 +3588,7 @@
required: true
schema:
type: string
get:

Check warning on line 3591 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 @@ -3619,7 +3630,7 @@
required: true
schema:
type: string
post:

Check warning on line 3633 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 @@ -3641,7 +3652,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
get:

Check warning on line 3655 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 @@ -3662,7 +3673,7 @@
required: true
schema:
type: string
post:

Check warning on line 3676 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 @@ -3683,7 +3694,7 @@
required: true
schema:
type: string
post:

Check warning on line 3697 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 @@ -3698,7 +3709,7 @@
default:
description: Server error
/order:
post:

Check warning on line 3712 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 @@ -3718,7 +3729,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 3732 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 @@ -3762,7 +3773,7 @@
required: true
schema:
type: string
get:

Check warning on line 3776 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 @@ -3783,7 +3794,7 @@
required: true
schema:
type: string
get:

Check warning on line 3797 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 @@ -3804,7 +3815,7 @@
required: true
schema:
type: string
get:

Check warning on line 3818 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 @@ -3819,7 +3830,7 @@
default:
description: Server error
/page:
post:

Check warning on line 3833 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 @@ -3839,7 +3850,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 3853 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 @@ -3883,7 +3894,7 @@
required: true
schema:
type: string
get:

Check warning on line 3897 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 @@ -3897,7 +3908,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 3911 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 @@ -3926,7 +3937,7 @@
required: true
schema:
type: string
get:

Check warning on line 3940 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 @@ -3947,7 +3958,7 @@
required: true
schema:
type: string
post:

Check warning on line 3961 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 @@ -3968,7 +3979,7 @@
default:
description: Server error
/paymentrequest:
post:

Check warning on line 3982 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:
- Payment Request
summary: Create Payment Request
Expand All @@ -3988,7 +3999,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 4002 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:
- Payment Request
summary: List Payment Request
Expand Down Expand Up @@ -4047,7 +4058,7 @@
required: true
schema:
type: string
get:

Check warning on line 4061 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:
- Payment Request
summary: Fetch Payment Request
Expand All @@ -4061,7 +4072,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 4075 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:
- Payment Request
summary: Update Payment Request
Expand Down Expand Up @@ -4090,7 +4101,7 @@
required: true
schema:
type: string
get:

Check warning on line 4104 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:
- Payment Request
summary: Verify Payment Request
Expand All @@ -4111,7 +4122,7 @@
required: true
schema:
type: string
post:

Check warning on line 4125 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:
- Payment Request
summary: Send Notification
Expand All @@ -4124,7 +4135,7 @@
default:
description: Server error
/paymentrequest/totals:
get:

Check warning on line 4138 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:
- Payment Request
summary: Payment Request Total
Expand All @@ -4145,7 +4156,7 @@
required: true
schema:
type: string
post:

Check warning on line 4159 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:
- Payment Request
summary: Finalize Payment Request
Expand All @@ -4164,7 +4175,7 @@
required: true
schema:
type: string
post:

Check warning on line 4178 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:
- Payment Request
summary: Archive Payment Request
Expand All @@ -4177,7 +4188,7 @@
default:
description: Server error
/settlement:
get:

Check warning on line 4191 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:
- Settlement
summary: Fetch Settlements
Expand All @@ -4203,7 +4214,7 @@
default:
description: Server error
/settlement/{id}/transaction:
get:

Check warning on line 4217 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:
- Settlement
summary: Settlement Transactions
Expand All @@ -4224,7 +4235,7 @@
default:
description: Server error
/integration/payment_session_timeout:
get:

Check warning on line 4238 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 @@ -4242,7 +4253,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 4256 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 @@ -4266,7 +4277,7 @@
default:
description: Server error
/refund:
post:

Check warning on line 4280 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 @@ -4286,7 +4297,7 @@
$ref: '#/components/responses/Unauthorized'
default:
description: Server error
get:

Check warning on line 4300 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 @@ -4324,7 +4335,7 @@
default:
description: Server error
/refund/{id}:
get:

Check warning on line 4338 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 @@ -4345,7 +4356,7 @@
default:
description: Server error
/dispute:
get:

Check warning on line 4359 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 @@ -4400,7 +4411,7 @@
required: true
schema:
type: string
get:

Check warning on line 4414 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 @@ -4414,7 +4425,7 @@
$ref: '#/components/responses/NotFound'
default:
description: Server error
put:

Check warning on line 4428 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 @@ -4437,7 +4448,7 @@
default:
description: Server error
/dispute/{id}/upload_url:
get:

Check warning on line 4451 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 @@ -4459,7 +4470,7 @@
default:
description: Server error
/dispute/export:
get:

Check warning on line 4473 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 @@ -4501,7 +4512,7 @@
default:
description: Server error
/dispute/transaction/{id}:
get:

Check warning on line 4515 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 @@ -4523,7 +4534,7 @@
default:
description: Server error
/dispute/{id}/resolve:
put:

Check warning on line 4537 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 @@ -4553,7 +4564,7 @@
default:
description: Server error
/dispute/{id}/evidence:
post:

Check warning on line 4567 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 Expand Up @@ -4581,7 +4592,7 @@
default:
description: Server error
/bank:
get:

Check warning on line 4595 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:
- Bank
summary: List Banks
Expand Down Expand Up @@ -4632,7 +4643,7 @@
default:
description: Server error
/bank/resolve:
get:

Check warning on line 4646 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:
- Bank
summary: Resolve Account Number
Expand All @@ -4658,7 +4669,7 @@
default:
description: Server error
/bank/validate:
post:

Check warning on line 4672 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:
- Bank
summary: Validate Bank Account
Expand All @@ -4679,7 +4690,7 @@
default:
description: Server error
/decision/bin/{bin}:
get:

Check warning on line 4693 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:
- Miscellaneous
summary: Resolve Card BIN
Expand All @@ -4700,7 +4711,7 @@
default:
description: Server error
/country:
get:

Check warning on line 4714 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:
- Miscellaneous
summary: List Countries
Expand Down Expand Up @@ -12917,6 +12928,11 @@
metadata:
description: Stringified JSON object of custom data
type: string
example:
name: Cups
description: Environment friendly paper cups
price: 10000
currency: NGN
ProductCreateResponse:
type: object
properties:
Expand Down Expand Up @@ -13202,6 +13218,11 @@
metadata:
description: JSON object of custom data
type: object
example:
name: Spoon
description: Environment friendly paper spoons
price: 5000
currency: NGN
ProductUpdateResponse:
type: object
properties:
Expand Down
5 changes: 5 additions & 0 deletions src/assets/openapi/components/schemas/ProductCreate.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,8 @@ properties:
metadata:
description: Stringified JSON object of custom data
type: string
example:
name: Cups
description: Environment friendly paper cups
price: 10000
currency: NGN
5 changes: 5 additions & 0 deletions src/assets/openapi/components/schemas/ProductUpdate.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,8 @@ properties:
metadata:
description: JSON object of custom data
type: object
example:
name: Spoon
description: Environment friendly paper spoons
price: 5000
currency: NGN
6 changes: 6 additions & 0 deletions src/assets/openapi/paths/product.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ post:
tags:
- Product
summary: Create Product
description: Create a new product on your integration
operationId: product_create
requestBody:
content:
Expand All @@ -22,20 +23,25 @@ get:
tags:
- Product
summary: List Products
description: List all previously created products
operationId: product_list
parameters:
- name: perPage
description: Number of records to fetch per page
in: query
schema:
type: integer
- name: page
description: The section to retrieve
in: query
schema:
type: integer
- name: active
description: The state of the product
in: query
schema:
type: boolean
example: true
- in: query
name: from
schema:
Expand Down
7 changes: 6 additions & 1 deletion src/assets/openapi/paths/product_{id}.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
parameters:
- name: id
description: The unique identifier of the product
in: path
required: true
schema:
type: string
type: integer
example: 2196244
get:
tags:
- Product
summary: Fetch Product
description: Fetch a previously created product
operationId: product_fetch
responses:
'200':
Expand All @@ -22,6 +25,7 @@ put:
tags:
- Product
summary: Update product
description: Update a previously created product
operationId: product_update
requestBody:
content:
Expand All @@ -44,6 +48,7 @@ delete:
tags:
- Product
summary: Delete Product
description: Delete a previously created product
operationId: product_delete
responses:
'200':
Expand Down
Loading