chore(docs): Refactor API Reference (#1883)
This commit is contained in:
45
docs/api/admin/paths/discounts_{id}_dynamic-codes.yaml
Normal file
45
docs/api/admin/paths/discounts_{id}_dynamic-codes.yaml
Normal file
@@ -0,0 +1,45 @@
|
||||
post:
|
||||
operationId: PostDiscountsDiscountDynamicCodes
|
||||
summary: Create a dynamic Discount code
|
||||
description: >-
|
||||
Creates a unique code that can map to a parent Discount. This is useful if
|
||||
you want to automatically generate codes with the same behaviour.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Discount to create the dynamic code from."
|
||||
schema:
|
||||
type: string
|
||||
tags:
|
||||
- Discount
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
discount:
|
||||
$ref: ../components/schemas/discount.yaml
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
required:
|
||||
- code
|
||||
properties:
|
||||
code:
|
||||
type: string
|
||||
description: The unique code that will be used to redeem the Discount.
|
||||
usage_limit:
|
||||
type: number
|
||||
default: '1'
|
||||
description: amount of times the discount can be applied.
|
||||
metadata:
|
||||
type: object
|
||||
description: >-
|
||||
An optional set of key-value paris to hold additional
|
||||
information.
|
||||
Reference in New Issue
Block a user