Skip to content

chore: update pages examples and descriptions #62

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 pages examples and descriptions #62

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
35 changes: 29 additions & 6 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 @@ -4070,6 +4070,7 @@
tags:
- Page
summary: Create Page
description: Create a webpage to receive payments
operationId: page_create
requestBody:
content:
Expand All @@ -4090,13 +4091,16 @@
tags:
- Page
summary: List Pages
description: List all previously created payment pages
operationId: page_list
parameters:
- in: query
name: perPage
schema:
type: integer
default: 50
description: Number of records to fetch per page
example: 10
- in: query
name: page
schema:
Expand Down Expand Up @@ -4127,13 +4131,16 @@
parameters:
- name: id
in: path
description: The unique identifier of a payment page
required: true
schema:
type: string
type: integer
example: 1891222
get:
tags:
- Page
summary: Fetch Page
description: Get a previously created payment page
operationId: page_fetch
responses:
'200':
Expand All @@ -4148,6 +4155,7 @@
tags:
- Page
summary: Update Page
description: Update a previously created payment page
operationId: page_update
requestBody:
content:
Expand All @@ -4170,13 +4178,16 @@
parameters:
- name: slug
in: path
description: The custom slug to check
required: true
schema:
type: string
example: risky-burger
get:
tags:
- Page
summary: Check Slug Availability
description: Check if a custom slug is available for use when creating a payment page
operationId: page_checkSlugAvailability
responses:
'200':
Expand All @@ -4198,6 +4209,9 @@
tags:
- Page
summary: Add Products
description: |
Add products to a previously created payment page. You can only add products to pages
that was created with a `product` type.
operationId: page_addProducts
requestBody:
content:
Expand Down Expand Up @@ -4312,7 +4326,7 @@
default:
description: Server error
/refund:
post:

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

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

Check warning on line 4387 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 @@ -4391,7 +4405,7 @@
default:
description: Server error
/dispute:
get:

Check warning on line 4408 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 @@ -4446,7 +4460,7 @@
required: true
schema:
type: string
get:

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

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

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

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

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

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

Check warning on line 4616 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 @@ -15715,6 +15729,9 @@
type: array
items:
type: object
example:
name: Extra Charges
amount: 200000
PageCreateResponse:
type: object
properties:
Expand Down Expand Up @@ -15858,11 +15875,13 @@
description: The description of the page
type: string
amount:
description: Amount should be in kobo if currency is NGN, pesewas, if currency is GHS, and cents, if currency is ZAR
description: Amount should be in the subunit of the currency
type: integer
active:
description: Set to false to deactivate page url
type: boolean
example:
name: Backyard Sale
PageUpdateResponse:
type: object
properties:
Expand Down Expand Up @@ -15957,13 +15976,17 @@
PageProduct:
type: object
required:
- product
- products
properties:
product:
description: IDs of all products to add to a page
products:
description: A list of IDs of products to add to a page.
type: array
items:
type: string
type: integer
example:
products:
- 2196244
- 2179824
PageProductsArray:
type: object
properties:
Expand Down
3 changes: 3 additions & 0 deletions src/assets/openapi/components/schemas/PageCreate.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,6 @@ properties:
type: array
items:
type: object
example:
name: "Extra Charges"
amount: 200000
12 changes: 8 additions & 4 deletions src/assets/openapi/components/schemas/PageProduct.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
type: object
required:
- product
- products
properties:
product:
description: IDs of all products to add to a page
products:
description: A list of IDs of products to add to a page.
type: array
items:
type: string
type: integer
example:
products:
- 2196244
- 2179824
5 changes: 3 additions & 2 deletions src/assets/openapi/components/schemas/PageUpdate.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ properties:
type: string
amount:
description: >-
Amount should be in kobo if currency is NGN, pesewas, if currency is GHS,
and cents, if currency is ZAR
Amount should be in the subunit of the currency
type: integer
active:
description: Set to false to deactivate page url
type: boolean
example:
name: "Backyard Sale"
4 changes: 4 additions & 0 deletions src/assets/openapi/paths/page.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ post:
tags:
- Page
summary: Create Page
description: Create a webpage to receive payments
operationId: page_create
requestBody:
content:
Expand All @@ -22,13 +23,16 @@ get:
tags:
- Page
summary: List Pages
description: List all previously created payment pages
operationId: page_list
parameters:
- in: query
name: perPage
schema:
type: integer
default: 50
description: Number of records to fetch per page
example: 10
- in: query
name: page
schema:
Expand Down
3 changes: 3 additions & 0 deletions src/assets/openapi/paths/page_check_slug_availability_{slug}.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
parameters:
- name: slug
in: path
description: The custom slug to check
required: true
schema:
type: string
example: risky-burger
get:
tags:
- Page
summary: Check Slug Availability
description: Check if a custom slug is available for use when creating a payment page
operationId: page_checkSlugAvailability
responses:
'200':
Expand Down
6 changes: 5 additions & 1 deletion src/assets/openapi/paths/page_{id}.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
parameters:
- name: id
in: path
description: The unique identifier of a payment page
required: true
schema:
type: string
type: integer
example: 1891222
get:
tags:
- Page
summary: Fetch Page
description: Get a previously created payment page
operationId: page_fetch
responses:
'200':
Expand All @@ -22,6 +25,7 @@ put:
tags:
- Page
summary: Update Page
description: Update a previously created payment page
operationId: page_update
requestBody:
content:
Expand Down
3 changes: 3 additions & 0 deletions src/assets/openapi/paths/page_{id}_product.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ post:
tags:
- Page
summary: Add Products
description: |
Add products to a previously created payment page. You can only add products to pages
that was created with a `product` type.
operationId: page_addProducts
requestBody:
content:
Expand Down
Loading