chore(docs): Generated OAS (#7189)
This PR holds all generated OAS for the upcoming release. Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
co-authored by
Oli Juhl
Oli Juhl
parent
d930d88369
commit
bfda7a626d
@@ -4,47 +4,7 @@
|
||||
* summary: Create Promotion
|
||||
* description: Create a promotion.
|
||||
* x-authenticated: true
|
||||
* parameters:
|
||||
* - name: expand
|
||||
* in: query
|
||||
* description: Comma-separated relations that should be expanded in the returned data.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: expand
|
||||
* description: Comma-separated relations that should be expanded in the returned data.
|
||||
* - name: fields
|
||||
* in: query
|
||||
* description: Comma-separated fields that should be included in the returned data.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: fields
|
||||
* description: Comma-separated fields that should be included in the returned data.
|
||||
* - name: offset
|
||||
* in: query
|
||||
* description: The number of items to skip when retrieving a list.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: number
|
||||
* title: offset
|
||||
* description: The number of items to skip when retrieving a list.
|
||||
* - name: limit
|
||||
* in: query
|
||||
* description: Limit the number of items returned in the list.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: Limit the number of items returned in the list.
|
||||
* - name: order
|
||||
* in: query
|
||||
* description: Field to sort items in the list by.
|
||||
* required: false
|
||||
* schema:
|
||||
* type: string
|
||||
* title: order
|
||||
* description: Field to sort items in the list by.
|
||||
* parameters: []
|
||||
* security:
|
||||
* - api_token: []
|
||||
* - cookie_auth: []
|
||||
@@ -73,7 +33,216 @@
|
||||
* requestBody:
|
||||
* content:
|
||||
* application/json:
|
||||
* schema: {}
|
||||
* schema:
|
||||
* type: object
|
||||
* required:
|
||||
* - code
|
||||
* - is_automatic
|
||||
* - type
|
||||
* - campaign_id
|
||||
* - campaign
|
||||
* - application_method
|
||||
* - rules
|
||||
* properties:
|
||||
* code:
|
||||
* type: string
|
||||
* title: code
|
||||
* description: The promotion's code.
|
||||
* is_automatic:
|
||||
* type: boolean
|
||||
* title: is_automatic
|
||||
* description: The promotion's is automatic.
|
||||
* type: {}
|
||||
* campaign_id:
|
||||
* type: string
|
||||
* title: campaign_id
|
||||
* description: The promotion's campaign id.
|
||||
* campaign:
|
||||
* type: object
|
||||
* description: The promotion's campaign.
|
||||
* required:
|
||||
* - name
|
||||
* - campaign_identifier
|
||||
* - description
|
||||
* - currency
|
||||
* - budget
|
||||
* - starts_at
|
||||
* - ends_at
|
||||
* - promotions
|
||||
* properties:
|
||||
* name:
|
||||
* type: string
|
||||
* title: name
|
||||
* description: The campaign's name.
|
||||
* campaign_identifier:
|
||||
* type: string
|
||||
* title: campaign_identifier
|
||||
* description: The campaign's campaign identifier.
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The campaign's description.
|
||||
* currency:
|
||||
* type: string
|
||||
* title: currency
|
||||
* description: The campaign's currency.
|
||||
* budget:
|
||||
* type: object
|
||||
* description: The campaign's budget.
|
||||
* required:
|
||||
* - type
|
||||
* - limit
|
||||
* properties:
|
||||
* type: {}
|
||||
* limit:
|
||||
* type: number
|
||||
* title: limit
|
||||
* description: The budget's limit.
|
||||
* starts_at:
|
||||
* type: string
|
||||
* title: starts_at
|
||||
* description: The campaign's starts at.
|
||||
* format: date-time
|
||||
* ends_at:
|
||||
* type: string
|
||||
* title: ends_at
|
||||
* description: The campaign's ends at.
|
||||
* format: date-time
|
||||
* promotions:
|
||||
* type: array
|
||||
* description: The campaign's promotions.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The promotion's promotions.
|
||||
* required:
|
||||
* - id
|
||||
* properties:
|
||||
* id:
|
||||
* type: string
|
||||
* title: id
|
||||
* description: The promotion's ID.
|
||||
* application_method:
|
||||
* type: object
|
||||
* description: The promotion's application method.
|
||||
* required:
|
||||
* - description
|
||||
* - value
|
||||
* - max_quantity
|
||||
* - type
|
||||
* - target_type
|
||||
* - allocation
|
||||
* - target_rules
|
||||
* - buy_rules
|
||||
* - apply_to_quantity
|
||||
* - buy_rules_min_quantity
|
||||
* properties:
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The application method's description.
|
||||
* value:
|
||||
* type: number
|
||||
* title: value
|
||||
* description: The application method's value.
|
||||
* max_quantity:
|
||||
* type: number
|
||||
* title: max_quantity
|
||||
* description: The application method's max quantity.
|
||||
* type: {}
|
||||
* target_type: {}
|
||||
* allocation: {}
|
||||
* target_rules:
|
||||
* type: array
|
||||
* description: The application method's target rules.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The target rule's target rules.
|
||||
* required:
|
||||
* - operator
|
||||
* - description
|
||||
* - attribute
|
||||
* - values
|
||||
* properties:
|
||||
* operator: {}
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The target rule's description.
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The target rule's attribute.
|
||||
* values:
|
||||
* type: array
|
||||
* description: The target rule's values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: The value's values.
|
||||
* buy_rules:
|
||||
* type: array
|
||||
* description: The application method's buy rules.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The buy rule's buy rules.
|
||||
* required:
|
||||
* - operator
|
||||
* - description
|
||||
* - attribute
|
||||
* - values
|
||||
* properties:
|
||||
* operator: {}
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The buy rule's description.
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The buy rule's attribute.
|
||||
* values:
|
||||
* type: array
|
||||
* description: The buy rule's values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: The value's values.
|
||||
* apply_to_quantity:
|
||||
* type: number
|
||||
* title: apply_to_quantity
|
||||
* description: The application method's apply to quantity.
|
||||
* buy_rules_min_quantity:
|
||||
* type: number
|
||||
* title: buy_rules_min_quantity
|
||||
* description: The application method's buy rules min quantity.
|
||||
* rules:
|
||||
* type: array
|
||||
* description: The promotion's rules.
|
||||
* items:
|
||||
* type: object
|
||||
* description: The rule's rules.
|
||||
* required:
|
||||
* - operator
|
||||
* - description
|
||||
* - attribute
|
||||
* - values
|
||||
* properties:
|
||||
* operator: {}
|
||||
* description:
|
||||
* type: string
|
||||
* title: description
|
||||
* description: The rule's description.
|
||||
* attribute:
|
||||
* type: string
|
||||
* title: attribute
|
||||
* description: The rule's attribute.
|
||||
* values:
|
||||
* type: array
|
||||
* description: The rule's values.
|
||||
* items:
|
||||
* type: string
|
||||
* title: values
|
||||
* description: The value's values.
|
||||
*
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user