-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Customer Payout Log pagination and response schemas
- Loading branch information
1 parent
a34d045
commit a40a296
Showing
4 changed files
with
86 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
get: | ||
parameters: | ||
- name: customerId | ||
in: path | ||
description: The ID of the customerId | ||
required: true | ||
schema: | ||
type: string | ||
- name: payoutId | ||
in: path | ||
description: The ID of the payoutId | ||
required: true | ||
schema: | ||
type: string | ||
- name: page | ||
in: query | ||
description: The page number | ||
required: true | ||
schema: | ||
type: string | ||
- name: sortOrder | ||
in: query | ||
description: The sort order either asc eller desc = default desc | ||
schema: | ||
type: string | ||
- name: limit | ||
in: query | ||
description: The limit = default to 10 | ||
schema: | ||
type: string | ||
tags: | ||
- CustomerPayoutLog | ||
operationId: customerPayoutLogPaginate | ||
summary: GET get all payout logs for specific payout using paginate | ||
description: This endpoint get all payout logs for specific payout | ||
|
||
responses: | ||
"200": | ||
description: Response with payouts payload | ||
content: | ||
application/json: | ||
schema: | ||
$ref: "./response.yaml" | ||
"400": | ||
$ref: "../../../../responses/bad.yaml" | ||
"401": | ||
$ref: "../../../../responses/unauthorized.yaml" | ||
"403": | ||
$ref: "../../../../responses/forbidden.yaml" | ||
"404": | ||
$ref: "../../../../responses/not-found.yaml" | ||
|
||
security: [] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
type: object | ||
properties: | ||
success: | ||
type: boolean | ||
example: true | ||
payload: | ||
type: array | ||
items: | ||
oneOf: | ||
- $ref: "../../_types/order/line-item.yaml" | ||
- $ref: ../../../shipping/_types/shipping.yaml | ||
required: | ||
- success | ||
- payload |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters