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

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

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]andShahed Nasser authored and GitHub committed 2024-10-03 07:48:54 +00:00
1 parent 97c193be1b
commit 21badd069d
894 files changed
+35649 -28168
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}.yaml
+2 -6
View File
@@ -36,14 +36,10 @@ post:
label: EmailPass Provider
source:
$ref: ../code_samples/Shell/auth_customer_{auth_provider}/post.sh
- lang: Shell
- lang: Bash
label: Google Provider
source:
$ref: ../code_samples/Shell/auth_customer_{auth_provider}/post.sh
- lang: Shell
label: GitHub Provider
source:
$ref: ../code_samples/Shell/auth_customer_{auth_provider}/post.sh
$ref: ../code_samples/Bash/auth_customer_{auth_provider}/post.sh
tags:
- Auth
responses:
www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_callback.yaml
+2 -2
View File
@@ -33,10 +33,10 @@ post:
label: Google Provider
source:
$ref: ../code_samples/Shell/auth_customer_{auth_provider}_callback/post.sh
- lang: Shell
- lang: Bash
label: GitHub Provider
source:
$ref: ../code_samples/Shell/auth_customer_{auth_provider}_callback/post.sh
$ref: ../code_samples/Bash/auth_customer_{auth_provider}_callback/post.sh
tags:
- Auth
responses:
www/apps/api-reference/specs/store/paths/auth_session.yaml
+1 -1
View File
@@ -51,7 +51,7 @@ delete:
application/json:
schema:
type: object
description: SUMMARY
description: The deletion's details.
required:
- success
properties:
www/apps/api-reference/specs/store/paths/store_carts.yaml
+2
View File
@@ -30,6 +30,8 @@ post:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
requestBody:
content:
application/json:
www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml
+4
View File
@@ -38,6 +38,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
x-codeSamples:
- lang: Shell
label: cURL
@@ -104,6 +106,8 @@ post:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
requestBody:
content:
application/json:
www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml
+8 -2
View File
@@ -40,6 +40,8 @@ post:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
x-codeSamples:
- lang: Shell
label: cURL
@@ -63,7 +65,9 @@ post:
type:
type: string
title: type
description: The type of the returned object.
description: >-
The type of the returned object. In this case, the order
is returned because the cart was completed successfully.
default: order
order:
$ref: ../components/schemas/StoreOrder.yaml
@@ -77,7 +81,9 @@ post:
type:
type: string
title: type
description: The type of the returned object.
description: >-
The type of the returned object. In this case, the cart is
returned because an error has occurred.
default: cart
cart:
$ref: ../components/schemas/StoreCart.yaml
www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml
+2
View File
@@ -41,6 +41,8 @@ post:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
requestBody:
content:
application/json:
www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml
+4
View File
@@ -47,6 +47,8 @@ post:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
requestBody:
content:
application/json:
@@ -128,6 +130,8 @@ delete:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml
+4
View File
@@ -37,6 +37,8 @@ post:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
requestBody:
content:
application/json:
@@ -118,6 +120,8 @@ delete:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml
+3 -1
View File
@@ -43,6 +43,8 @@ post:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
requestBody:
content:
application/json:
@@ -64,7 +66,7 @@ post:
externalDocs:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping#data-request-body-parameter
description: Learn more about the `data` parameter.
description: Learn more about the data parameter.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml
+2 -5
View File
@@ -37,11 +37,8 @@ post:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/StoreCalculateCartTaxes.yaml
externalDocs:
url: '#select-fields-and-relations'
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_collections.yaml
+13 -5
View File
@@ -36,6 +36,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
@@ -44,6 +46,8 @@ get:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: limit
in: query
description: Limit the number of items returned in the list.
@@ -52,6 +56,8 @@ get:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: >-
@@ -965,7 +971,7 @@ get:
schema:
allOf:
- type: object
description: SUMMARY
description: The paginated list of collections.
required:
- limit
- offset
@@ -974,17 +980,19 @@ get:
limit:
type: number
title: limit
description: The collection's limit.
description: The maximum number of items returned.
offset:
type: number
title: offset
description: The collection's offset.
description: >-
The number of items skipped before retrieving the returned
items.
count:
type: number
title: count
description: The collection's count.
description: The total number of items.
- type: object
description: SUMMARY
description: The paginated list of collections.
required:
- collections
properties:
www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml
+2
View File
@@ -42,6 +42,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_currencies.yaml
+6
View File
@@ -32,6 +32,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: limit
in: query
description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_currencies_{code}.yaml
+2
View File
@@ -38,6 +38,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_customers.yaml
+5
View File
@@ -37,6 +37,8 @@ post:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
requestBody:
content:
application/json:
@@ -69,3 +71,6 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createCustomerAccountWorkflow
security:
- cookie_auth: []
- jwt_token: []
www/apps/api-reference/specs/store/paths/store_customers_me.yaml
+4
View File
@@ -37,6 +37,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
security:
- cookie_auth: []
- jwt_token: []
@@ -102,6 +104,8 @@ post:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
security:
- cookie_auth: []
- jwt_token: []
www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml
+42 -13
View File
@@ -38,6 +38,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
@@ -46,6 +48,8 @@ get:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: limit
in: query
description: Limit the number of items returned in the list.
@@ -54,6 +58,8 @@ get:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: >-
@@ -70,31 +76,52 @@ get:
- name: city
in: query
description: Filter by the address's city.
required: true
required: false
schema:
type: string
title: city
description: Filter by the address's city.
oneOf:
- type: string
title: city
description: Filter by a city.
- type: array
description: Filter by cities.
items:
type: string
title: city
description: A city.
- name: postal_code
in: query
description: Filter by the address's postal code.
required: true
required: false
schema:
type: string
title: postal_code
description: Filter by the address's postal code.
oneOf:
- type: string
title: postal_code
description: Filter by a postal code.
- type: array
description: Filter by postal codes.
items:
type: string
title: postal_code
description: A postal code.
- name: country_code
in: query
description: Filter by the address's country code.
required: true
required: false
schema:
type: string
title: country_code
description: Filter by the address's country code.
oneOf:
- type: string
title: country_code
description: Filter by a country code.
- type: array
description: Filter by country codes.
items:
type: string
title: country_code
description: A country code.
- name: q
in: query
description: Search term to filter the address's searchable properties.
required: true
required: false
schema:
type: string
title: q
@@ -165,6 +192,8 @@ post:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
security:
- cookie_auth: []
- jwt_token: []
www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml
+6
View File
@@ -39,6 +39,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
security:
- cookie_auth: []
- jwt_token: []
@@ -111,6 +113,8 @@ post:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
security:
- cookie_auth: []
- jwt_token: []
@@ -251,6 +255,8 @@ delete:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
security:
- cookie_auth: []
- jwt_token: []
www/apps/api-reference/specs/store/paths/store_orders.yaml
+13 -5
View File
@@ -33,6 +33,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
@@ -41,6 +43,8 @@ get:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: limit
in: query
description: Limit the number of items returned in the list.
@@ -49,6 +53,8 @@ get:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: >-
@@ -144,7 +150,7 @@ get:
schema:
allOf:
- type: object
description: SUMMARY
description: The paginated list of orders.
required:
- limit
- offset
@@ -153,17 +159,19 @@ get:
limit:
type: number
title: limit
description: The order's limit.
description: The maximum number of items returned.
offset:
type: number
title: offset
description: The order's offset.
description: >-
The number of items skipped before retrieving the returned
items.
count:
type: number
title: count
description: The order's count.
description: The total number of items.
- type: object
description: SUMMARY
description: The paginated list of orders.
required:
- orders
properties:
www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml
+2
View File
@@ -38,6 +38,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_payment-collections.yaml
+2
View File
@@ -36,6 +36,8 @@ post:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
requestBody:
content:
application/json:
www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml
+2
View File
@@ -45,6 +45,8 @@ post:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
requestBody:
content:
application/json:
www/apps/api-reference/specs/store/paths/store_payment-providers.yaml
+6
View File
@@ -36,6 +36,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
@@ -44,6 +46,8 @@ get:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: limit
in: query
description: Limit the number of items returned in the list.
@@ -52,6 +56,8 @@ get:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_product-categories.yaml
+6
View File
@@ -37,6 +37,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
@@ -45,6 +47,8 @@ get:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: limit
in: query
description: Limit the number of items returned in the list.
@@ -53,6 +57,8 @@ get:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml
+2
View File
@@ -42,6 +42,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
- name: include_ancestors_tree
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_products.yaml
+38 -26
View File
@@ -36,6 +36,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
@@ -44,6 +46,8 @@ get:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: limit
in: query
description: Limit the number of items returned in the list.
@@ -52,6 +56,8 @@ get:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: >-
@@ -1020,18 +1026,6 @@ get:
url: >-
https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price
description: 'Storefront guide: How to show product variants'' prices with taxes.'
- name: country_code
in: query
description: >-
The country code the products are being viewed from. This is required if
you're retrieving product variant prices with taxes.
required: false
schema:
type: string
title: country_code
description: >-
The country code the products are being viewed from. This is required
if you're retrieving product variant prices with taxes.
- name: province
in: query
description: >-
@@ -1046,20 +1040,6 @@ get:
The province the products are being viewed from. This is useful to
narrow down the tax context when calculating product variant prices
with taxes.
- name: cart_id
in: query
description: >-
The ID of the customer's cart. If set, the cart's region and shipping
address's country code and province are used instead of the `region_id`,
`country_code`, and `province` properties.
required: false
schema:
type: string
title: cart_id
description: >-
The ID of the customer's cart. If set, the cart's region and shipping
address's country code and province are used instead of the
`region_id`, `country_code`, and `province` properties.
- name: sales_channel_id
in: query
required: false
@@ -1088,6 +1068,38 @@ get:
type: string
title: category_id
description: A product category's ID.
- name: currency_code
in: query
description: The currency code to retrieve prices in.
required: false
schema:
type: string
title: currency_code
description: The currency code to retrieve prices in.
- name: variants
in: query
description: Filter the products' variants.
required: false
schema:
type: object
description: Filter the products' variants.
x-schemaName: StoreProductVariantParams
properties:
options:
type: object
description: Filter by the variants' options.
required:
- value
- option_id
properties:
option_id:
type: string
title: option_id
description: The ID of the option to filter by.
value:
type: string
title: value
description: Filter by a value of the option.
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_products_{id}.yaml
+2
View File
@@ -42,6 +42,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
- name: region_id
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_regions.yaml
+14 -6
View File
@@ -35,6 +35,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
@@ -43,6 +45,8 @@ get:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: limit
in: query
description: Limit the number of items returned in the list.
@@ -51,6 +55,8 @@ get:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: >-
@@ -159,7 +165,7 @@ get:
schema:
allOf:
- type: object
description: SUMMARY
description: The paginated list of regions.
required:
- limit
- offset
@@ -168,23 +174,25 @@ get:
limit:
type: number
title: limit
description: The region's limit.
description: The maximum number of items returned.
offset:
type: number
title: offset
description: The region's offset.
description: >-
The number of items skipped before retrieving the returned
items.
count:
type: number
title: count
description: The region's count.
description: The total number of items.
- type: object
description: SUMMARY
description: The paginated list of regions.
required:
- regions
properties:
regions:
type: array
description: The region's regions.
description: The list of regions.
items:
$ref: ../components/schemas/StoreRegion.yaml
'400':
www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml
+3 -1
View File
@@ -38,6 +38,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
x-codeSamples:
- lang: Shell
label: cURL
@@ -52,7 +54,7 @@ get:
application/json:
schema:
type: object
description: SUMMARY
description: The region's details.
required:
- region
properties:
www/apps/api-reference/specs/store/paths/store_return-reasons.yaml
+6
View File
@@ -32,6 +32,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: limit
in: query
description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: >-
www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml
+2
View File
@@ -38,6 +38,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
x-codeSamples:
- lang: Shell
label: cURL
www/apps/api-reference/specs/store/paths/store_shipping-options.yaml
+6
View File
@@ -29,6 +29,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
@@ -37,6 +39,8 @@ get:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: limit
in: query
description: Limit the number of items returned in the list.
@@ -45,6 +49,8 @@ get:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: >-