docs: update OAS for loyalty plugin (#12836)
* updates * cleanup * generate OAS * update links
This commit is contained in:
@@ -1,7 +1,8 @@
|
||||
post:
|
||||
operationId: PostGiftCardsIdTransfer
|
||||
summary: Transfer Gift Card
|
||||
description: Transfer a gift card to another customer.
|
||||
get:
|
||||
operationId: GetGiftCardsIdOrders
|
||||
summary: List Gift Card's Orders
|
||||
x-sidebar-summary: List Orders
|
||||
description: Retrieve the list of orders that a gift card was used in.
|
||||
x-authenticated: true
|
||||
x-ignoreCleanup: true
|
||||
parameters:
|
||||
@@ -13,13 +14,10 @@ post:
|
||||
type: string
|
||||
- name: fields
|
||||
in: query
|
||||
description: >-
|
||||
description: |-
|
||||
Comma-separated fields that should be included in the returned data.
|
||||
|
||||
if a field is prefixed with `+` it will be added to the default fields,
|
||||
using `-` will remove it from the default fields.
|
||||
|
||||
without prefix it will replace the entire default fields.
|
||||
if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||
without prefix it will replace the entire default fields.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
@@ -35,25 +33,16 @@ post:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
- jwt_token: []
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminTransferGiftCard.yaml
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/admin_gift-cards_{id}_transfer/post.sh
|
||||
$ref: ../code_samples/Shell/admin_gift-cards_{id}_orders/get.sh
|
||||
tags:
|
||||
- Gift Cards
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas/AdminGiftCardResponse.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
Reference in New Issue
Block a user