chore(docs): Generated API Reference (#2120)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andshahednasser authored and GitHub committed 2022-08-29 14:39:35 +03:00
1 parent 076b41bb89
commit b98a09dd9f
11 files changed
+46 -46

No files matched your search

+11 -11
View File
@@ -2372,7 +2372,8 @@
"/discounts/{discount_id}/conditions": { "/discounts/{discount_id}/conditions": {
"post": { "post": {
"operationId": "PostDiscountsDiscountConditions", "operationId": "PostDiscountsDiscountConditions",
"summary": "Creates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided.", "summary": "Create a DiscountCondition",
"description": "Creates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided.",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
{ {
@@ -2401,7 +2402,6 @@
} }
} }
], ],
"description": "Creates a DiscountCondition",
"requestBody": { "requestBody": {
"content": { "content": {
"application/json": { "application/json": {
@@ -2997,7 +2997,8 @@
}, },
"post": { "post": {
"operationId": "PostDiscountsDiscountConditionsCondition", "operationId": "PostDiscountsDiscountConditionsCondition",
"summary": "Updates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided.", "summary": "Update a DiscountCondition",
"description": "Updates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided.",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
{ {
@@ -3035,7 +3036,6 @@
} }
} }
], ],
"description": "Updates a DiscountCondition",
"requestBody": { "requestBody": {
"content": { "content": {
"application/json": { "application/json": {
@@ -4337,8 +4337,8 @@
}, },
"post": { "post": {
"operationId": "PostGiftCardsGiftCard", "operationId": "PostGiftCardsGiftCard",
"summary": "Create a Gift Card", "summary": "Update a Gift Card",
"description": "Creates a Gift Card that can redeemed by its unique code. The Gift Card is only valid within 1 region.", "description": "Update a Gift Card that can redeemed by its unique code. The Gift Card is only valid within 1 region.",
"x-authenticated": true, "x-authenticated": true,
"parameters": [ "parameters": [
{ {
@@ -19189,10 +19189,10 @@
} }
} }
}, },
"sales_channel_tax_line": { "shipping_method_tax_line": {
"title": "Sales Channel", "title": "Shipping Method Tax Line",
"description": "A Sales Channel", "description": "Shipping Method Tax Line",
"x-resourceId": "sales_channel_tax_line", "x-resourceId": "shipping_method_tax_line",
"required": [ "required": [
"shipping_method_id", "shipping_method_id",
"rate", "rate",
@@ -19319,7 +19319,7 @@
"type": "array", "type": "array",
"description": "Available if the relation `tax_lines` is expanded.", "description": "Available if the relation `tax_lines` is expanded.",
"items": { "items": {
"$ref": "#/components/schemas/tax_line" "$ref": "#/components/schemas/shipping_method_tax_line"
} }
}, },
"price": { "price": {
+11 -11
View File
@@ -1618,7 +1618,8 @@ paths:
'/discounts/{discount_id}/conditions': '/discounts/{discount_id}/conditions':
post: post:
operationId: PostDiscountsDiscountConditions operationId: PostDiscountsDiscountConditions
summary: >- summary: Create a DiscountCondition
description: >-
Creates a DiscountCondition. Only one of `products`, `product_types`, Creates a DiscountCondition. Only one of `products`, `product_types`,
`product_collections`, `product_tags`, and `customer_groups` should be `product_collections`, `product_tags`, and `customer_groups` should be
provided. provided.
@@ -1644,7 +1645,6 @@ paths:
the result. the result.
schema: schema:
type: string type: string
description: Creates a DiscountCondition
requestBody: requestBody:
content: content:
application/json: application/json:
@@ -2098,7 +2098,8 @@ paths:
$ref: '#/components/schemas/discount_condition' $ref: '#/components/schemas/discount_condition'
post: post:
operationId: PostDiscountsDiscountConditionsCondition operationId: PostDiscountsDiscountConditionsCondition
summary: >- summary: Update a DiscountCondition
description: >-
Updates a DiscountCondition. Only one of `products`, `product_types`, Updates a DiscountCondition. Only one of `products`, `product_types`,
`product_collections`, `product_tags`, and `customer_groups` should be `product_collections`, `product_tags`, and `customer_groups` should be
provided. provided.
@@ -2130,7 +2131,6 @@ paths:
the result. the result.
schema: schema:
type: string type: string
description: Updates a DiscountCondition
requestBody: requestBody:
content: content:
application/json: application/json:
@@ -3061,9 +3061,9 @@ paths:
$ref: '#/components/schemas/gift_card' $ref: '#/components/schemas/gift_card'
post: post:
operationId: PostGiftCardsGiftCard operationId: PostGiftCardsGiftCard
summary: Create a Gift Card summary: Update a Gift Card
description: >- description: >-
Creates a Gift Card that can redeemed by its unique code. The Gift Card Update a Gift Card that can redeemed by its unique code. The Gift Card
is only valid within 1 region. is only valid within 1 region.
x-authenticated: true x-authenticated: true
parameters: parameters:
@@ -14205,10 +14205,10 @@ components:
type: string type: string
description: The date with timezone at which the resource was deleted. description: The date with timezone at which the resource was deleted.
format: date-time format: date-time
sales_channel_tax_line: shipping_method_tax_line:
title: Sales Channel title: Shipping Method Tax Line
description: A Sales Channel description: Shipping Method Tax Line
x-resourceId: sales_channel_tax_line x-resourceId: shipping_method_tax_line
required: required:
- shipping_method_id - shipping_method_id
- rate - rate
@@ -14318,7 +14318,7 @@ components:
type: array type: array
description: Available if the relation `tax_lines` is expanded. description: Available if the relation `tax_lines` is expanded.
items: items:
$ref: '#/components/schemas/tax_line' $ref: '#/components/schemas/shipping_method_tax_line'
price: price:
description: >- description: >-
The amount to charge for the Shipping Method. The currency of the The amount to charge for the Shipping Method. The currency of the
@@ -59,7 +59,7 @@ properties:
type: array type: array
description: Available if the relation `tax_lines` is expanded. description: Available if the relation `tax_lines` is expanded.
items: items:
$ref: ./tax_line.yaml $ref: ./shipping_method_tax_line.yaml
price: price:
description: >- description: >-
The amount to charge for the Shipping Method. The currency of the price is The amount to charge for the Shipping Method. The currency of the price is
@@ -1,6 +1,6 @@
title: Sales Channel title: Shipping Method Tax Line
description: A Sales Channel description: Shipping Method Tax Line
x-resourceId: sales_channel_tax_line x-resourceId: shipping_method_tax_line
required: required:
- shipping_method_id - shipping_method_id
- rate - rate
@@ -1,6 +1,7 @@
post: post:
operationId: PostDiscountsDiscountConditions operationId: PostDiscountsDiscountConditions
summary: >- summary: Create a DiscountCondition
description: >-
Creates a DiscountCondition. Only one of `products`, `product_types`, Creates a DiscountCondition. Only one of `products`, `product_types`,
`product_collections`, `product_tags`, and `customer_groups` should be `product_collections`, `product_tags`, and `customer_groups` should be
provided. provided.
@@ -26,7 +27,6 @@ post:
result. result.
schema: schema:
type: string type: string
description: Creates a DiscountCondition
requestBody: requestBody:
content: content:
application/json: application/json:
@@ -92,7 +92,8 @@ get:
$ref: ../components/schemas/discount_condition.yaml $ref: ../components/schemas/discount_condition.yaml
post: post:
operationId: PostDiscountsDiscountConditionsCondition operationId: PostDiscountsDiscountConditionsCondition
summary: >- summary: Update a DiscountCondition
description: >-
Updates a DiscountCondition. Only one of `products`, `product_types`, Updates a DiscountCondition. Only one of `products`, `product_types`,
`product_collections`, `product_tags`, and `customer_groups` should be `product_collections`, `product_tags`, and `customer_groups` should be
provided. provided.
@@ -124,7 +125,6 @@ post:
result. result.
schema: schema:
type: string type: string
description: Updates a DiscountCondition
requestBody: requestBody:
content: content:
application/json: application/json:
+2 -2
View File
@@ -55,9 +55,9 @@ get:
$ref: ../components/schemas/gift_card.yaml $ref: ../components/schemas/gift_card.yaml
post: post:
operationId: PostGiftCardsGiftCard operationId: PostGiftCardsGiftCard
summary: Create a Gift Card summary: Update a Gift Card
description: >- description: >-
Creates a Gift Card that can redeemed by its unique code. The Gift Card is Update a Gift Card that can redeemed by its unique code. The Gift Card is
only valid within 1 region. only valid within 1 region.
x-authenticated: true x-authenticated: true
parameters: parameters:
+5 -5
View File
@@ -7898,10 +7898,10 @@
} }
} }
}, },
"sales_channel_tax_line": { "shipping_method_tax_line": {
"title": "Sales Channel", "title": "Shipping Method Tax Line",
"description": "A Sales Channel", "description": "Shipping Method Tax Line",
"x-resourceId": "sales_channel_tax_line", "x-resourceId": "shipping_method_tax_line",
"required": [ "required": [
"shipping_method_id", "shipping_method_id",
"rate", "rate",
@@ -8028,7 +8028,7 @@
"type": "array", "type": "array",
"description": "Available if the relation `tax_lines` is expanded.", "description": "Available if the relation `tax_lines` is expanded.",
"items": { "items": {
"$ref": "#/components/schemas/tax_line" "$ref": "#/components/schemas/shipping_method_tax_line"
} }
}, },
"price": { "price": {
+5 -5
View File
@@ -6232,10 +6232,10 @@ components:
type: string type: string
description: The date with timezone at which the resource was deleted. description: The date with timezone at which the resource was deleted.
format: date-time format: date-time
sales_channel_tax_line: shipping_method_tax_line:
title: Sales Channel title: Shipping Method Tax Line
description: A Sales Channel description: Shipping Method Tax Line
x-resourceId: sales_channel_tax_line x-resourceId: shipping_method_tax_line
required: required:
- shipping_method_id - shipping_method_id
- rate - rate
@@ -6345,7 +6345,7 @@ components:
type: array type: array
description: Available if the relation `tax_lines` is expanded. description: Available if the relation `tax_lines` is expanded.
items: items:
$ref: '#/components/schemas/tax_line' $ref: '#/components/schemas/shipping_method_tax_line'
price: price:
description: >- description: >-
The amount to charge for the Shipping Method. The currency of the The amount to charge for the Shipping Method. The currency of the
@@ -59,7 +59,7 @@ properties:
type: array type: array
description: Available if the relation `tax_lines` is expanded. description: Available if the relation `tax_lines` is expanded.
items: items:
$ref: ./tax_line.yaml $ref: ./shipping_method_tax_line.yaml
price: price:
description: >- description: >-
The amount to charge for the Shipping Method. The currency of the price is The amount to charge for the Shipping Method. The currency of the price is
@@ -1,6 +1,6 @@
title: Sales Channel title: Shipping Method Tax Line
description: A Sales Channel description: Shipping Method Tax Line
x-resourceId: sales_channel_tax_line x-resourceId: shipping_method_tax_line
required: required:
- shipping_method_id - shipping_method_id
- rate - rate