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

chore(docs): Generated OAS (#7189)

Browse Source 
This PR holds all generated OAS for the upcoming release.

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]andOli Juhl authored and GitHub committed 2024-05-01 10:07:31 +00:00
1 parent d930d88369
commit bfda7a626d
299 files changed
+16982 -18813
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

docs-util/oas-output/base-v2/admin.oas.base.yaml
+11 -1
View File
@@ -34,7 +34,10 @@ tags:
externalDocs: externalDocs:
description: How to manage customers description: How to manage customers
url: https://docs.medusajs.com/modules/customers/admin/manage-customers url: https://docs.medusajs.com/modules/customers/admin/manage-customers
- name: Fulfillment - name: Draft Orders
- name: Fulfillment Providers
- name: Fulfillment Sets
- name: Fulfillments
- name: Inventory Items - name: Inventory Items
description: > description: >
Inventory items, provided by the [Inventory Inventory items, provided by the [Inventory
@@ -50,6 +53,7 @@ tags:
externalDocs: externalDocs:
description: How to manage invites description: How to manage invites
url: https://docs.medusajs.com/modules/users/admin/manage-invites url: https://docs.medusajs.com/modules/users/admin/manage-invites
- name: Orders
- name: Payments - name: Payments
description: > description: >
A payment can be related to an order, swap, return, or more. It can be A payment can be related to an order, swap, return, or more. It can be
@@ -62,6 +66,8 @@ tags:
description: How to manage price lists description: How to manage price lists
url: https://docs.medusajs.com/modules/price-lists/admin/manage-price-lists url: https://docs.medusajs.com/modules/price-lists/admin/manage-price-lists
- name: Pricing - name: Pricing
- name: Product Categories
- name: Product Types
- name: Products - name: Products
description: > description: >
Products are saleable items in a store. This also includes [saleable gift Products are saleable items in a store. This also includes [saleable gift
@@ -80,6 +86,7 @@ tags:
externalDocs: externalDocs:
description: How to manage regions description: How to manage regions
url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions
- name: Reservations
- name: Sales Channels - name: Sales Channels
description: > description: >
A sales channel indicates a channel where products can be sold in. For A sales channel indicates a channel where products can be sold in. For
@@ -89,6 +96,8 @@ tags:
externalDocs: externalDocs:
description: How to manage sales channels description: How to manage sales channels
url: https://docs.medusajs.com/modules/sales-channels/admin/manage url: https://docs.medusajs.com/modules/sales-channels/admin/manage
- name: Shipping Options
- name: Shipping Profiles
- name: Stock Locations - name: Stock Locations
- name: Stores - name: Stores
- name: Tax Rates - name: Tax Rates
@@ -100,6 +109,7 @@ tags:
description: How to manage tax rates description: How to manage tax rates
url: https://docs.medusajs.com/modules/taxes/admin/manage-tax-rates url: https://docs.medusajs.com/modules/taxes/admin/manage-tax-rates
- name: Tax Regions - name: Tax Regions
- name: Uploads
- name: Users - name: Users
description: > description: >
A store can have more than one user, each having the same privileges. A store can have more than one user, each having the same privileges.
docs-util/oas-output/base-v2/store.oas.base.yaml
+3
View File
@@ -15,6 +15,7 @@ tags:
externalDocs: externalDocs:
description: How to implement cart functionality in your storefront description: How to implement cart functionality in your storefront
url: https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart url: https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart
- name: Collections
- name: Currencies - name: Currencies
- name: Customers - name: Customers
description: > description: >
@@ -27,6 +28,8 @@ tags:
description: > description: >
A payment collection is useful for managing additional payments, such as A payment collection is useful for managing additional payments, such as
for Order Edits, or installment payments. for Order Edits, or installment payments.
- name: Product Categories
- name: Products
- name: Regions - name: Regions
description: > description: >
Regions are different countries or geographical regions that the commerce Regions are different countries or geographical regions that the commerce
docs-util/oas-output/operations/admin/delete_admin_api-keys_[id].ts
-40
View File
@@ -11,46 +11,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_campaigns_[id].ts
-40
View File
@@ -11,46 +11,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_collections_[id].ts
-40
View File
@@ -11,46 +11,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_customer-groups_[id].ts
-40
View File
@@ -11,46 +11,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_customers_[id].ts
-40
View File
@@ -11,46 +11,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts
-40
View File
@@ -18,46 +18,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_fulfillment-sets_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/fulfillment-sets/{id}
* operationId: DeleteFulfillmentSetsId
* summary: Delete a Fulfillment Set
* description: Delete a fulfillment set.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The fulfillment set's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Fulfillment Sets
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts
+53
View File
@@ -0,0 +1,53 @@
/**
* @oas [delete] /admin/fulfillment-sets/{id}/service-zones/{zone_id}
* operationId: DeleteFulfillmentSetsIdServiceZonesZone_id
* summary: Remove Service Zones from Fulfillment Set
* description: Remove a list of service zones from a fulfillment set. This doesn't
* delete the Service Zone, only the association between the Service Zone and the
* fulfillment set.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The fulfillment set's ID.
* required: true
* schema:
* type: string
* - name: zone_id
* in: path
* description: The fulfillment set's zone id.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl -X DELETE
* '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Fulfillment Sets
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id].ts
-40
View File
@@ -11,46 +11,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts
-40
View File
@@ -19,46 +19,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_invites_[id].ts
-40
View File
@@ -11,46 +11,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_price-lists_[id].ts
-40
View File
@@ -11,46 +11,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_pricing_rule-types_[id].ts
+2 -41
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -60,7 +20,8 @@
* content: * content:
* application/json: * application/json:
* schema: * schema:
* $ref: "#/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq" * description: SUMMARY
* properties: {}
* x-codeSamples: * x-codeSamples:
* - lang: Shell * - lang: Shell
* label: cURL * label: cURL
docs-util/oas-output/operations/admin/delete_admin_product-types_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/product-types/{id}
* operationId: DeleteProductTypesId
* summary: Delete a Product Type
* description: Delete a product type.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The product type's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/product-types/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Product Types
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/delete_admin_products_[id].ts
-40
View File
@@ -11,46 +11,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts
-40
View File
@@ -18,46 +18,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts
-40
View File
@@ -18,46 +18,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_promotions_[id].ts
-40
View File
@@ -11,46 +11,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_regions_[id].ts
-40
View File
@@ -11,46 +11,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_reservations_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/reservations/{id}
* operationId: DeleteReservationsId
* summary: Delete a Reservation
* description: Delete a reservation.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The reservation's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/reservations/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Reservations
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/delete_admin_sales-channels_[id].ts
-40
View File
@@ -11,46 +11,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_shipping-options_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/shipping-options/{id}
* operationId: DeleteShippingOptionsId
* summary: Delete a Shipping Option
* description: Delete a shipping option.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The shipping option's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/shipping-options/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Shipping Options
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/delete_admin_shipping-profiles_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/shipping-profiles/{id}
* operationId: DeleteShippingProfilesId
* summary: Delete a Shipping Profile
* description: Delete a shipping profile.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The shipping profile's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/shipping-profiles/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Shipping Profiles
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/delete_admin_stock-locations_[id].ts
+4 -2
View File
@@ -24,8 +24,6 @@
* tags: * tags:
* - Stock Locations * - Stock Locations
* responses: * responses:
* "200":
* description: OK
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
@@ -38,6 +36,10 @@
* $ref: "#/components/responses/invalid_request_error" * $ref: "#/components/responses/invalid_request_error"
* "500": * "500":
* $ref: "#/components/responses/500_error" * $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
* *
*/ */
docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id].ts
-40
View File
@@ -11,46 +11,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts
-40
View File
@@ -18,46 +18,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_tax-regions_[id].ts
-40
View File
@@ -11,46 +11,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/delete_admin_uploads_[id].ts
+43
View File
@@ -0,0 +1,43 @@
/**
* @oas [delete] /admin/uploads/{id}
* operationId: DeleteUploadsId
* summary: Delete a Upload
* description: Delete a upload.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The upload's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl -X DELETE '{backend_url}/admin/uploads/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Uploads
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/delete_admin_users_[id].ts
-40
View File
@@ -11,46 +11,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_api-keys.ts
+1 -41
View File
@@ -5,47 +5,7 @@
* description: Retrieve a list of api keys. The api keys can be filtered by fields * 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. * such as `id`. The api keys can also be sorted or paginated.
* x-authenticated: true * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_api-keys_[id].ts
-40
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_campaigns.ts
+1 -41
View File
@@ -5,47 +5,7 @@
* description: Retrieve a list of campaigns. The campaigns can be filtered by * description: Retrieve a list of campaigns. The campaigns can be filtered by
* fields such as `id`. The campaigns can also be sorted or paginated. * fields such as `id`. The campaigns can also be sorted or paginated.
* x-authenticated: true * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_campaigns_[id].ts
-40
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_collections.ts
+1 -41
View File
@@ -5,47 +5,7 @@
* description: Retrieve a list of collections. The collections can be filtered by * description: Retrieve a list of collections. The collections can be filtered by
* fields such as `id`. The collections can also be sorted or paginated. * fields such as `id`. The collections can also be sorted or paginated.
* x-authenticated: true * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_collections_[id].ts
-40
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_currencies.ts
+1 -41
View File
@@ -5,47 +5,7 @@
* description: Retrieve a list of currencies. The currencies can be filtered by * description: Retrieve a list of currencies. The currencies can be filtered by
* fields such as `id`. The currencies can also be sorted or paginated. * fields such as `id`. The currencies can also be sorted or paginated.
* x-authenticated: true * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_currencies_[code].ts
-40
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_customer-groups.ts
+1 -41
View File
@@ -6,47 +6,7 @@
* filtered by fields such as `id`. The customer groups can also be sorted or * filtered by fields such as `id`. The customer groups can also be sorted or
* paginated. * paginated.
* x-authenticated: true * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_customer-groups_[id].ts
-40
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_customer-groups_[id]_customers.ts
-86
View File
@@ -1,86 +0,0 @@
/**
* @oas [get] /admin/customer-groups/{id}/customers
* operationId: GetCustomerGroupsIdCustomers
* summary: List Customers
* description: Retrieve a list of customers in a customer group. The customers can
* be filtered by fields like FILTER FIELDS. The customers can also be paginated.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The customer group's ID.
* 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: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/customer-groups/{id}/customers' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Customer Groups
* responses:
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema: {}
*
*/
docs-util/oas-output/operations/admin/get_admin_customers.ts
+6 -41
View File
@@ -5,47 +5,7 @@
* description: Retrieve a list of customers. The customers can be filtered by * description: Retrieve a list of customers. The customers can be filtered by
* fields such as `id`. The customers can also be sorted or paginated. * fields such as `id`. The customers can also be sorted or paginated.
* x-authenticated: true * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -59,6 +19,11 @@
* tags: * tags:
* - Customers * - Customers
* responses: * responses:
* "200":
* description: OK
* content:
* application/json:
* schema: {}
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
docs-util/oas-output/operations/admin/get_admin_customers_[id].ts
+5 -40
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -65,6 +25,11 @@
* tags: * tags:
* - Customers * - Customers
* responses: * responses:
* "200":
* description: OK
* content:
* application/json:
* schema: {}
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts
-40
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts
-40
View File
@@ -18,46 +18,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_draft-orders.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/draft-orders
* operationId: GetDraftOrders
* summary: List Draft Orders
* description: Retrieve a list of draft orders. The draft orders can be filtered
* by fields such as `id`. The draft orders can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/draft-orders' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Draft Orders
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_draft-orders_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/draft-orders/{id}
* operationId: GetDraftOrdersId
* summary: Get a Draft Order
* description: Retrieve a draft order by its ID. You can expand the draft order's
* relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The draft order's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/draft-orders/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Draft Orders
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_fulfillment-providers.ts
+56
View File
@@ -0,0 +1,56 @@
/**
* @oas [get] /admin/fulfillment-providers
* operationId: GetFulfillmentProviders
* summary: List Fulfillment Providers
* description: Retrieve a list of fulfillment providers. The fulfillment providers
* can be filtered by fields such as `id`. The fulfillment providers can also be
* sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - fields
* properties:
* fields:
* type: string
* title: fields
* description: The fulfillment provider's fields.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/fulfillment-providers' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "fields": "{value}"
* }'
* tags:
* - Fulfillment Providers
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts
+51
View File
@@ -0,0 +1,51 @@
/**
* @oas [get] /admin/fulfillment-sets/{id}/service-zones/{zone_id}
* operationId: GetFulfillmentSetsIdServiceZonesZone_id
* summary: List Service Zones
* description: Retrieve a list of service zones in a fulfillment set. The service
* zones can be filtered by fields like FILTER FIELDS. The service zones can also
* be paginated.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The fulfillment set's ID.
* required: true
* schema:
* type: string
* - name: zone_id
* in: path
* description: The fulfillment set's zone id.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Fulfillment Sets
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_inventory-items.ts
+1 -41
View File
@@ -6,47 +6,7 @@
* filtered by fields such as `id`. The inventory items can also be sorted or * filtered by fields such as `id`. The inventory items can also be sorted or
* paginated. * paginated.
* x-authenticated: true * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_inventory-items_[id].ts
+9 -41
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -80,7 +40,15 @@
* requestBody: * requestBody:
* content: * content:
* application/json: * application/json:
* schema: {} * schema:
* type: object
* required:
* - fields
* properties:
* fields:
* type: string
* title: fields
* description: The inventory item's fields.
* *
*/ */
docs-util/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts
+45
View File
@@ -0,0 +1,45 @@
/**
* @oas [get] /admin/inventory-items/{id}/location-levels
* operationId: GetInventoryItemsIdLocationLevels
* summary: List Location Levels
* description: Retrieve a list of location levels in a inventory item. The
* location levels can be filtered by fields like FILTER FIELDS. The location
* levels can also be paginated.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The inventory item's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/inventory-items/{id}/location-levels' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Inventory Items
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_invites.ts
+1 -41
View File
@@ -5,47 +5,7 @@
* description: Retrieve a list of invites. The invites can be filtered by fields * description: Retrieve a list of invites. The invites can be filtered by fields
* such as `id`. The invites can also be sorted or paginated. * such as `id`. The invites can also be sorted or paginated.
* x-authenticated: true * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_invites_[id].ts
-40
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_orders.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/orders
* operationId: GetOrders
* summary: List Orders
* description: Retrieve a list of orders. The orders can be filtered by fields
* such as `id`. The orders can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/orders' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Orders
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_orders_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/orders/{id}
* operationId: GetOrdersId
* summary: Get a Order
* description: Retrieve a order by its ID. You can expand the order's relations or
* select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The order's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/orders/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Orders
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_payments.ts
+1 -41
View File
@@ -5,47 +5,7 @@
* description: Retrieve a list of payments. The payments can be filtered by fields * description: Retrieve a list of payments. The payments can be filtered by fields
* such as `id`. The payments can also be sorted or paginated. * such as `id`. The payments can also be sorted or paginated.
* x-authenticated: true * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_payments_[id].ts
+9 -41
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -80,7 +40,15 @@
* requestBody: * requestBody:
* content: * content:
* application/json: * application/json:
* schema: {} * schema:
* type: object
* required:
* - fields
* properties:
* fields:
* type: string
* title: fields
* description: The payment's fields.
* *
*/ */
docs-util/oas-output/operations/admin/get_admin_payments_payment-providers.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/payments/payment-providers
* operationId: GetPaymentsPaymentProviders
* summary: List Payments
* 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: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/payments/payment-providers' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Payments
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_price-lists.ts
+1 -41
View File
@@ -5,47 +5,7 @@
* description: Retrieve a list of price lists. The price lists can be filtered by * 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. * fields such as `id`. The price lists can also be sorted or paginated.
* x-authenticated: true * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_price-lists_[id].ts
-40
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_pricing_rule-types.ts
+30 -42
View File
@@ -5,47 +5,7 @@
* description: Retrieve a list of pricing. The pricing can be filtered by fields * description: Retrieve a list of pricing. The pricing can be filtered by fields
* such as `id`. The pricing can also be sorted or paginated. * such as `id`. The pricing can also be sorted or paginated.
* x-authenticated: true * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -54,7 +14,35 @@
* content: * content:
* application/json: * application/json:
* schema: * schema:
* $ref: "#/components/schemas/AdminGetPricingRuleTypesParams" * description: SUMMARY
* properties:
* rule_attribute:
* type: array
* description: The pricing's rule attribute.
* items:
* type: string
* title: rule_attribute
* description: The rule attribute's details.
* expand:
* type: string
* title: expand
* description: The pricing's expand.
* fields:
* type: string
* title: fields
* description: The pricing's fields.
* offset:
* type: number
* title: offset
* description: The pricing's offset.
* limit:
* type: number
* title: limit
* description: The pricing's limit.
* order:
* type: string
* title: order
* description: The pricing's order.
* x-codeSamples: * x-codeSamples:
* - lang: Shell * - lang: Shell
* label: cURL * label: cURL
docs-util/oas-output/operations/admin/get_admin_pricing_rule-types_[id].ts
+9 -41
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -60,7 +20,15 @@
* content: * content:
* application/json: * application/json:
* schema: * schema:
* $ref: "#/components/schemas/AdminGetPricingRuleTypesRuleTypeParams" * type: object
* description: SUMMARY
* properties:
* fields:
* type: string
* title: fields
* description: The pricing's fields.
* required:
* - fields
* x-codeSamples: * x-codeSamples:
* - lang: Shell * - lang: Shell
* label: cURL * label: cURL
docs-util/oas-output/operations/admin/get_admin_product-categories.ts
+39
View File
@@ -0,0 +1,39 @@
/**
* @oas [get] /admin/product-categories
* operationId: GetProductCategories
* summary: List Product Categories
* description: Retrieve a list of product categories. The product categories can
* be filtered by fields such as `id`. The product categories can also be sorted
* or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/product-categories' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Product Categories
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_product-categories_[id].ts
+73
View File
@@ -0,0 +1,73 @@
/**
* @oas [get] /admin/product-categories/{id}
* operationId: GetProductCategoriesId
* summary: Get a Product Category
* description: Retrieve a product category by its ID. You can expand the product
* category's relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The product category's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - fields
* - include_ancestors_tree
* - include_descendants_tree
* properties:
* fields:
* type: string
* title: fields
* description: The product category's fields.
* include_ancestors_tree:
* type: boolean
* title: include_ancestors_tree
* description: The product category's include ancestors tree.
* include_descendants_tree:
* type: boolean
* title: include_descendants_tree
* description: The product category's include descendants tree.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/product-categories/{id}' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "fields": "{value}",
* "include_ancestors_tree": true,
* "include_descendants_tree": true
* }'
* tags:
* - Product Categories
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_product-types.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/product-types
* operationId: GetProductTypes
* summary: List Product Types
* description: Retrieve a list of product types. The product types can be filtered
* by fields such as `id`. The product types can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/product-types' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Product Types
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_product-types_[id].ts
+61
View File
@@ -0,0 +1,61 @@
/**
* @oas [get] /admin/product-types/{id}
* operationId: GetProductTypesId
* summary: Get a Product Type
* description: Retrieve a product type by its ID. You can expand the product
* type's relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The product type's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - fields
* properties:
* fields:
* type: string
* title: fields
* description: The product type's fields.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/product-types/{id}' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "fields": "{value}"
* }'
* tags:
* - Product Types
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_products.ts
+8341 -42
View File
File diff suppressed because it is too large. Load diff
docs-util/oas-output/operations/admin/get_admin_products_[id].ts
-40
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_products_[id]_options.ts
-40
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts
-40
View File
@@ -18,46 +18,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_products_[id]_variants.ts
-40
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts
-40
View File
@@ -18,46 +18,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_promotions.ts
+1 -41
View File
@@ -5,47 +5,7 @@
* description: Retrieve a list of promotions. The promotions can be filtered by * description: Retrieve a list of promotions. The promotions can be filtered by
* fields such as `id`. The promotions can also be sorted or paginated. * fields such as `id`. The promotions can also be sorted or paginated.
* x-authenticated: true * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_promotions_[id].ts
+9 -41
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -60,7 +20,15 @@
* content: * content:
* application/json: * application/json:
* schema: * schema:
* $ref: "#/components/schemas/AdminGetPromotionsParams" * type: object
* description: SUMMARY
* properties:
* fields:
* type: string
* title: fields
* description: The promotion's fields.
* required:
* - fields
* x-codeSamples: * x-codeSamples:
* - lang: Shell * - lang: Shell
* label: cURL * label: cURL
docs-util/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts
+50
View File
@@ -0,0 +1,50 @@
/**
* @oas [get] /admin/promotions/{id}/{rule_type}
* operationId: GetPromotionsIdRule_type
* summary: "List "
* description: Retrieve a list of in a promotion. The can be filtered by fields
* like FILTER FIELDS. The can also be paginated.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The promotion's ID.
* required: true
* schema:
* type: string
* - name: rule_type
* in: path
* description: The promotion's rule type.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/promotions/{id}/{rule_type}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts
+45
View File
@@ -0,0 +1,45 @@
/**
* @oas [get] /admin/promotions/rule-attribute-options/{rule_type}
* operationId: GetPromotionsRuleAttributeOptionsRule_type
* summary: List Rule Attribute Options
* description: Retrieve a list of rule attribute options in a promotion. The rule
* attribute options can be filtered by fields like FILTER FIELDS. The rule
* attribute options can also be paginated.
* x-authenticated: true
* parameters:
* - name: rule_type
* in: path
* description: The promotion's rule type.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/promotions/rule-attribute-options/{rule_type}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_promotions_rule-operator-options.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/promotions/rule-operator-options
* operationId: GetPromotionsRuleOperatorOptions
* summary: List Promotions
* 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: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/promotions/rule-operator-options' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts
+53
View File
@@ -0,0 +1,53 @@
/**
* @oas [get] /admin/promotions/rule-value-options/{rule_type}/{rule_attribute_id}
* operationId: GetPromotionsRuleValueOptionsRule_typeRule_attribute_id
* summary: "List "
* description: Retrieve a list of in a promotion. The can be filtered by fields
* like FILTER FIELDS. The can also be paginated.
* x-authenticated: true
* parameters:
* - name: rule_type
* in: path
* description: The promotion's rule type.
* required: true
* schema:
* type: string
* - name: rule_attribute_id
* in: path
* description: The promotion's rule attribute id.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: >-
* curl
* '{backend_url}/admin/promotions/rule-value-options/{rule_type}/{rule_attribute_id}'
* \
*
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Promotions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_regions.ts
+1 -41
View File
@@ -5,47 +5,7 @@
* description: Retrieve a list of regions. The regions can be filtered by fields * description: Retrieve a list of regions. The regions can be filtered by fields
* such as `id`. The regions can also be sorted or paginated. * such as `id`. The regions can also be sorted or paginated.
* x-authenticated: true * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_regions_[id].ts
+9 -41
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -80,7 +40,15 @@
* requestBody: * requestBody:
* content: * content:
* application/json: * application/json:
* schema: {} * schema:
* type: object
* required:
* - fields
* properties:
* fields:
* type: string
* title: fields
* description: The region's fields.
* *
*/ */
docs-util/oas-output/operations/admin/get_admin_reservations.ts
+279
View File
@@ -0,0 +1,279 @@
/**
* @oas [get] /admin/reservations
* operationId: GetReservations
* summary: List Reservations
* description: Retrieve a list of reservations. The reservations can be filtered
* by fields such as `id`. The reservations can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - limit
* - fields
* - order
* - offset
* - location_id
* - inventory_item_id
* - line_item_id
* - created_by
* - description
* - quantity
* - created_at
* - updated_at
* - deleted_at
* properties:
* limit:
* type: number
* title: limit
* description: The reservation's limit.
* fields:
* type: string
* title: fields
* description: The reservation's fields.
* order:
* type: string
* title: order
* description: The reservation's order.
* offset:
* type: number
* title: offset
* description: The reservation's offset.
* location_id:
* oneOf:
* - type: string
* title: location_id
* description: The reservation's location id.
* - type: array
* description: The reservation's location id.
* items:
* type: string
* title: location_id
* description: The location id's details.
* inventory_item_id:
* oneOf:
* - type: string
* title: inventory_item_id
* description: The reservation's inventory item id.
* - type: array
* description: The reservation's inventory item id.
* items:
* type: string
* title: inventory_item_id
* description: The inventory item id's details.
* line_item_id:
* oneOf:
* - type: string
* title: line_item_id
* description: The reservation's line item id.
* - type: array
* description: The reservation's line item id.
* items:
* type: string
* title: line_item_id
* description: The line item id's details.
* created_by:
* oneOf:
* - type: string
* title: created_by
* description: The reservation's created by.
* - type: array
* description: The reservation's created by.
* items:
* type: string
* title: created_by
* description: The created by's details.
* description:
* oneOf:
* - type: string
* title: description
* description: The reservation's description.
* - type: object
* description: The reservation's description.
* required:
* - $eq
* - $ne
* - $in
* - $nin
* - $like
* - $ilike
* - $re
* - $contains
* - $gt
* - $gte
* - $lt
* - $lte
* properties:
* $eq: {}
* $ne: {}
* $in: {}
* $nin: {}
* $like: {}
* $ilike: {}
* $re: {}
* $contains: {}
* $gt: {}
* $gte: {}
* $lt: {}
* $lte: {}
* quantity:
* type: object
* description: The reservation's quantity.
* required:
* - $eq
* - $ne
* - $in
* - $nin
* - $like
* - $ilike
* - $re
* - $contains
* - $gt
* - $gte
* - $lt
* - $lte
* properties:
* $eq: {}
* $ne: {}
* $in: {}
* $nin: {}
* $like: {}
* $ilike: {}
* $re: {}
* $contains: {}
* $gt: {}
* $gte: {}
* $lt: {}
* $lte: {}
* created_at:
* type: object
* description: The reservation's created at.
* required:
* - $eq
* - $ne
* - $in
* - $nin
* - $like
* - $ilike
* - $re
* - $contains
* - $gt
* - $gte
* - $lt
* - $lte
* properties:
* $eq: {}
* $ne: {}
* $in: {}
* $nin: {}
* $like: {}
* $ilike: {}
* $re: {}
* $contains: {}
* $gt: {}
* $gte: {}
* $lt: {}
* $lte: {}
* updated_at:
* type: object
* description: The reservation's updated at.
* required:
* - $eq
* - $ne
* - $in
* - $nin
* - $like
* - $ilike
* - $re
* - $contains
* - $gt
* - $gte
* - $lt
* - $lte
* properties:
* $eq: {}
* $ne: {}
* $in: {}
* $nin: {}
* $like: {}
* $ilike: {}
* $re: {}
* $contains: {}
* $gt: {}
* $gte: {}
* $lt: {}
* $lte: {}
* deleted_at:
* type: object
* description: The reservation's deleted at.
* required:
* - $eq
* - $ne
* - $in
* - $nin
* - $like
* - $ilike
* - $re
* - $contains
* - $gt
* - $gte
* - $lt
* - $lte
* properties:
* $eq: {}
* $ne: {}
* $in: {}
* $nin: {}
* $like: {}
* $ilike: {}
* $re: {}
* $contains: {}
* $gt: {}
* $gte: {}
* $lt: {}
* $lte: {}
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/reservations' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "limit": 7964169955442688,
* "fields": "{value}",
* "order": "{value}",
* "offset": 3052067430072320,
* "quantity": {},
* "created_at": {},
* "updated_at": {},
* "deleted_at": {}
* }'
* tags:
* - Reservations
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_reservations_[id].ts
+61
View File
@@ -0,0 +1,61 @@
/**
* @oas [get] /admin/reservations/{id}
* operationId: GetReservationsId
* summary: Get a Reservation
* description: Retrieve a reservation by its ID. You can expand the reservation's
* relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The reservation's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - fields
* properties:
* fields:
* type: string
* title: fields
* description: The reservation's fields.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/reservations/{id}' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "fields": "{value}"
* }'
* tags:
* - Reservations
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_sales-channels.ts
+1 -41
View File
@@ -6,47 +6,7 @@
* filtered by fields such as `id`. The sales channels can also be sorted or * filtered by fields such as `id`. The sales channels can also be sorted or
* paginated. * paginated.
* x-authenticated: true * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_sales-channels_[id].ts
+9 -41
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -80,7 +40,15 @@
* requestBody: * requestBody:
* content: * content:
* application/json: * application/json:
* schema: {} * schema:
* type: object
* required:
* - fields
* properties:
* fields:
* type: string
* title: fields
* description: The sales channel's fields.
* *
*/ */
docs-util/oas-output/operations/admin/get_admin_shipping-options.ts
+74
View File
@@ -0,0 +1,74 @@
/**
* @oas [get] /admin/shipping-options
* operationId: GetShippingOptions
* summary: List Shipping Options
* description: Retrieve a list of shipping options. The shipping options can be
* filtered by fields such as `id`. The shipping options can also be sorted or
* paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - fields
* - offset
* - limit
* - order
* properties:
* fields:
* type: string
* title: fields
* description: The shipping option's fields.
* offset:
* type: number
* title: offset
* description: The shipping option's offset.
* limit:
* type: number
* title: limit
* description: The shipping option's limit.
* order:
* type: string
* title: order
* description: The shipping option's order.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/shipping-options' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "fields": "{value}",
* "offset": 8788876090933248,
* "limit": 2996103177830400,
* "order": "{value}"
* }'
* tags:
* - Shipping Options
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_shipping-profiles.ts
+39
View File
@@ -0,0 +1,39 @@
/**
* @oas [get] /admin/shipping-profiles
* operationId: GetShippingProfiles
* summary: List Shipping Profiles
* description: Retrieve a list of shipping profiles. The shipping profiles can be
* filtered by fields such as `id`. The shipping profiles can also be sorted or
* paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/shipping-profiles' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Shipping Profiles
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_shipping-profiles_[id].ts
+61
View File
@@ -0,0 +1,61 @@
/**
* @oas [get] /admin/shipping-profiles/{id}
* operationId: GetShippingProfilesId
* summary: Get a Shipping Profile
* description: Retrieve a shipping profile by its ID. You can expand the shipping
* profile's relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The shipping profile's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - fields
* properties:
* fields:
* type: string
* title: fields
* description: The shipping profile's fields.
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/shipping-profiles/{id}' \
* -H 'x-medusa-access-token: {api_token}' \
* -H 'Content-Type: application/json' \
* --data-raw '{
* "fields": "{value}"
* }'
* tags:
* - Shipping Profiles
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_stock-locations.ts
+39
View File
@@ -0,0 +1,39 @@
/**
* @oas [get] /admin/stock-locations
* operationId: GetStockLocations
* summary: List Stock Locations
* description: Retrieve a list of stock locations. The stock locations can be
* filtered by fields such as `id`. The stock locations can also be sorted or
* paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/stock-locations' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Stock Locations
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_stock-locations_[id].ts
+13 -2
View File
@@ -25,8 +25,6 @@
* tags: * tags:
* - Stock Locations * - Stock Locations
* responses: * responses:
* "200":
* description: OK
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
@@ -39,6 +37,19 @@
* $ref: "#/components/responses/invalid_request_error" * $ref: "#/components/responses/invalid_request_error"
* "500": * "500":
* $ref: "#/components/responses/500_error" * $ref: "#/components/responses/500_error"
* requestBody:
* content:
* application/json:
* schema:
* type: object
* description: SUMMARY
* required:
* - fields
* properties:
* fields:
* type: string
* title: fields
* description: The stock location's fields.
* *
*/ */
docs-util/oas-output/operations/admin/get_admin_stores.ts
+1 -41
View File
@@ -5,47 +5,7 @@
* description: Retrieve a list of stores. The stores can be filtered by fields * description: Retrieve a list of stores. The stores can be filtered by fields
* such as `id`. The stores can also be sorted or paginated. * such as `id`. The stores can also be sorted or paginated.
* x-authenticated: true * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_stores_[id].ts
+9 -41
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -80,7 +40,15 @@
* requestBody: * requestBody:
* content: * content:
* application/json: * application/json:
* schema: {} * schema:
* type: object
* required:
* - fields
* properties:
* fields:
* type: string
* title: fields
* description: The store's fields.
* *
*/ */
docs-util/oas-output/operations/admin/get_admin_tax-rates.ts
+1 -41
View File
@@ -5,47 +5,7 @@
* description: Retrieve a list of tax rates. The tax rates can be filtered by * 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. * fields such as `id`. The tax rates can also be sorted or paginated.
* x-authenticated: true * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_tax-rates_[id].ts
+9 -41
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
@@ -80,7 +40,15 @@
* requestBody: * requestBody:
* content: * content:
* application/json: * application/json:
* schema: {} * schema:
* type: object
* required:
* - fields
* properties:
* fields:
* type: string
* title: fields
* description: The tax rate's fields.
* *
*/ */
docs-util/oas-output/operations/admin/get_admin_tax-regions.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* @oas [get] /admin/tax-regions
* operationId: GetTaxRegions
* summary: List Tax Regions
* description: Retrieve a list of tax regions. The tax regions can be filtered by
* fields such as `id`. The tax regions can also be sorted or paginated.
* x-authenticated: true
* parameters: []
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/tax-regions' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Tax Regions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_tax-regions_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/tax-regions/{id}
* operationId: GetTaxRegionsId
* summary: Get a Tax Region
* description: Retrieve a tax region by its ID. You can expand the tax region's
* relations or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The tax region's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/tax-regions/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Tax Regions
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_uploads_[id].ts
+44
View File
@@ -0,0 +1,44 @@
/**
* @oas [get] /admin/uploads/{id}
* operationId: GetUploadsId
* summary: Get a Upload
* description: Retrieve a upload by its ID. You can expand the upload's relations
* or select the fields that should be returned.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The upload's ID.
* required: true
* schema:
* type: string
* security:
* - api_token: []
* - cookie_auth: []
* - jwt_token: []
* x-codeSamples:
* - lang: Shell
* label: cURL
* source: |-
* curl '{backend_url}/admin/uploads/{id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Uploads
* responses:
* "200":
* description: OK
* "400":
* $ref: "#/components/responses/400_error"
* "401":
* $ref: "#/components/responses/unauthorized"
* "404":
* $ref: "#/components/responses/not_found_error"
* "409":
* $ref: "#/components/responses/invalid_state_error"
* "422":
* $ref: "#/components/responses/invalid_request_error"
* "500":
* $ref: "#/components/responses/500_error"
*
*/
docs-util/oas-output/operations/admin/get_admin_users.ts
+1 -41
View File
@@ -5,47 +5,7 @@
* description: Retrieve a list of users. The users can be filtered by fields such * description: Retrieve a list of users. The users can be filtered by fields such
* as `id`. The users can also be sorted or paginated. * as `id`. The users can also be sorted or paginated.
* x-authenticated: true * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
docs-util/oas-output/operations/admin/get_admin_users_[id].ts
-40
View File
@@ -12,46 +12,6 @@
* required: true * required: true
* schema: * schema:
* type: string * 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: * security:
* - api_token: [] * - api_token: []
* - cookie_auth: [] * - cookie_auth: []
Loaded 100 of 299 files, more files were not shown because too many files have changed in this diff. Show more