oas: [1/n] Improve admin OAS (#8850)

This commit is contained in:
Shahed Nasser
2024-08-29 20:07:33 +03:00
committed by GitHub
parent 75c5853163
commit 44d4af3a3f
21 changed files with 151 additions and 124 deletions
@@ -1,13 +1,14 @@
/** /**
* @oas [delete] /admin/api-keys/{id} * @oas [delete] /admin/api-keys/{id}
* operationId: DeleteApiKeysId * operationId: DeleteApiKeysId
* summary: Delete a Api Key * summary: Delete an Api Key
* description: Delete a api key. * description: >
* Delete a publishable or secret API key.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
* in: path * in: path
* description: The api key's ID. * description: The API key's ID.
* required: true * required: true
* schema: * schema:
* type: string * type: string
@@ -89,18 +90,19 @@
* id: * id:
* type: string * type: string
* title: id * title: id
* description: The api key's ID. * description: The API key's ID.
* object: * object:
* type: string * type: string
* title: object * title: object
* description: The api key's object. * description: The name of the object that was deleted.
* default: "api_key"
* deleted: * deleted:
* type: boolean * type: boolean
* title: deleted * title: deleted
* description: The api key's deleted. * description: Whether the API key was deleted.
* parent: * parent:
* type: object * type: object
* description: The api key's parent. * description: The API key's parent.
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
@@ -2,7 +2,8 @@
* @oas [delete] /admin/campaigns/{id} * @oas [delete] /admin/campaigns/{id}
* operationId: DeleteCampaignsId * operationId: DeleteCampaignsId
* summary: Delete a Campaign * summary: Delete a Campaign
* description: Delete a campaign. * description: >
* Delete a campaign by its ID. This doesn't delete promotions that belong to this campaign.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -93,11 +94,12 @@
* object: * object:
* type: string * type: string
* title: object * title: object
* description: The campaign's object. * description: The name of the object that was deleted.
* default: "campaign"
* deleted: * deleted:
* type: boolean * type: boolean
* title: deleted * title: deleted
* description: The campaign's deleted. * description: Whether the campaign was deleted.
* parent: * parent:
* type: object * type: object
* description: The campaign's parent. * description: The campaign's parent.
@@ -1,9 +1,14 @@
/** /**
* @oas [delete] /admin/claims/{id}/claim-items/{action_id} * @oas [delete] /admin/claims/{id}/claim-items/{action_id}
* operationId: DeleteClaimsIdClaimItemsAction_id * operationId: DeleteClaimsIdClaimItemsAction_id
* summary: Remove Claim Items from Claim * summary: Remove a Claim Item from a Claim
* description: Remove a list of claim items from a claim. This doesn't delete the * x-sidebar-summary: Remove Claim Item
* Claim Item, only the association between the Claim Item and the claim. * description: >
* Remove an order item from a claim by the ID of the item's `WRITE_OFF_ITEM` action.
*
*
* Every item has an `actions` property, whose value is an array of actions. You can check the action's
* name using its `action` property, and use the value of the `id` property.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -14,7 +19,7 @@
* type: string * type: string
* - name: action_id * - name: action_id
* in: path * in: path
* description: The claim's action id. * description: The ID of the order item's `WRITE_OFF_ITEM` action.
* required: true * required: true
* schema: * schema:
* type: string * type: string
@@ -1,9 +1,14 @@
/** /**
* @oas [delete] /admin/claims/{id}/inbound/items/{action_id} * @oas [delete] /admin/claims/{id}/inbound/items/{action_id}
* operationId: DeleteClaimsIdInboundItemsAction_id * operationId: DeleteClaimsIdInboundItemsAction_id
* summary: Remove Items from Claim * summary: Remove an Inbound Item from Claim
* description: Remove a list of items from a claim. This doesn't delete the Item, * x-sidebar-summary: Remove Inbound Item
* only the association between the Item and the claim. * description: >
* Remove an inbound (or return) item from a claim using the `ID` of the item's `RETURN_ITEM` action.
*
*
* Every item has an `actions` property, whose value is an array of actions. You can check the action's
* name using its `action` property, and use the value of the `id` property.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -14,7 +19,7 @@
* type: string * type: string
* - name: action_id * - name: action_id
* in: path * in: path
* description: The claim's action id. * description: The ID of the return item's `RETURN_ITEM` action.
* required: true * required: true
* schema: * schema:
* type: string * type: string
@@ -76,9 +81,7 @@
* - lang: Shell * - lang: Shell
* label: cURL * label: cURL
* source: >- * source: >-
* curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/items/{action_id}' * curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/items/{action_id}' \
* \
*
* -H 'x-medusa-access-token: {api_token}' * -H 'x-medusa-access-token: {api_token}'
* tags: * tags:
* - Claims * - Claims
@@ -1,10 +1,14 @@
/** /**
* @oas [delete] /admin/claims/{id}/inbound/shipping-method/{action_id} * @oas [delete] /admin/claims/{id}/inbound/shipping-method/{action_id}
* operationId: DeleteClaimsIdInboundShippingMethodAction_id * operationId: DeleteClaimsIdInboundShippingMethodAction_id
* summary: Remove Shipping Methods from Claim * summary: Remove Inbound Shipping Method from Claim
* description: Remove a list of shipping methods from a claim. This doesn't delete * x-sidebar-summary: Remove Inbound Shipping Method
* the Shipping Method, only the association between the Shipping Method and the * description: >
* claim. * Remove the shipping method for returning items in the claim using the `ID` of the method's `SHIPPING_ADD` action.
*
*
* Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's
* name using its `action` property, and use the value of the `id` property.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -15,7 +19,7 @@
* type: string * type: string
* - name: action_id * - name: action_id
* in: path * in: path
* description: The claim's action id. * description: The ID of the shipping method's `SHIPPING_ADD` action.
* required: true * required: true
* schema: * schema:
* type: string * type: string
@@ -77,9 +81,7 @@
* - lang: Shell * - lang: Shell
* label: cURL * label: cURL
* source: >- * source: >-
* curl -X DELETE * curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \
* '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \
*
* -H 'x-medusa-access-token: {api_token}' * -H 'x-medusa-access-token: {api_token}'
* tags: * tags:
* - Claims * - Claims
@@ -1,9 +1,14 @@
/** /**
* @oas [delete] /admin/claims/{id}/outbound/items/{action_id} * @oas [delete] /admin/claims/{id}/outbound/items/{action_id}
* operationId: DeleteClaimsIdOutboundItemsAction_id * operationId: DeleteClaimsIdOutboundItemsAction_id
* summary: Remove Items from Claim * summary: Remove an Outbound Item from Claim
* description: Remove a list of items from a claim. This doesn't delete the Item, * x-sidebar-summary: Remove Outbound Item
* only the association between the Item and the claim. * description: >
* Remove an outbound (or new) item from a claim using the `ID` of the item's `ITEM_ADD` action.
*
*
* Every item has an `actions` property, whose value is an array of actions. You can check the action's
* name using its `action` property, and use the value of the `id` property.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -14,7 +19,7 @@
* type: string * type: string
* - name: action_id * - name: action_id
* in: path * in: path
* description: The claim's action id. * description: The ID of the new claim item's `ITEM_ADD` action.
* required: true * required: true
* schema: * schema:
* type: string * type: string
@@ -76,9 +81,7 @@
* - lang: Shell * - lang: Shell
* label: cURL * label: cURL
* source: >- * source: >-
* curl -X DELETE * curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \
* '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \
*
* -H 'x-medusa-access-token: {api_token}' * -H 'x-medusa-access-token: {api_token}'
* tags: * tags:
* - Claims * - Claims
@@ -1,10 +1,14 @@
/** /**
* @oas [delete] /admin/claims/{id}/outbound/shipping-method/{action_id} * @oas [delete] /admin/claims/{id}/outbound/shipping-method/{action_id}
* operationId: DeleteClaimsIdOutboundShippingMethodAction_id * operationId: DeleteClaimsIdOutboundShippingMethodAction_id
* summary: Remove Shipping Methods from Claim * summary: Remove Outbound Shipping Method from Claim
* description: Remove a list of shipping methods from a claim. This doesn't delete * x-sidebar-summary: Remove Outbound Shipping Method
* the Shipping Method, only the association between the Shipping Method and the * description: >
* claim. * Remove the shipping method for delivering outbound items in the claim using the `ID` of the method's `SHIPPING_ADD` action.
*
*
* Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's
* name using its `action` property, and use the value of the `id` property.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -15,7 +19,7 @@
* type: string * type: string
* - name: action_id * - name: action_id
* in: path * in: path
* description: The claim's action id. * description: The ID of the shipping method's `SHIPPING_ADD` action.
* required: true * required: true
* schema: * schema:
* type: string * type: string
@@ -77,9 +81,7 @@
* - lang: Shell * - lang: Shell
* label: cURL * label: cURL
* source: >- * source: >-
* curl -X DELETE * curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \
* '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \
*
* -H 'x-medusa-access-token: {api_token}' * -H 'x-medusa-access-token: {api_token}'
* tags: * tags:
* - Claims * - Claims
@@ -1,9 +1,8 @@
/** /**
* @oas [delete] /admin/claims/{id}/request * @oas [delete] /admin/claims/{id}/request
* operationId: DeleteClaimsIdRequest * operationId: DeleteClaimsIdRequest
* summary: Remove Requests from Claim * summary: Cancel Claim Request
* description: Remove a list of requests from a claim. This doesn't delete the * description: Cancel a requested claim.
* Request, only the association between the Request and the claim.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -2,7 +2,7 @@
* @oas [delete] /admin/collections/{id} * @oas [delete] /admin/collections/{id}
* operationId: DeleteCollectionsId * operationId: DeleteCollectionsId
* summary: Delete a Collection * summary: Delete a Collection
* description: Delete a collection. * description: Delete a product collection.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -2,7 +2,8 @@
* @oas [delete] /admin/customer-groups/{id} * @oas [delete] /admin/customer-groups/{id}
* operationId: DeleteCustomerGroupsId * operationId: DeleteCustomerGroupsId
* summary: Delete a Customer Group * summary: Delete a Customer Group
* description: Delete a customer group. * description: >
* Delete a customer group. Customers in the group aren't deleted.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -1,9 +1,8 @@
/** /**
* @oas [delete] /admin/customers/{id}/addresses/{address_id} * @oas [delete] /admin/customers/{id}/addresses/{address_id}
* operationId: DeleteCustomersIdAddressesAddress_id * operationId: DeleteCustomersIdAddressesAddress_id
* summary: Remove Addresses from Customer * summary: Remove an Address from Customer
* description: Remove a list of addresses from a customer. This doesn't delete the * description: Remove a customer's address.
* Address, only the association between the Address and the customer.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -14,7 +13,7 @@
* type: string * type: string
* - name: address_id * - name: address_id
* in: path * in: path
* description: The customer's address id. * description: The customer address's ID.
* required: true * required: true
* schema: * schema:
* type: string * type: string
@@ -76,9 +75,7 @@
* - lang: Shell * - lang: Shell
* label: cURL * label: cURL
* source: >- * source: >-
* curl -X DELETE '{backend_url}/admin/customers/{id}/addresses/{address_id}' * curl -X DELETE '{backend_url}/admin/customers/{id}/addresses/{address_id}' \
* \
*
* -H 'x-medusa-access-token: {api_token}' * -H 'x-medusa-access-token: {api_token}'
* tags: * tags:
* - Customers * - Customers
@@ -1,9 +1,14 @@
/** /**
* @oas [delete] /admin/exchanges/{id}/inbound/items/{action_id} * @oas [delete] /admin/exchanges/{id}/inbound/items/{action_id}
* operationId: DeleteExchangesIdInboundItemsAction_id * operationId: DeleteExchangesIdInboundItemsAction_id
* summary: Remove Items from Exchange * summary: Remove Inbound Item from Exchange
* description: Remove a list of items from a exchange. This doesn't delete the * x-sidebar-summary: Remove Inbound Item
* Item, only the association between the Item and the exchange. * description: >
* Remove an inbound (or return) item from an exchange using the `ID` of the item's `RETURN_ITEM` action.
*
*
* Every item has an `actions` property, whose value is an array of actions. You can check the action's
* name using its `action` property, and use the value of the `id` property.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -14,7 +19,7 @@
* type: string * type: string
* - name: action_id * - name: action_id
* in: path * in: path
* description: The exchange's action id. * description: The ID of the return item's `RETURN_ITEM` action.
* required: true * required: true
* schema: * schema:
* type: string * type: string
@@ -76,9 +81,7 @@
* - lang: Shell * - lang: Shell
* label: cURL * label: cURL
* source: >- * source: >-
* curl -X DELETE * curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \
* '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \
*
* -H 'x-medusa-access-token: {api_token}' * -H 'x-medusa-access-token: {api_token}'
* tags: * tags:
* - Exchanges * - Exchanges
@@ -1,10 +1,14 @@
/** /**
* @oas [delete] /admin/exchanges/{id}/inbound/shipping-method/{action_id} * @oas [delete] /admin/exchanges/{id}/inbound/shipping-method/{action_id}
* operationId: DeleteExchangesIdInboundShippingMethodAction_id * operationId: DeleteExchangesIdInboundShippingMethodAction_id
* summary: Remove Shipping Methods from Exchange * summary: Remove Inbound Shipping Method from Exchange
* description: Remove a list of shipping methods from a exchange. This doesn't * x-sidebar-summary: Remove Inbound Shipping Method
* delete the Shipping Method, only the association between the Shipping Method * description: >
* and the exchange. * Remove the shipping method for returning items in the exchange using the `ID` of the method's `SHIPPING_ADD` action.
*
*
* Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's
* name using its `action` property, and use the value of the `id` property.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -15,7 +19,7 @@
* type: string * type: string
* - name: action_id * - name: action_id
* in: path * in: path
* description: The exchange's action id. * description: The ID of the shipping method's `SHIPPING_ADD` action.
* required: true * required: true
* schema: * schema:
* type: string * type: string
@@ -77,9 +81,7 @@
* - lang: Shell * - lang: Shell
* label: cURL * label: cURL
* source: >- * source: >-
* curl -X DELETE * curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \
* '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \
*
* -H 'x-medusa-access-token: {api_token}' * -H 'x-medusa-access-token: {api_token}'
* tags: * tags:
* - Exchanges * - Exchanges
@@ -1,9 +1,14 @@
/** /**
* @oas [delete] /admin/exchanges/{id}/outbound/items/{action_id} * @oas [delete] /admin/exchanges/{id}/outbound/items/{action_id}
* operationId: DeleteExchangesIdOutboundItemsAction_id * operationId: DeleteExchangesIdOutboundItemsAction_id
* summary: Remove Items from Exchange * summary: Remove Outbound Item from Exchange
* description: Remove a list of items from a exchange. This doesn't delete the * x-sidebar-summary: Remove Outbound Item
* Item, only the association between the Item and the exchange. * description: >
* Remove an outbound (or new) item from an exchange using the `ID` of the item's `ITEM_ADD` action.
*
*
* Every item has an `actions` property, whose value is an array of actions. You can check the action's
* name using its `action` property, and use the value of the `id` property.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -14,7 +19,7 @@
* type: string * type: string
* - name: action_id * - name: action_id
* in: path * in: path
* description: The exchange's action id. * description: The ID of the new exchange item's `ITEM_ADD` action.
* required: true * required: true
* schema: * schema:
* type: string * type: string
@@ -76,9 +81,7 @@
* - lang: Shell * - lang: Shell
* label: cURL * label: cURL
* source: >- * source: >-
* curl -X DELETE * curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \
* '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \
*
* -H 'x-medusa-access-token: {api_token}' * -H 'x-medusa-access-token: {api_token}'
* tags: * tags:
* - Exchanges * - Exchanges
@@ -1,10 +1,14 @@
/** /**
* @oas [delete] /admin/exchanges/{id}/outbound/shipping-method/{action_id} * @oas [delete] /admin/exchanges/{id}/outbound/shipping-method/{action_id}
* operationId: DeleteExchangesIdOutboundShippingMethodAction_id * operationId: DeleteExchangesIdOutboundShippingMethodAction_id
* summary: Remove Shipping Methods from Exchange * summary: Remove Outbound Shipping Method from Exchange
* description: Remove a list of shipping methods from a exchange. This doesn't * x-sidebar-summary: Remove Outbound Shipping Method
* delete the Shipping Method, only the association between the Shipping Method * description: >
* and the exchange. * Remove the shipping method for delivering outbound items in the exchange using the `ID` of the method's `SHIPPING_ADD` action.
*
*
* Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's
* name using its `action` property, and use the value of the `id` property.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -15,7 +19,7 @@
* type: string * type: string
* - name: action_id * - name: action_id
* in: path * in: path
* description: The exchange's action id. * description: The ID of the shipping method's `SHIPPING_ADD` action.
* required: true * required: true
* schema: * schema:
* type: string * type: string
@@ -77,10 +81,7 @@
* - lang: Shell * - lang: Shell
* label: cURL * label: cURL
* source: >- * source: >-
* curl -X DELETE * curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}'\
* '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}'
* \
*
* -H 'x-medusa-access-token: {api_token}' * -H 'x-medusa-access-token: {api_token}'
* tags: * tags:
* - Exchanges * - Exchanges
@@ -1,9 +1,8 @@
/** /**
* @oas [delete] /admin/exchanges/{id}/request * @oas [delete] /admin/exchanges/{id}/request
* operationId: DeleteExchangesIdRequest * operationId: DeleteExchangesIdRequest
* summary: Remove Requests from Exchange * summary: Cancel Exchange Request
* description: Remove a list of requests from a exchange. This doesn't delete the * description: Cancel a requested exchange.
* Request, only the association between the Request and the exchange.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -94,11 +93,12 @@
* object: * object:
* type: string * type: string
* title: object * title: object
* description: The exchange's object. * description: The name of the deleted object.
* default: "exchange"
* deleted: * deleted:
* type: boolean * type: boolean
* title: deleted * title: deleted
* description: The exchange's deleted. * description: Whether the exchange was deleted.
* parent: * parent:
* type: object * type: object
* description: The exchange's parent. * description: The exchange's parent.
@@ -1,7 +1,7 @@
/** /**
* @oas [delete] /admin/fulfillment-sets/{id} * @oas [delete] /admin/fulfillment-sets/{id}
* operationId: DeleteFulfillmentSetsId * operationId: DeleteFulfillmentSetsId
* summary: Delete a Fulfillment Set * summary: Delete Fulfillment Set
* description: Delete a fulfillment set. * description: Delete a fulfillment set.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
@@ -1,10 +1,9 @@
/** /**
* @oas [delete] /admin/fulfillment-sets/{id}/service-zones/{zone_id} * @oas [delete] /admin/fulfillment-sets/{id}/service-zones/{zone_id}
* operationId: DeleteFulfillmentSetsIdServiceZonesZone_id * operationId: DeleteFulfillmentSetsIdServiceZonesZone_id
* summary: Remove Service Zones from Fulfillment Set * summary: Remove a Service Zone from Fulfillment Set
* description: Remove a list of service zones from a fulfillment set. This doesn't * x-sidebar-summary: Remove Service Zone
* delete the Service Zone, only the association between the Service Zone and the * description: Remove a service zone that belongs to a fulfillment set.
* fulfillment set.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -15,7 +14,7 @@
* type: string * type: string
* - name: zone_id * - name: zone_id
* in: path * in: path
* description: The fulfillment set's zone id. * description: The service zone's ID.
* required: true * required: true
* schema: * schema:
* type: string * type: string
@@ -77,9 +76,7 @@
* - lang: Shell * - lang: Shell
* label: cURL * label: cURL
* source: >- * source: >-
* curl -X DELETE * curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \
* '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \
*
* -H 'x-medusa-access-token: {api_token}' * -H 'x-medusa-access-token: {api_token}'
* tags: * tags:
* - Fulfillment Sets * - Fulfillment Sets
@@ -99,18 +96,19 @@
* id: * id:
* type: string * type: string
* title: id * title: id
* description: The fulfillment set's ID. * description: The service zone's ID.
* object: * object:
* type: string * type: string
* title: object * title: object
* description: The fulfillment set's object. * description: The name of the deleted object.
* default: service_zone
* deleted: * deleted:
* type: boolean * type: boolean
* title: deleted * title: deleted
* description: The fulfillment set's deleted. * description: Whether the service zone was deleted.
* parent: * parent:
* type: object * type: object
* description: The fulfillment set's parent. * description: The fulfillment set that the service zone belongs to.
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
@@ -1,8 +1,8 @@
/** /**
* @oas [delete] /admin/inventory-items/{id} * @oas [delete] /admin/inventory-items/{id}
* operationId: DeleteInventoryItemsId * operationId: DeleteInventoryItemsId
* summary: Delete a Inventory Item * summary: Delete Inventory Item
* description: Delete a inventory item. * description: Delete an inventory item.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -93,11 +93,12 @@
* object: * object:
* type: string * type: string
* title: object * title: object
* description: The inventory item's object. * description: The name of the deleted object.
* default: "inventory_item"
* deleted: * deleted:
* type: boolean * type: boolean
* title: deleted * title: deleted
* description: The inventory item's deleted. * description: Whether the inventory item was deleted.
* parent: * parent:
* type: object * type: object
* description: The inventory item's parent. * description: The inventory item's parent.
@@ -1,10 +1,13 @@
/** /**
* @oas [delete] /admin/inventory-items/{id}/location-levels/{location_id} * @oas [delete] /admin/inventory-items/{id}/location-levels/{location_id}
* operationId: DeleteInventoryItemsIdLocationLevelsLocation_id * operationId: DeleteInventoryItemsIdLocationLevelsLocation_id
* summary: Remove Location Levels from Inventory Item * summary: Remove Inventory Level of Inventory Item
* description: Remove a list of location levels from a inventory item. This * x-sidebar-summary: Remove Inventory Level
* doesn't delete the Location Level, only the association between the Location * description: >
* Level and the inventory item. * Remove the inventory level of an inventory item.
*
*
* If the inventory level has reserved quantity greater than `0`, an error is thrown.
* x-authenticated: true * x-authenticated: true
* parameters: * parameters:
* - name: id * - name: id
@@ -77,9 +80,7 @@
* - lang: Shell * - lang: Shell
* label: cURL * label: cURL
* source: >- * source: >-
* curl -X DELETE * curl -X DELETE '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \
* '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \
*
* -H 'x-medusa-access-token: {api_token}' * -H 'x-medusa-access-token: {api_token}'
* tags: * tags:
* - Inventory Items * - Inventory Items
@@ -99,18 +100,19 @@
* id: * id:
* type: string * type: string
* title: id * title: id
* description: The inventory item's ID. * description: The inventory level's ID.
* object: * object:
* type: string * type: string
* title: object * title: object
* description: The inventory item's object. * description: The name of the deleted object.
* default: inventory-level
* deleted: * deleted:
* type: boolean * type: boolean
* title: deleted * title: deleted
* description: The inventory item's deleted. * description: Whether the inventory level was deleted.
* parent: * parent:
* type: object * type: object
* description: The inventory item's parent. * description: The inventory item of the level.
* "400": * "400":
* $ref: "#/components/responses/400_error" * $ref: "#/components/responses/400_error"
* "401": * "401":
@@ -1,8 +1,8 @@
/** /**
* @oas [delete] /admin/invites/{id} * @oas [delete] /admin/invites/{id}
* operationId: DeleteInvitesId * operationId: DeleteInvitesId
* summary: Delete a Invite * summary: Delete Invite
* description: Delete a invite. * description: Delete an invite.
* x-authenticated: false * x-authenticated: false
* parameters: * parameters:
* - name: id * - name: id
@@ -87,11 +87,12 @@
* object: * object:
* type: string * type: string
* title: object * title: object
* description: The invite's object. * description: The name of the deleted object.
* default: "invite"
* deleted: * deleted:
* type: boolean * type: boolean
* title: deleted * title: deleted
* description: The invite's deleted. * description: Whether the invite was deleted.
* parent: * parent:
* type: object * type: object
* description: The invite's parent. * description: The invite's parent.