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

chore(docs): manually generated API reference to fix load issue (#3286)

Browse Source
This commit is contained in:
Shahed Nasser
2023-02-17 15:23:20 +02:00
committed by GitHub
parent 9690f07bc0
commit d1abe7cd85
60 changed files with 6622 additions and 6622 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api/admin/components/schemas/Cart.yaml
View File

@@ -82,12 +82,12 @@ properties:
payment_session:
description: The selected payment session in the cart.
nullable: true
$ref: ./PaymentSession.yaml
type: object
payment_sessions:
description: The payment sessions created on the cart.
type: array
items:
$ref: ./PaymentSession.yaml
type: object
payment_id:
description: The payment's ID if available
nullable: true

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

@@ -20,7 +20,7 @@ properties:
claim_item:
description: A claim item object. Available if the relation `claim_item` is expanded.
nullable: true
$ref: ./ClaimItem.yaml
type: object
url:
description: The URL of the image
type: string

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

@@ -54,4 +54,4 @@ properties:
region:
description: A region object. Available if the relation `region` is expanded.
nullable: true
$ref: ./Region.yaml
type: object

4
docs/api/admin/components/schemas/CustomerGroup.yaml
View File

@@ -23,14 +23,14 @@ properties:
`customers` is expanded.
type: array
items:
$ref: ./Customer.yaml
type: object
price_lists:
description: >-
The price lists that are associated with the customer group. Available if
the relation `price_lists` is expanded.
type: array
items:
$ref: ./PriceList.yaml
type: object
created_at:
description: The date with timezone at which the resource was created.
type: string

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

@@ -59,7 +59,7 @@ properties:
parent_discount:
description: Available if the relation `parent_discount` is expanded.
nullable: true
$ref: ./Discount.yaml
type: object
starts_at:
description: The time at which the discount can be used.
type: string

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

@@ -54,7 +54,7 @@ properties:
used. Available if the relation `conditions` is expanded.
type: array
items:
$ref: ./DiscountCondition.yaml
type: object
created_at:
description: The date with timezone at which the resource was created.
type: string

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

@@ -19,7 +19,7 @@ properties:
fulfillment:
description: A fulfillment object. Available if the relation `fulfillment` is expanded.
nullable: true
$ref: ./Fulfillment.yaml
type: object
item:
description: Available if the relation `item` is expanded.
nullable: true

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

@@ -20,7 +20,7 @@ properties:
item:
description: Available if the relation `item` is expanded.
nullable: true
$ref: ./LineItem.yaml
type: object
description:
description: The line item's adjustment description
type: string

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

@@ -35,7 +35,7 @@ properties:
item:
description: Available if the relation `item` is expanded.
nullable: true
$ref: ./LineItem.yaml
type: object
created_at:
description: The date with timezone at which the resource was created.
type: string

6
docs/api/admin/components/schemas/MoneyAmount.yaml
View File

@@ -62,7 +62,7 @@ properties:
price_list:
description: Available if the relation `price_list` is expanded.
nullable: true
$ref: ./PriceList.yaml
type: object
variant_id:
description: The id of the Product Variant contained in the Line Item.
nullable: true
@@ -73,7 +73,7 @@ properties:
The Product Variant contained in the Line Item. Available if the relation
`variant` is expanded.
nullable: true
$ref: ./ProductVariant.yaml
type: object
region_id:
description: The region's ID
nullable: true
@@ -82,7 +82,7 @@ properties:
region:
description: A region object. Available if the relation `region` is expanded.
nullable: true
$ref: ./Region.yaml
type: object
created_at:
description: The date with timezone at which the resource was created.
type: string

4
docs/api/admin/components/schemas/Notification.yaml
View File

@@ -64,14 +64,14 @@ properties:
parent_notification:
description: Available if the relation `parent_notification` is expanded.
nullable: true
$ref: ./Notification.yaml
type: object
resends:
description: >-
The resends that have been completed after the original Notification.
Available if the relation `resends` is expanded.
type: array
items:
$ref: ./Notification.yaml
type: object
provider_id:
description: The id of the Notification Provider that handles the Notification.
nullable: true

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

@@ -29,7 +29,7 @@ properties:
order_edit:
description: Available if the relation `order_edit` is expanded.
nullable: true
$ref: ./OrderEdit.yaml
type: object
original_line_item_id:
description: The ID of the original line item in the order
nullable: true

6
docs/api/admin/components/schemas/ProductCategory.yaml
View File

@@ -48,7 +48,7 @@ properties:
description: Available if the relation `category_children` are expanded.
type: array
items:
$ref: ./ProductCategory.yaml
type: object
parent_category_id:
description: The ID of the parent category.
nullable: true
@@ -59,14 +59,14 @@ properties:
A product category object. Available if the relation `parent_category` is
expanded.
nullable: true
$ref: ./ProductCategory.yaml
type: object
products:
description: >-
Products associated with category. Available if the relation `products` is
expanded.
type: array
items:
$ref: ./Product.yaml
type: object
created_at:
description: The date with timezone at which the resource was created.
type: string

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

@@ -31,7 +31,7 @@ properties:
relation `products` is expanded.
type: array
items:
$ref: ./Product.yaml
type: object
created_at:
description: The date with timezone at which the resource was created.
type: string

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

@@ -35,7 +35,7 @@ properties:
product:
description: A product object. Available if the relation `product` is expanded.
nullable: true
$ref: ./Product.yaml
type: object
created_at:
description: The date with timezone at which the resource was created.
type: string

4
docs/api/admin/components/schemas/ProductOptionValue.yaml
View File

@@ -31,7 +31,7 @@ properties:
option:
description: Available if the relation `option` is expanded.
nullable: true
$ref: ./ProductOption.yaml
type: object
variant_id:
description: >-
The ID of the Product Variant that the Product Option Value is defined
@@ -41,7 +41,7 @@ properties:
variant:
description: Available if the relation `variant` is expanded.
nullable: true
$ref: ./ProductVariant.yaml
type: object
created_at:
description: The date with timezone at which the resource was created.
type: string

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

@@ -45,7 +45,7 @@ properties:
product:
description: A product object. Available if the relation `product` is expanded.
nullable: true
$ref: ./Product.yaml
type: object
prices:
description: >-
The Money Amounts defined for the Product Variant. Each Money Amount

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

@@ -25,7 +25,7 @@ properties:
variant:
description: A ProductVariant object. Available if the relation `variant` is expanded.
nullable: true
$ref: ./ProductVariant.yaml
type: object
required_quantity:
description: >-
The quantity of an inventory item required for one quantity of the

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

@@ -25,7 +25,7 @@ properties:
return_order:
description: Available if the relation `return_order` is expanded.
nullable: true
$ref: ./Return.yaml
type: object
item:
description: Available if the relation `item` is expanded.
nullable: true

4
docs/api/admin/components/schemas/ReturnReason.yaml
View File

@@ -39,10 +39,10 @@ properties:
parent_return_reason:
description: Available if the relation `parent_return_reason` is expanded.
nullable: true
$ref: ./ReturnReason.yaml
type: object
return_reason_children:
description: Available if the relation `return_reason_children` is expanded.
$ref: ./ReturnReason.yaml
type: object
created_at:
description: The date with timezone at which the resource was created.
type: string

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

@@ -25,7 +25,7 @@ properties:
The sales channel the location is associated with. Available if the
relation `sales_channel` is expanded.
nullable: true
$ref: ./SalesChannel.yaml
type: object
created_at:
description: The date with timezone at which the resource was created.
type: string

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

@@ -35,7 +35,7 @@ properties:
shipping_method:
description: Available if the relation `shipping_method` is expanded.
nullable: true
$ref: ./ShippingMethod.yaml
type: object
created_at:
description: The date with timezone at which the resource was created.
type: string

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

@@ -40,7 +40,7 @@ properties:
region:
description: A region object. Available if the relation `region` is expanded.
nullable: true
$ref: ./Region.yaml
type: object
profile_id:
description: >-
The ID of the Shipping Profile that the shipping option belongs to.

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

@@ -23,7 +23,7 @@ properties:
shipping_option:
description: Available if the relation `shipping_option` is expanded.
nullable: true
$ref: ./ShippingOption.yaml
type: object
type:
description: >-
The type of the requirement, this defines how the value will be compared

4
docs/api/admin/components/schemas/ShippingProfile.yaml
View File

@@ -38,7 +38,7 @@ properties:
Available if the relation `products` is expanded.
type: array
items:
$ref: ./Product.yaml
type: object
shipping_options:
description: >-
The Shipping Options that can be used to fulfill the Products in the
@@ -46,7 +46,7 @@ properties:
expanded.
type: array
items:
$ref: ./ShippingOption.yaml
type: object
created_at:
description: The date with timezone at which the resource was created.
type: string

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

@@ -38,7 +38,7 @@ properties:
region:
description: A region object. Available if the relation `region` is expanded.
nullable: true
$ref: ./Region.yaml
type: object
products:
description: >-
The products that belong to this tax rate. Available if the relation

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

@@ -35,7 +35,7 @@ properties:
fulfillment:
description: Available if the relation `fulfillment` is expanded.
nullable: true
$ref: ./Fulfillment.yaml
type: object
idempotency_key:
description: >-
Randomly generated key used to continue the completion of a process in

80
docs/api/admin/openapi.yaml
View File

@@ -197,6 +197,10 @@ paths:
$ref: paths/currencies.yaml
/currencies/{code}:
$ref: paths/currencies_{code}.yaml
/customers:
$ref: paths/customers.yaml
/customers/{id}:
$ref: paths/customers_{id}.yaml
/customer-groups/{id}/customers/batch:
$ref: paths/customer-groups_{id}_customers_batch.yaml
/customer-groups:
@@ -205,10 +209,6 @@ paths:
$ref: paths/customer-groups_{id}.yaml
/customer-groups/{id}/customers:
$ref: paths/customer-groups_{id}_customers.yaml
/customers:
$ref: paths/customers.yaml
/customers/{id}:
$ref: paths/customers_{id}.yaml
/discounts/{id}/regions/{region_id}:
$ref: paths/discounts_{id}_regions_{region_id}.yaml
/discounts/{discount_id}/conditions/{condition_id}/batch:
@@ -243,14 +243,6 @@ paths:
$ref: paths/gift-cards.yaml
/gift-cards/{id}:
$ref: paths/gift-cards_{id}.yaml
/inventory-items/{id}/location-levels:
$ref: paths/inventory-items_{id}_location-levels.yaml
/inventory-items/{id}:
$ref: paths/inventory-items_{id}.yaml
/inventory-items/{id}/location-levels/{location_id}:
$ref: paths/inventory-items_{id}_location-levels_{location_id}.yaml
/inventory-items:
$ref: paths/inventory-items.yaml
/invites/accept:
$ref: paths/invites_accept.yaml
/invites:
@@ -259,14 +251,22 @@ paths:
$ref: paths/invites_{invite_id}.yaml
/invites/{invite_id}/resend:
$ref: paths/invites_{invite_id}_resend.yaml
/notes:
$ref: paths/notes.yaml
/notes/{id}:
$ref: paths/notes_{id}.yaml
/inventory-items/{id}/location-levels:
$ref: paths/inventory-items_{id}_location-levels.yaml
/inventory-items/{id}:
$ref: paths/inventory-items_{id}.yaml
/inventory-items/{id}/location-levels/{location_id}:
$ref: paths/inventory-items_{id}_location-levels_{location_id}.yaml
/inventory-items:
$ref: paths/inventory-items.yaml
/notifications:
$ref: paths/notifications.yaml
/notifications/{id}/resend:
$ref: paths/notifications_{id}_resend.yaml
/notes:
$ref: paths/notes.yaml
/notes/{id}:
$ref: paths/notes_{id}.yaml
/order-edits/{id}/items:
$ref: paths/order-edits_{id}_items.yaml
/order-edits/{id}/cancel:
@@ -283,6 +283,10 @@ paths:
$ref: paths/order-edits_{id}.yaml
/order-edits/{id}/request:
$ref: paths/order-edits_{id}_request.yaml
/payment-collections/{id}:
$ref: paths/payment-collections_{id}.yaml
/payment-collections/{id}/authorize:
$ref: paths/payment-collections_{id}_authorize.yaml
/orders/{id}/shipping-methods:
$ref: paths/orders_{id}_shipping-methods.yaml
/orders/{id}/archive:
@@ -337,10 +341,6 @@ paths:
$ref: paths/orders_{id}_return.yaml
/order/{id}/claims/{claim_id}:
$ref: paths/order_{id}_claims_{claim_id}.yaml
/payment-collections/{id}:
$ref: paths/payment-collections_{id}.yaml
/payment-collections/{id}/authorize:
$ref: paths/payment-collections_{id}_authorize.yaml
/payments/{id}/capture:
$ref: paths/payments_{id}_capture.yaml
/payments/{id}:
@@ -359,12 +359,6 @@ paths:
$ref: paths/price-lists_{id}_variants_{variant_id}_prices.yaml
/price-lists/{id}/products:
$ref: paths/price-lists_{id}_products.yaml
/product-categories/{id}/products/batch:
$ref: paths/product-categories_{id}_products_batch.yaml
/product-categories:
$ref: paths/product-categories.yaml
/product-categories/{id}:
$ref: paths/product-categories_{id}.yaml
/product-tags:
$ref: paths/product-tags.yaml
/product-types:
@@ -387,6 +381,12 @@ paths:
$ref: paths/products_types.yaml
/products/{id}/metadata:
$ref: paths/products_{id}_metadata.yaml
/product-categories/{id}/products/batch:
$ref: paths/product-categories_{id}_products_batch.yaml
/product-categories:
$ref: paths/product-categories.yaml
/product-categories/{id}:
$ref: paths/product-categories_{id}.yaml
/publishable-api-keys/{id}/sales-channels/batch:
$ref: paths/publishable-api-keys_{id}_sales-channels_batch.yaml
/publishable-api-keys:
@@ -425,12 +425,6 @@ paths:
$ref: paths/return-reasons.yaml
/return-reasons/{id}:
$ref: paths/return-reasons_{id}.yaml
/returns/{id}/cancel:
$ref: paths/returns_{id}_cancel.yaml
/returns:
$ref: paths/returns.yaml
/returns/{id}/receive:
$ref: paths/returns_{id}_receive.yaml
/sales-channels/{id}/products/batch:
$ref: paths/sales-channels_{id}_products_batch.yaml
/sales-channels/{id}/stock-locations:
@@ -439,6 +433,12 @@ paths:
$ref: paths/sales-channels.yaml
/sales-channels/{id}:
$ref: paths/sales-channels_{id}.yaml
/returns/{id}/cancel:
$ref: paths/returns_{id}_cancel.yaml
/returns:
$ref: paths/returns.yaml
/returns/{id}/receive:
$ref: paths/returns_{id}_receive.yaml
/shipping-options:
$ref: paths/shipping-options.yaml
/shipping-options/{id}:
@@ -451,14 +451,6 @@ paths:
$ref: paths/stock-locations.yaml
/stock-locations/{id}:
$ref: paths/stock-locations_{id}.yaml
/store/currencies/{code}:
$ref: paths/store_currencies_{code}.yaml
/store:
$ref: paths/store.yaml
/store/payment-providers:
$ref: paths/store_payment-providers.yaml
/store/tax-providers:
$ref: paths/store_tax-providers.yaml
/swaps/{id}:
$ref: paths/swaps_{id}.yaml
/swaps:
@@ -473,6 +465,14 @@ paths:
$ref: paths/tax-rates.yaml
/tax-rates/{id}:
$ref: paths/tax-rates_{id}.yaml
/store/currencies/{code}:
$ref: paths/store_currencies_{code}.yaml
/store:
$ref: paths/store.yaml
/store/payment-providers:
$ref: paths/store_payment-providers.yaml
/store/tax-providers:
$ref: paths/store_tax-providers.yaml
/uploads/protected:
$ref: paths/uploads_protected.yaml
/uploads: