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

chore(docs): Updated API Reference (v2) (#8954)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-09-03 07:18:42 +00:00
committed by GitHub
parent 6652db45ef
commit edc19e748b
157 changed files with 16009 additions and 35955 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
www/apps/api-reference/specs/admin/components/schemas/AdminCreateInventoryItem.yaml
View File

@@ -1,5 +1,6 @@
type: object
description: SUMMARY
x-schemaName: AdminCreateInventoryItem
properties:
sku:
type: string
@@ -56,4 +57,3 @@ properties:
metadata:
type: object
description: The inventory item's metadata.
x-schemaName: AdminCreateInventoryItem

8
www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductCategory.yaml
View File

@@ -1,5 +1,6 @@
type: object
description: SUMMARY
x-schemaName: AdminCreateProductCategory
required:
- name
properties:
@@ -27,11 +28,10 @@ properties:
type: string
title: parent_category_id
description: The product category's parent category id.
metadata:
type: object
description: The product category's metadata.
rank:
type: number
title: rank
description: The product category's rank.
x-schemaName: AdminCreateProductCategory
metadata:
type: object
description: The product category's metadata.

2
www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductTag.yaml
View File

@@ -1,5 +1,6 @@
type: object
description: SUMMARY
x-schemaName: AdminCreateProductTag
required:
- value
properties:
@@ -10,4 +11,3 @@ properties:
metadata:
type: object
description: The product tag's metadata.
x-schemaName: AdminCreateProductTag

2
www/apps/api-reference/specs/admin/components/schemas/AdminCreateRefundReason.yaml
View File

@@ -1,5 +1,6 @@
type: object
description: SUMMARY
x-schemaName: AdminCreateRefundReason
required:
- label
properties:
@@ -11,4 +12,3 @@ properties:
type: string
title: description
description: The refund reason's description.
x-schemaName: AdminCreateRefundReason

10
www/apps/api-reference/specs/admin/components/schemas/AdminCreateRegion.yaml
View File

@@ -1,5 +1,6 @@
type: object
description: SUMMARY
x-schemaName: AdminCreateRegion
required:
- name
- currency_code
@@ -23,6 +24,10 @@ properties:
type: boolean
title: automatic_taxes
description: The region's automatic taxes.
is_tax_inclusive:
type: boolean
title: is_tax_inclusive
description: The region's is tax inclusive.
payment_providers:
type: array
description: The region's payment providers.
@@ -33,8 +38,3 @@ properties:
metadata:
type: object
description: The region's metadata.
is_tax_inclusive:
type: boolean
title: is_tax_inclusive
description: The region's is tax inclusive.
x-schemaName: AdminCreateRegion

2
www/apps/api-reference/specs/admin/components/schemas/AdminCreateReservation.yaml
View File

@@ -1,5 +1,6 @@
type: object
description: SUMMARY
x-schemaName: AdminCreateReservation
required:
- location_id
- inventory_item_id
@@ -28,4 +29,3 @@ properties:
metadata:
type: object
description: The reservation's metadata.
x-schemaName: AdminCreateReservation

7
www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml
View File

@@ -1,5 +1,6 @@
type: object
description: SUMMARY
x-schemaName: AdminCreateShippingOption
required:
- name
- service_zone_id
@@ -26,9 +27,10 @@ properties:
description: The shipping option's data.
price_type:
type: string
description: The shipping option's price type.
enum:
- calculated
- flat
- calculated
provider_id:
type: string
title: provider_id
@@ -42,6 +44,7 @@ properties:
oneOf:
- type: object
description: The price's prices.
x-schemaName: AdminCreateShippingOptionPriceWithCurrency
required:
- currency_code
- amount
@@ -56,6 +59,7 @@ properties:
description: The price's amount.
- type: object
description: The price's prices.
x-schemaName: AdminCreateShippingOptionPriceWithRegion
required:
- region_id
- amount
@@ -73,4 +77,3 @@ properties:
description: The shipping option's rules.
items:
$ref: ./AdminCreateShippingOptionRule.yaml
x-schemaName: AdminCreateShippingOption

11
www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOptionRule.yaml
View File

@@ -1,5 +1,6 @@
type: object
description: The rule's rules.
x-schemaName: AdminCreateShippingOptionRule
required:
- operator
- attribute
@@ -7,14 +8,15 @@ required:
properties:
operator:
type: string
description: The rule's operator.
enum:
- in
- gt
- lt
- eq
- ne
- gt
- gte
- lt
- in
- lte
- gte
- nin
attribute:
type: string
@@ -31,4 +33,3 @@ properties:
type: string
title: value
description: The value's details.
x-schemaName: AdminCreateShippingOptionRule

18
www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingProfile.yaml Normal file
View File

@@ -0,0 +1,18 @@
type: object
description: SUMMARY
required:
- name
- type
properties:
name:
type: string
title: name
description: The shipping profile's name.
type:
type: string
title: type
description: The shipping profile's type.
metadata:
type: object
description: The shipping profile's metadata.
x-schemaName: AdminCreateShippingProfile

6
www/apps/api-reference/specs/admin/components/schemas/AdminDeletePaymentCollectionResponse.yaml
View File

@@ -1,5 +1,6 @@
type: object
description: SUMMARY
x-schemaName: AdminDeletePaymentCollectionResponse
required:
- id
- object
@@ -12,10 +13,9 @@ properties:
object:
type: string
title: object
description: The name of the deleted object.
description: SUMMARY
default: payment-collection
deleted:
type: boolean
title: deleted
description: Whether the payment collection was deleted.
x-schemaName: AdminDeletePaymentCollectionResponse
description: SUMMARY

4
www/apps/api-reference/specs/admin/components/schemas/AdminExchangeDeleteResponse.yaml
View File

@@ -1,5 +1,6 @@
type: object
description: SUMMARY
x-schemaName: AdminExchangeDeleteResponse
required:
- id
- object
@@ -17,5 +18,4 @@ properties:
deleted:
type: boolean
title: deleted
description: Whether the exchange was deleted.
x-schemaName: AdminExchangeDeleteResponse
description: Whether the Exchange was deleted.

22
www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSet.yaml
View File

@@ -1,5 +1,15 @@
type: object
description: The fulfillment set that the service zone belongs to.
description: The fulfillment set's parent.
x-schemaName: AdminFulfillmentSet
required:
- id
- name
- type
- location
- service_zones
- created_at
- updated_at
- deleted_at
properties:
id:
type: string
@@ -35,13 +45,3 @@ properties:
format: date-time
title: deleted_at
description: The parent's deleted at.
required:
- id
- name
- type
- location
- service_zones
- created_at
- updated_at
- deleted_at
x-schemaName: AdminFulfillmentSet

458
www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml
View File

@@ -1,18 +1,18 @@
type: object
description: The product's variants.
description: SUMMARY
x-schemaName: AdminProductVariantParams
properties:
q:
type: string
title: q
description: The variant's q.
description: The product's q.
id:
oneOf:
- type: string
title: id
description: The variant's ID.
description: The product's ID.
- type: array
description: The variant's ID.
description: The product's ID.
items:
type: string
title: id
@@ -20,14 +20,14 @@ properties:
manage_inventory:
type: boolean
title: manage_inventory
description: The variant's manage inventory.
description: The product's manage inventory.
allow_backorder:
type: boolean
title: allow_backorder
description: The variant's allow backorder.
description: The product's allow backorder.
created_at:
type: object
description: The variant's created at.
description: The product's created at.
properties:
$and:
type: array
@@ -81,6 +81,150 @@ properties:
description: Filter by values not matching the conditions in this parameter.
- type: object
description: Filter by values not matching the conditions in this parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers
and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful
for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: Filter by values not matching the conditions in this parameter.
items:
@@ -154,7 +298,7 @@ properties:
description: Filter by whether a value for this parameter exists (not `null`).
updated_at:
type: object
description: The variant's updated at.
description: The product's updated at.
properties:
$and:
type: array
@@ -208,6 +352,150 @@ properties:
description: Filter by values not matching the conditions in this parameter.
- type: object
description: Filter by values not matching the conditions in this parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers
and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful
for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: Filter by values not matching the conditions in this parameter.
items:
@@ -281,7 +569,7 @@ properties:
description: Filter by whether a value for this parameter exists (not `null`).
deleted_at:
type: object
description: The variant's deleted at.
description: The product's deleted at.
properties:
$and:
type: array
@@ -335,6 +623,150 @@ properties:
description: Filter by values not matching the conditions in this parameter.
- type: object
description: Filter by values not matching the conditions in this parameter.
properties:
$and:
type: array
description: >-
Join query parameters with an AND condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $and
$or:
type: array
description: >-
Join query parameters with an OR condition. Each object's
content is the same type as the expected query parameters.
items:
type: object
title: $or
$eq:
oneOf:
- type: string
title: $eq
description: Filter by an exact match.
- type: array
description: Filter by an exact match.
items:
type: string
title: $eq
description: Filter by an exact match.
$ne:
type: string
title: $ne
description: Filter by values not equal to this parameter.
$in:
type: array
description: Filter by values in this array.
items:
type: string
title: $in
description: Filter by values in this array.
$nin:
type: array
description: Filter by values not in this array.
items:
type: string
title: $nin
description: Filter by values not in this array.
$not:
oneOf:
- type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
- type: object
description: >-
Filter by values not matching the conditions in this
parameter.
- type: array
description: >-
Filter by values not matching the conditions in this
parameter.
items:
type: string
title: $not
description: >-
Filter by values not matching the conditions in this
parameter.
$gt:
type: string
title: $gt
description: >-
Filter by values greater than this parameter. Useful for
numbers and dates only.
$gte:
type: string
title: $gte
description: >-
Filter by values greater than or equal to this parameter.
Useful for numbers and dates only.
$lt:
type: string
title: $lt
description: >-
Filter by values less than this parameter. Useful for numbers
and dates only.
$lte:
type: string
title: $lte
description: >-
Filter by values less than or equal to this parameter. Useful
for numbers and dates only.
$like:
type: string
title: $like
description: Apply a `like` filter. Useful for strings only.
$re:
type: string
title: $re
description: Apply a regex filter. Useful for strings only.
$ilike:
type: string
title: $ilike
description: >-
Apply a case-insensitive `like` filter. Useful for strings
only.
$fulltext:
type: string
title: $fulltext
description: Filter to apply on full-text properties.
$overlap:
type: array
description: >-
Filter arrays that have overlapping values with this
parameter.
items:
type: string
title: $overlap
description: >-
Filter arrays that have overlapping values with this
parameter.
$contains:
type: array
description: >-
Filter arrays that contain some of the values of this
parameter.
items:
type: string
title: $contains
description: >-
Filter arrays that contain some of the values of this
parameter.
$contained:
type: array
description: Filter arrays that contain all values of this parameter.
items:
type: string
title: $contained
description: Filter arrays that contain all values of this parameter.
$exists:
type: boolean
title: $exists
description: >-
Filter by whether a value for this parameter exists (not
`null`).
- type: array
description: Filter by values not matching the conditions in this parameter.
items:
@@ -409,19 +841,19 @@ properties:
limit:
type: number
title: limit
description: The variant's limit.
description: The product's limit.
offset:
type: number
title: offset
description: The variant's offset.
description: The product's offset.
order:
type: string
title: order
description: The variant's order.
description: The product's order.
fields:
type: string
title: fields
description: The variant's fields.
description: The product's fields.
$and:
type: array
description: >-

4
www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonDeleteResponse.yaml
View File

@@ -1,5 +1,6 @@
type: object
description: SUMMARY
x-schemaName: AdminReturnReasonDeleteResponse
required:
- id
- object
@@ -17,5 +18,4 @@ properties:
deleted:
type: boolean
title: deleted
description: Whether the return reason was deleted.
x-schemaName: AdminReturnReasonDeleteResponse
description: Whether the Return Reason was deleted.

7
www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneDeleteResponse.yaml
View File

@@ -1,5 +1,6 @@
type: object
description: SUMMARY
x-schemaName: AdminServiceZoneDeleteResponse
required:
- id
- object
@@ -8,16 +9,14 @@ properties:
id:
type: string
title: id
description: The service zone's ID.
description: The fulfillment set's ID.
object:
type: string
title: object
description: The name of the deleted object.
default: service_zone
deleted:
type: boolean
title: deleted
description: Whether the service zone was deleted.
description: Whether the Fulfillment Set was deleted.
parent:
$ref: ./AdminFulfillmentSet.yaml
x-schemaName: AdminServiceZoneDeleteResponse

2
www/apps/api-reference/specs/admin/components/schemas/StoreCreatePaymentCollection.yaml
View File

@@ -1,5 +1,6 @@
type: object
description: SUMMARY
x-schemaName: StoreCreatePaymentCollection
required:
- cart_id
properties:
@@ -7,4 +8,3 @@ properties:
type: string
title: cart_id
description: The payment collection's cart id.
x-schemaName: StoreCreatePaymentCollection

2
www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnItem.yaml
View File

@@ -1,5 +1,6 @@
type: object
description: The item's items.
x-schemaName: StoreCreateReturnItem
required:
- id
- quantity
@@ -20,4 +21,3 @@ properties:
type: string
title: note
description: The item's note.
x-schemaName: StoreCreateReturnItem

2
www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnShipping.yaml
View File

@@ -1,5 +1,6 @@
type: object
description: The return's return shipping.
x-schemaName: StoreCreateReturnShipping
required:
- option_id
properties:
@@ -11,4 +12,3 @@ properties:
type: number
title: price
description: The return shipping's price.
x-schemaName: StoreCreateReturnShipping