chore(docs): Generated API Reference (#2882)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
co-authored by
olivermrbl
parent
233d6904f8
commit
4814045036
@@ -9,30 +9,7 @@ post:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- region_id
|
||||
properties:
|
||||
value:
|
||||
type: integer
|
||||
description: The value (excluding VAT) that the Gift Card should represent.
|
||||
is_disabled:
|
||||
type: boolean
|
||||
description: >-
|
||||
Whether the Gift Card is disabled on creation. You will have to
|
||||
enable it later to make it available to Customers.
|
||||
ends_at:
|
||||
type: string
|
||||
format: date-time
|
||||
description: The time at which the Gift Card should no longer be available.
|
||||
region_id:
|
||||
description: The ID of the Region in which the Gift Card can be used.
|
||||
type: string
|
||||
metadata:
|
||||
description: >-
|
||||
An optional set of key-value pairs to hold additional
|
||||
information.
|
||||
type: object
|
||||
$ref: ../components/schemas/AdminPostGiftCardsReq.yaml
|
||||
x-codeSamples:
|
||||
- lang: JavaScript
|
||||
label: JS Client
|
||||
@@ -56,7 +33,7 @@ post:
|
||||
type: object
|
||||
properties:
|
||||
gift_card:
|
||||
$ref: ../components/schemas/gift_card.yaml
|
||||
$ref: ../components/schemas/GiftCard.yaml
|
||||
'400':
|
||||
$ref: ../components/responses/400_error.yaml
|
||||
'401':
|
||||
@@ -117,7 +94,7 @@ get:
|
||||
gift_cards:
|
||||
type: array
|
||||
items:
|
||||
$ref: ../components/schemas/gift_card.yaml
|
||||
$ref: ../components/schemas/GiftCard.yaml
|
||||
count:
|
||||
type: integer
|
||||
description: The total number of items available
|
||||
|
||||
Reference in New Issue
Block a user