asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

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

Browse Source 
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-08-29 14:39:35 +03:00
committed by GitHub
parent 076b41bb89
commit b98a09dd9f
11 changed files with 46 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/api/admin-spec3.json
View File

@@ -2372,7 +2372,8 @@
"/discounts/{discount_id}/conditions": {
"post": {
"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,
"parameters": [
{
@@ -2401,7 +2402,6 @@
}
}
],
"description": "Creates a DiscountCondition",
"requestBody": {
"content": {
"application/json": {
@@ -2997,7 +2997,8 @@
},
"post": {
"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,
"parameters": [
{
@@ -3035,7 +3036,6 @@
}
}
],
"description": "Updates a DiscountCondition",
"requestBody": {
"content": {
"application/json": {
@@ -4337,8 +4337,8 @@
},
"post": {
"operationId": "PostGiftCardsGiftCard",
"summary": "Create a Gift Card",
"description": "Creates a Gift Card that can redeemed by its unique code. The Gift Card is only valid within 1 region.",
"summary": "Update a Gift Card",
"description": "Update a Gift Card that can redeemed by its unique code. The Gift Card is only valid within 1 region.",
"x-authenticated": true,
"parameters": [
{
@@ -19189,10 +19189,10 @@
}
}
},
"sales_channel_tax_line": {
"title": "Sales Channel",
"description": "A Sales Channel",
"x-resourceId": "sales_channel_tax_line",
"shipping_method_tax_line": {
"title": "Shipping Method Tax Line",
"description": "Shipping Method Tax Line",
"x-resourceId": "shipping_method_tax_line",
"required": [
"shipping_method_id",
"rate",
@@ -19319,7 +19319,7 @@
"type": "array",
"description": "Available if the relation `tax_lines` is expanded.",
"items": {
"$ref": "#/components/schemas/tax_line"
"$ref": "#/components/schemas/shipping_method_tax_line"
}
},
"price": {

22
docs/api/admin-spec3.yaml
View File

@@ -1618,7 +1618,8 @@ paths:
'/discounts/{discount_id}/conditions':
post:
operationId: PostDiscountsDiscountConditions
summary: >-
summary: Create a DiscountCondition
description: >-
Creates a DiscountCondition. Only one of `products`, `product_types`,
`product_collections`, `product_tags`, and `customer_groups` should be
provided.
@@ -1644,7 +1645,6 @@ paths:
the result.
schema:
type: string
description: Creates a DiscountCondition
requestBody:
content:
application/json:
@@ -2098,7 +2098,8 @@ paths:
$ref: '#/components/schemas/discount_condition'
post:
operationId: PostDiscountsDiscountConditionsCondition
summary: >-
summary: Update a DiscountCondition
description: >-
Updates a DiscountCondition. Only one of `products`, `product_types`,
`product_collections`, `product_tags`, and `customer_groups` should be
provided.
@@ -2130,7 +2131,6 @@ paths:
the result.
schema:
type: string
description: Updates a DiscountCondition
requestBody:
content:
application/json:
@@ -3061,9 +3061,9 @@ paths:
$ref: '#/components/schemas/gift_card'
post:
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
Update a Gift Card that can redeemed by its unique code. The Gift Card
is only valid within 1 region.
x-authenticated: true
parameters:
@@ -14205,10 +14205,10 @@ components:
type: string
description: The date with timezone at which the resource was deleted.
format: date-time
sales_channel_tax_line:
title: Sales Channel
description: A Sales Channel
x-resourceId: sales_channel_tax_line
shipping_method_tax_line:
title: Shipping Method Tax Line
description: Shipping Method Tax Line
x-resourceId: shipping_method_tax_line
required:
- shipping_method_id
- rate
@@ -14318,7 +14318,7 @@ components:
type: array
description: Available if the relation `tax_lines` is expanded.
items:
$ref: '#/components/schemas/tax_line'
$ref: '#/components/schemas/shipping_method_tax_line'
price:
description: >-
The amount to charge for the Shipping Method. The currency of the

2
docs/api/admin/components/schemas/shipping_method.yaml
View File

@@ -59,7 +59,7 @@ properties:
type: array
description: Available if the relation `tax_lines` is expanded.
items:
$ref: ./tax_line.yaml
$ref: ./shipping_method_tax_line.yaml
price:
description: >-
The amount to charge for the Shipping Method. The currency of the price is

6
docs/api/admin/components/schemas/sales_channel_tax_line.yaml → docs/api/admin/components/schemas/shipping_method_tax_line.yaml
View File

@@ -1,6 +1,6 @@
title: Sales Channel
description: A Sales Channel
x-resourceId: sales_channel_tax_line
title: Shipping Method Tax Line
description: Shipping Method Tax Line
x-resourceId: shipping_method_tax_line
required:
- shipping_method_id
- rate

4
docs/api/admin/paths/discounts_{discount_id}_conditions.yaml
View File

@@ -1,6 +1,7 @@
post:
operationId: PostDiscountsDiscountConditions
summary: >-
summary: Create a DiscountCondition
description: >-
Creates a DiscountCondition. Only one of `products`, `product_types`,
`product_collections`, `product_tags`, and `customer_groups` should be
provided.
@@ -26,7 +27,6 @@ post:
result.
schema:
type: string
description: Creates a DiscountCondition
requestBody:
content:
application/json:

4
docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}.yaml
View File

@@ -92,7 +92,8 @@ get:
$ref: ../components/schemas/discount_condition.yaml
post:
operationId: PostDiscountsDiscountConditionsCondition
summary: >-
summary: Update a DiscountCondition
description: >-
Updates a DiscountCondition. Only one of `products`, `product_types`,
`product_collections`, `product_tags`, and `customer_groups` should be
provided.
@@ -124,7 +125,6 @@ post:
result.
schema:
type: string
description: Updates a DiscountCondition
requestBody:
content:
application/json:

4
docs/api/admin/paths/gift-cards_{id}.yaml
View File

@@ -55,9 +55,9 @@ get:
$ref: ../components/schemas/gift_card.yaml
post:
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
Update a Gift Card that can redeemed by its unique code. The Gift Card is
only valid within 1 region.
x-authenticated: true
parameters:

10
docs/api/store-spec3.json
View File

@@ -7898,10 +7898,10 @@
}
}
},
"sales_channel_tax_line": {
"title": "Sales Channel",
"description": "A Sales Channel",
"x-resourceId": "sales_channel_tax_line",
"shipping_method_tax_line": {
"title": "Shipping Method Tax Line",
"description": "Shipping Method Tax Line",
"x-resourceId": "shipping_method_tax_line",
"required": [
"shipping_method_id",
"rate",
@@ -8028,7 +8028,7 @@
"type": "array",
"description": "Available if the relation `tax_lines` is expanded.",
"items": {
"$ref": "#/components/schemas/tax_line"
"$ref": "#/components/schemas/shipping_method_tax_line"
}
},
"price": {

10
docs/api/store-spec3.yaml
View File

@@ -6232,10 +6232,10 @@ components:
type: string
description: The date with timezone at which the resource was deleted.
format: date-time
sales_channel_tax_line:
title: Sales Channel
description: A Sales Channel
x-resourceId: sales_channel_tax_line
shipping_method_tax_line:
title: Shipping Method Tax Line
description: Shipping Method Tax Line
x-resourceId: shipping_method_tax_line
required:
- shipping_method_id
- rate
@@ -6345,7 +6345,7 @@ components:
type: array
description: Available if the relation `tax_lines` is expanded.
items:
$ref: '#/components/schemas/tax_line'
$ref: '#/components/schemas/shipping_method_tax_line'
price:
description: >-
The amount to charge for the Shipping Method. The currency of the

2
docs/api/store/components/schemas/shipping_method.yaml
View File

@@ -59,7 +59,7 @@ properties:
type: array
description: Available if the relation `tax_lines` is expanded.
items:
$ref: ./tax_line.yaml
$ref: ./shipping_method_tax_line.yaml
price:
description: >-
The amount to charge for the Shipping Method. The currency of the price is

6
docs/api/store/components/schemas/sales_channel_tax_line.yaml → docs/api/store/components/schemas/shipping_method_tax_line.yaml
View File

@@ -1,6 +1,6 @@
title: Sales Channel
description: A Sales Channel
x-resourceId: sales_channel_tax_line
title: Shipping Method Tax Line
description: Shipping Method Tax Line
x-resourceId: shipping_method_tax_line
required:
- shipping_method_id
- rate