chore: reorganize docs apps (#7228)

* reorganize docs apps

* add README

* fix directory

* add condition for old docs

docs-util/oas-output/base-v2/admin.oas.base.yaml

@@ -19,14 +19,6 @@ tags:
       description: How to manage currencies
       url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-currencies
   - name: Customer Groups
-    description: >
-      Customer Groups can be used to organize customers that share similar data
-      or attributes into dedicated groups.
-
-      This can be useful for different purposes such as setting a different price for a specific customer group.
-    externalDocs:
-      description: How to manage customer groups
-      url: https://docs.medusajs.com/modules/customers/admin/manage-customer-groups
   - name: Customers
     description: >
       Customers can either be created when they register through the Store APIs,
@@ -39,13 +31,6 @@ tags:
   - name: Fulfillment Sets
   - name: Fulfillments
   - name: Inventory Items
-    description: >
-      Inventory items, provided by the [Inventory
-      Module](https://docs.medusajs.com/modules/multiwarehouse/inventory-module),
-      can be used to manage the inventory of saleable items in your store.
-    externalDocs:
-      description: How to manage inventory items
-      url: https://docs.medusajs.com/modules/multiwarehouse/admin/manage-inventory-items
   - name: Invites
     description: >
       An admin can invite new users to manage their team. This would allow new
@@ -55,28 +40,14 @@ tags:
       url: https://docs.medusajs.com/modules/users/admin/manage-invites
   - name: Orders
   - name: Payments
-    description: >
-      A payment can be related to an order, swap, return, or more. It can be
-      captured or refunded.
   - name: Price Lists
-    description: >
-      A price list are special prices applied to products based on a set of
-      conditions, such as customer group.
-    externalDocs:
-      description: How to manage price lists
-      url: https://docs.medusajs.com/modules/price-lists/admin/manage-price-lists
   - name: Pricing
   - name: Product Categories
   - name: Product Types
   - name: Products
-    description: >
-      Products are saleable items in a store. This also includes [saleable gift
-      cards](https://docs.medusajs.com/modules/gift-cards/admin/manage-gift-cards#manage-gift-card-product)
-      in a store.
-    externalDocs:
-      description: How to manage products
-      url: https://docs.medusajs.com/modules/products/admin/manage-products
   - name: Promotions
+    x-associatedSchema:
+      $ref: "#/components/schemas/Promotion"
   - name: Regions
     description: >
       Regions are different countries or geographical regions that the commerce
@@ -101,22 +72,9 @@ tags:
   - name: Stock Locations
   - name: Stores
   - name: Tax Rates
-    description: >
-      Each region has at least a default tax rate. Admins can create and manage
-      additional tax rates that can be applied for certain conditions, such as
-      for specific product types.
-    externalDocs:
-      description: How to manage tax rates
-      url: https://docs.medusajs.com/modules/taxes/admin/manage-tax-rates
   - name: Tax Regions
   - name: Uploads
   - name: Users
-    description: >
-      A store can have more than one user, each having the same privileges.
-      Admins can manage users, their passwords, and more.
-    externalDocs:
-      description: How to manage users
-      url: https://docs.medusajs.com/modules/users/admin/manage-users
   - name: Workflows Executions
 servers:
   - url: http://localhost:9000

docs-util/oas-output/base-v2/store.oas.base.yaml

@@ -18,12 +18,6 @@ tags:
   - name: Collections
   - name: Currencies
   - name: Customers
-    description: >
-      A customer can register and manage their information such as addresses,
-      orders, payment methods, and more.
-    externalDocs:
-      description: How to implement customer profiles in your storefront
-      url: https://docs.medusajs.com/modules/customers/storefront/implement-customer-profiles
   - name: Payment Collections
     description: >
       A payment collection is useful for managing additional payments, such as
@@ -40,12 +34,6 @@ tags:
       description: How to use regions in a storefront
       url: https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions
   - name: Shipping Options
-    description: >
-      A shipping option is used to define the available shipping methods during
-      checkout or when creating a return.
-    externalDocs:
-      description: Shipping Option architecture
-      url: https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-option
 servers:
   - url: http://localhost:9000
   - url: https://api.medusa-commerce.com

docs-util/oas-output/operations/admin/delete_admin_api-keys_[id].ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_campaigns_[id].ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_collections_[id].ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_customer-groups_[id].ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_customers_[id].ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts

@@ -18,6 +18,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id].ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts

@@ -19,6 +19,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_invites_[id].ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_price-lists_[id].ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_pricing_rule-types_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_products_[id].ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts

@@ -18,6 +18,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts

@@ -18,6 +18,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_promotions_[id].ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_regions_[id].ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_sales-channels_[id].ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id].ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts

@@ -18,6 +18,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_tax-regions_[id].ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/delete_admin_users_[id].ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_api-keys.ts

@@ -5,7 +5,47 @@
  * description: Retrieve a list of api keys. The api keys can be filtered by fields
  *   such as `id`. The api keys can also be sorted or paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_api-keys_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_campaigns.ts

@@ -5,7 +5,47 @@
  * description: Retrieve a list of campaigns. The campaigns can be filtered by
  *   fields such as `id`. The campaigns can also be sorted or paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_campaigns_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_collections.ts

@@ -5,7 +5,47 @@
  * description: Retrieve a list of collections. The collections can be filtered by
  *   fields such as `id`. The collections can also be sorted or paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_collections_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_currencies.ts

@@ -5,7 +5,47 @@
  * description: Retrieve a list of currencies. The currencies can be filtered by
  *   fields such as `id`. The currencies can also be sorted or paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_currencies_[code].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_customer-groups.ts

@@ -6,7 +6,47 @@
  *   filtered by fields such as `id`. The customer groups can also be sorted or
  *   paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_customer-groups_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_customers.ts

@@ -5,7 +5,47 @@
  * description: Retrieve a list of customers. The customers can be filtered by
  *   fields such as `id`. The customers can also be sorted or paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_customers_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts

@@ -18,6 +18,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_inventory-items.ts

@@ -6,7 +6,47 @@
  *   filtered by fields such as `id`. The inventory items can also be sorted or
  *   paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_inventory-items_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_invites.ts

@@ -5,7 +5,47 @@
  * description: Retrieve a list of invites. The invites can be filtered by fields
  *   such as `id`. The invites can also be sorted or paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_invites_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_payments.ts

@@ -5,7 +5,47 @@
  * description: Retrieve a list of payments. The payments can be filtered by fields
  *   such as `id`. The payments can also be sorted or paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_payments_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_price-lists.ts

@@ -5,7 +5,47 @@
  * description: Retrieve a list of price lists. The price lists can be filtered by
  *   fields such as `id`. The price lists can also be sorted or paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_price-lists_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_pricing_rule-types.ts

@@ -5,7 +5,47 @@
  * description: Retrieve a list of pricing. The pricing can be filtered by fields
  *   such as `id`. The pricing can also be sorted or paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_pricing_rule-types_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_product-types_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_products.ts

@@ -5,7 +5,47 @@
  * description: Retrieve a list of products. The products can be filtered by fields
  *   such as `id`. The products can also be sorted or paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []
@@ -8375,6 +8415,11 @@
  *     $ref: "#/components/responses/invalid_request_error"
  *   "500":
  *     $ref: "#/components/responses/500_error"
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/AdminGetProductsParams"
  * 
 */
 

docs-util/oas-output/operations/admin/get_admin_products_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_products_[id]_options.ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts

@@ -18,6 +18,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_products_[id]_variants.ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts

@@ -18,6 +18,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_promotions.ts

@@ -5,7 +5,47 @@
  * description: Retrieve a list of promotions. The promotions can be filtered by
  *   fields such as `id`. The promotions can also be sorted or paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_promotions_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []
@@ -50,6 +90,11 @@
  *     $ref: "#/components/responses/invalid_request_error"
  *   "500":
  *     $ref: "#/components/responses/500_error"
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/AdminGetPromotionsParams"
  * 
 */
 

docs-util/oas-output/operations/admin/get_admin_regions.ts

@@ -5,7 +5,47 @@
  * description: Retrieve a list of regions. The regions can be filtered by fields
  *   such as `id`. The regions can also be sorted or paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_regions_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_reservations_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_sales-channels.ts

@@ -6,7 +6,47 @@
  *   filtered by fields such as `id`. The sales channels can also be sorted or
  *   paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_sales-channels_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_stores.ts

@@ -5,7 +5,47 @@
  * description: Retrieve a list of stores. The stores can be filtered by fields
  *   such as `id`. The stores can also be sorted or paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_stores_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_tax-rates.ts

@@ -5,7 +5,47 @@
  * description: Retrieve a list of tax rates. The tax rates can be filtered by
  *   fields such as `id`. The tax rates can also be sorted or paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_tax-rates_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_users.ts

@@ -5,7 +5,47 @@
  * description: Retrieve a list of users. The users can be filtered by fields such
  *   as `id`. The users can also be sorted or paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_users_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_users_me.ts

@@ -5,7 +5,47 @@
  * description: Retrieve a list of users. The users can be filtered by fields such
  *   as `id`. The users can also be sorted or paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_workflows-executions.ts

@@ -6,7 +6,47 @@
  *   can be filtered by fields such as `id`. The workflows executions can also be
  *   sorted or paginated.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_workflows-executions_[id].ts

@@ -12,6 +12,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts

@@ -18,6 +18,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id]_[step_id]_subscribe.ts

@@ -25,6 +25,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_subscribe.ts

@@ -13,6 +13,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/post_admin_api-keys.ts

@@ -4,17 +4,67 @@
  * summary: Create Api Key
  * description: Create a api key.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []
  *   - jwt_token: []
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/CreateApiKey"
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL
  *     source: |-
  *       curl -X POST '{backend_url}/admin/api-keys' \
- *       -H 'x-medusa-access-token: {api_token}'
+ *       -H 'x-medusa-access-token: {api_token}' \
+ *       -H 'Content-Type: application/json' \
+ *       --data-raw '{
+ *         "title": "{value}",
+ *         "type": "{value}"
+ *       }'
  * tags:
  *   - Api Keys
  * responses:

docs-util/oas-output/operations/admin/post_admin_api-keys_[id].ts

@@ -11,10 +11,55 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []
  *   - jwt_token: []
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/UpdateApiKey"
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

docs-util/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/post_admin_campaigns.ts

@@ -4,17 +4,69 @@
  * summary: Create Campaign
  * description: Create a campaign.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []
  *   - jwt_token: []
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/CreateCampaign"
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL
  *     source: |-
  *       curl -X POST '{backend_url}/admin/campaigns' \
- *       -H 'x-medusa-access-token: {api_token}'
+ *       -H 'x-medusa-access-token: {api_token}' \
+ *       -H 'Content-Type: application/json' \
+ *       --data-raw '{
+ *         "name": "Elwin",
+ *         "campaign_identifier": "{value}",
+ *         "starts_at": "2024-11-30T18:47:00.491Z",
+ *         "ends_at": "2025-02-26T07:41:34.259Z"
+ *       }'
  * tags:
  *   - Campaigns
  * responses:

docs-util/oas-output/operations/admin/post_admin_campaigns_[id].ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []
@@ -91,7 +131,7 @@
  *       -H 'x-medusa-access-token: {api_token}' \
  *       -H 'Content-Type: application/json' \
  *       --data-raw '{
- *         "name": "Moriah"
+ *         "name": "Janessa"
  *       }'
  * tags:
  *   - Campaigns

docs-util/oas-output/operations/admin/post_admin_collections.ts

@@ -4,17 +4,66 @@
  * summary: Create Collection
  * description: Create a collection.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []
  *   - jwt_token: []
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/CreateProductCollection"
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL
  *     source: |-
  *       curl -X POST '{backend_url}/admin/collections' \
- *       -H 'x-medusa-access-token: {api_token}'
+ *       -H 'x-medusa-access-token: {api_token}' \
+ *       -H 'Content-Type: application/json' \
+ *       --data-raw '{
+ *         "title": "{value}"
+ *       }'
  * tags:
  *   - Collections
  * responses:

docs-util/oas-output/operations/admin/post_admin_collections_[id].ts

@@ -11,10 +11,55 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []
  *   - jwt_token: []
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/UpdateProductCollection"
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

docs-util/oas-output/operations/admin/post_admin_customer-groups.ts

@@ -4,17 +4,66 @@
  * summary: Create Customer Group
  * description: Create a customer group.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []
  *   - jwt_token: []
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/CreateCustomerGroup"
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL
  *     source: |-
  *       curl -X POST '{backend_url}/admin/customer-groups' \
- *       -H 'x-medusa-access-token: {api_token}'
+ *       -H 'x-medusa-access-token: {api_token}' \
+ *       -H 'Content-Type: application/json' \
+ *       --data-raw '{
+ *         "name": "Dave"
+ *       }'
  * tags:
  *   - Customer Groups
  * responses:

docs-util/oas-output/operations/admin/post_admin_customer-groups_[id].ts

@@ -11,10 +11,55 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []
  *   - jwt_token: []
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/CustomerGroupUpdatableFields"
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

docs-util/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/post_admin_customers.ts

@@ -4,11 +4,56 @@
  * summary: Create Customer
  * description: Create a customer.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []
  *   - jwt_token: []
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/CreateCustomer"
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

docs-util/oas-output/operations/admin/post_admin_customers_[id].ts

@@ -11,10 +11,55 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []
  *   - jwt_token: []
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/CustomerUpdatableFields"
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts

@@ -11,16 +11,65 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []
  *   - jwt_token: []
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/CreateCustomerAddress"
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL
  *     source: |-
  *       curl -X POST '{backend_url}/admin/customers/{id}/addresses' \
- *       -H 'x-medusa-access-token: {api_token}'
+ *       -H 'x-medusa-access-token: {api_token}' \
+ *       -H 'Content-Type: application/json' \
+ *       --data-raw '{
+ *         "customer_id": "{value}"
+ *       }'
  * tags:
  *   - Customers
  * responses:

docs-util/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts

@@ -17,10 +17,55 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []
  *   - jwt_token: []
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/CustomerAddress"
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

docs-util/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/post_admin_inventory-items.ts

@@ -4,7 +4,47 @@
  * summary: Create Inventory Item
  * description: Create a inventory item.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_batch.ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/post_admin_invites.ts

@@ -4,17 +4,66 @@
  * summary: Create Invite
  * description: Create a invite.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []
  *   - jwt_token: []
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/CreateInvite"
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL
  *     source: |-
  *       curl -X POST '{backend_url}/admin/invites' \
- *       -H 'x-medusa-access-token: {api_token}'
+ *       -H 'x-medusa-access-token: {api_token}' \
+ *       -H 'Content-Type: application/json' \
+ *       --data-raw '{
+ *         "email": "Nola57@hotmail.com"
+ *       }'
  * tags:
  *   - Invites
  * responses:

docs-util/oas-output/operations/admin/post_admin_invites_[id]_resend.ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/post_admin_invites_accept.ts

@@ -4,7 +4,47 @@
  * summary: Create Invite
  * description: Create a invite.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/post_admin_payments_[id]_capture.ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/post_admin_payments_[id]_refund.ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/post_admin_price-lists.ts

@@ -4,7 +4,47 @@
  * summary: Create Price List
  * description: Create a price list.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/post_admin_price-lists_[id].ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts

@@ -11,6 +11,46 @@
  *     required: true
  *     schema:
  *       type: string
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []

docs-util/oas-output/operations/admin/post_admin_pricing_rule-types.ts

@@ -4,7 +4,47 @@
  * summary: Create Pricing
  * description: Create a pricing.
  * x-authenticated: true
- * parameters: []
+ * parameters:
+ *   - name: expand
+ *     in: query
+ *     description: Comma-separated relations that should be expanded in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: expand
+ *       description: Comma-separated relations that should be expanded in the returned data.
+ *   - name: fields
+ *     in: query
+ *     description: Comma-separated fields that should be included in the returned data.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: fields
+ *       description: Comma-separated fields that should be included in the returned data.
+ *   - name: offset
+ *     in: query
+ *     description: The number of items to skip when retrieving a list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: offset
+ *       description: The number of items to skip when retrieving a list.
+ *   - name: limit
+ *     in: query
+ *     description: Limit the number of items returned in the list.
+ *     required: false
+ *     schema:
+ *       type: number
+ *       title: limit
+ *       description: Limit the number of items returned in the list.
+ *   - name: order
+ *     in: query
+ *     description: Field to sort items in the list by.
+ *     required: false
+ *     schema:
+ *       type: string
+ *       title: order
+ *       description: Field to sort items in the list by.
  * security:
  *   - api_token: []
  *   - cookie_auth: []