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

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

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

16
www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts
View File

@@ -1,13 +1,14 @@
/**
* @oas [delete] /admin/api-keys/{id}
* operationId: DeleteApiKeysId
* summary: Delete a Api Key
* description: Delete a api key.
* summary: Delete an Api Key
* description: >
* Delete a publishable or secret API key.
* x-authenticated: true
* parameters:
* - name: id
* in: path
* description: The api key's ID.
* description: The API key's ID.
* required: true
* schema:
* type: string
@@ -89,18 +90,19 @@
* id:
* type: string
* title: id
* description: The api key's ID.
* description: The API key's ID.
* object:
* type: string
* title: object
* description: The api key's object.
* description: The name of the object that was deleted.
* default: "api_key"
* deleted:
* type: boolean
* title: deleted
* description: The api key's deleted.
* description: Whether the API key was deleted.
* parent:
* type: object
* description: The api key's parent.
* description: The API key's parent.
* "400":
* $ref: "#/components/responses/400_error"
* "401":

8
www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts
View File

@@ -2,7 +2,8 @@
* @oas [delete] /admin/campaigns/{id}
* operationId: DeleteCampaignsId
* 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
* parameters:
* - name: id
@@ -93,11 +94,12 @@
* object:
* type: string
* title: object
* description: The campaign's object.
* description: The name of the object that was deleted.
* default: "campaign"
* deleted:
* type: boolean
* title: deleted
* description: The campaign's deleted.
* description: Whether the campaign was deleted.
* parent:
* type: object
* description: The campaign's parent.

13
www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts
View File

@@ -1,9 +1,14 @@
/**
* @oas [delete] /admin/claims/{id}/claim-items/{action_id}
* operationId: DeleteClaimsIdClaimItemsAction_id
* summary: Remove Claim Items from Claim
* description: Remove a list of claim items from a claim. This doesn't delete the
* Claim Item, only the association between the Claim Item and the claim.
* summary: Remove a Claim Item from a Claim
* x-sidebar-summary: Remove Claim Item
* 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
* parameters:
* - name: id
@@ -14,7 +19,7 @@
* type: string
* - name: action_id
* in: path
* description: The claim's action id.
* description: The ID of the order item's `WRITE_OFF_ITEM` action.
* required: true
* schema:
* type: string

17
www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts
View File

@@ -1,9 +1,14 @@
/**
* @oas [delete] /admin/claims/{id}/inbound/items/{action_id}
* operationId: DeleteClaimsIdInboundItemsAction_id
* summary: Remove Items from Claim
* description: Remove a list of items from a claim. This doesn't delete the Item,
* only the association between the Item and the claim.
* summary: Remove an Inbound Item from Claim
* x-sidebar-summary: Remove Inbound Item
* 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
* parameters:
* - name: id
@@ -14,7 +19,7 @@
* type: string
* - name: action_id
* in: path
* description: The claim's action id.
* description: The ID of the return item's `RETURN_ITEM` action.
* required: true
* schema:
* type: string
@@ -76,9 +81,7 @@
* - lang: Shell
* label: cURL
* 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}'
* tags:
* - Claims

18
www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts
View File

@@ -1,10 +1,14 @@
/**
* @oas [delete] /admin/claims/{id}/inbound/shipping-method/{action_id}
* operationId: DeleteClaimsIdInboundShippingMethodAction_id
* summary: Remove Shipping Methods from Claim
* description: Remove a list of shipping methods from a claim. This doesn't delete
* the Shipping Method, only the association between the Shipping Method and the
* claim.
* summary: Remove Inbound Shipping Method from Claim
* x-sidebar-summary: Remove Inbound Shipping Method
* description: >
* 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
* parameters:
* - name: id
@@ -15,7 +19,7 @@
* type: string
* - name: action_id
* in: path
* description: The claim's action id.
* description: The ID of the shipping method's `SHIPPING_ADD` action.
* required: true
* schema:
* type: string
@@ -77,9 +81,7 @@
* - lang: Shell
* label: cURL
* source: >-
* curl -X DELETE
* '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \
*
* curl -X DELETE '{backend_url}/admin/claims/{id}/inbound/shipping-method/{action_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims

17
www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts
View File

@@ -1,9 +1,14 @@
/**
* @oas [delete] /admin/claims/{id}/outbound/items/{action_id}
* operationId: DeleteClaimsIdOutboundItemsAction_id
* summary: Remove Items from Claim
* description: Remove a list of items from a claim. This doesn't delete the Item,
* only the association between the Item and the claim.
* summary: Remove an Outbound Item from Claim
* x-sidebar-summary: Remove Outbound Item
* 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
* parameters:
* - name: id
@@ -14,7 +19,7 @@
* type: string
* - name: action_id
* in: path
* description: The claim's action id.
* description: The ID of the new claim item's `ITEM_ADD` action.
* required: true
* schema:
* type: string
@@ -76,9 +81,7 @@
* - lang: Shell
* label: cURL
* source: >-
* curl -X DELETE
* '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \
*
* curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/items/{action_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims

18
www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts
View File

@@ -1,10 +1,14 @@
/**
* @oas [delete] /admin/claims/{id}/outbound/shipping-method/{action_id}
* operationId: DeleteClaimsIdOutboundShippingMethodAction_id
* summary: Remove Shipping Methods from Claim
* description: Remove a list of shipping methods from a claim. This doesn't delete
* the Shipping Method, only the association between the Shipping Method and the
* claim.
* summary: Remove Outbound Shipping Method from Claim
* x-sidebar-summary: Remove Outbound Shipping Method
* description: >
* 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
* parameters:
* - name: id
@@ -15,7 +19,7 @@
* type: string
* - name: action_id
* in: path
* description: The claim's action id.
* description: The ID of the shipping method's `SHIPPING_ADD` action.
* required: true
* schema:
* type: string
@@ -77,9 +81,7 @@
* - lang: Shell
* label: cURL
* source: >-
* curl -X DELETE
* '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \
*
* curl -X DELETE '{backend_url}/admin/claims/{id}/outbound/shipping-method/{action_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Claims

5
www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_request.ts
View File

@@ -1,9 +1,8 @@
/**
* @oas [delete] /admin/claims/{id}/request
* operationId: DeleteClaimsIdRequest
* summary: Remove Requests from Claim
* description: Remove a list of requests from a claim. This doesn't delete the
* Request, only the association between the Request and the claim.
* summary: Cancel Claim Request
* description: Cancel a requested claim.
* x-authenticated: true
* parameters:
* - name: id

2
www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts
View File

@@ -2,7 +2,7 @@
* @oas [delete] /admin/collections/{id}
* operationId: DeleteCollectionsId
* summary: Delete a Collection
* description: Delete a collection.
* description: Delete a product collection.
* x-authenticated: true
* parameters:
* - name: id

3
www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts
View File

@@ -2,7 +2,8 @@
* @oas [delete] /admin/customer-groups/{id}
* operationId: DeleteCustomerGroupsId
* 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
* parameters:
* - name: id

11
www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts
View File

@@ -1,9 +1,8 @@
/**
* @oas [delete] /admin/customers/{id}/addresses/{address_id}
* operationId: DeleteCustomersIdAddressesAddress_id
* summary: Remove Addresses from Customer
* description: Remove a list of addresses from a customer. This doesn't delete the
* Address, only the association between the Address and the customer.
* summary: Remove an Address from Customer
* description: Remove a customer's address.
* x-authenticated: true
* parameters:
* - name: id
@@ -14,7 +13,7 @@
* type: string
* - name: address_id
* in: path
* description: The customer's address id.
* description: The customer address's ID.
* required: true
* schema:
* type: string
@@ -76,9 +75,7 @@
* - lang: Shell
* label: cURL
* 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}'
* tags:
* - Customers

17
www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts
View File

@@ -1,9 +1,14 @@
/**
* @oas [delete] /admin/exchanges/{id}/inbound/items/{action_id}
* operationId: DeleteExchangesIdInboundItemsAction_id
* summary: Remove Items from Exchange
* description: Remove a list of items from a exchange. This doesn't delete the
* Item, only the association between the Item and the exchange.
* summary: Remove Inbound Item from Exchange
* x-sidebar-summary: Remove Inbound Item
* 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
* parameters:
* - name: id
@@ -14,7 +19,7 @@
* type: string
* - name: action_id
* in: path
* description: The exchange's action id.
* description: The ID of the return item's `RETURN_ITEM` action.
* required: true
* schema:
* type: string
@@ -76,9 +81,7 @@
* - lang: Shell
* label: cURL
* source: >-
* curl -X DELETE
* '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \
*
* curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/items/{action_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Exchanges

18
www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts
View File

@@ -1,10 +1,14 @@
/**
* @oas [delete] /admin/exchanges/{id}/inbound/shipping-method/{action_id}
* operationId: DeleteExchangesIdInboundShippingMethodAction_id
* summary: Remove Shipping Methods from Exchange
* description: Remove a list of shipping methods from a exchange. This doesn't
* delete the Shipping Method, only the association between the Shipping Method
* and the exchange.
* summary: Remove Inbound Shipping Method from Exchange
* x-sidebar-summary: Remove Inbound Shipping Method
* description: >
* 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
* parameters:
* - name: id
@@ -15,7 +19,7 @@
* type: string
* - name: action_id
* in: path
* description: The exchange's action id.
* description: The ID of the shipping method's `SHIPPING_ADD` action.
* required: true
* schema:
* type: string
@@ -77,9 +81,7 @@
* - lang: Shell
* label: cURL
* source: >-
* curl -X DELETE
* '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \
*
* curl -X DELETE '{backend_url}/admin/exchanges/{id}/inbound/shipping-method/{action_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Exchanges

17
www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts
View File

@@ -1,9 +1,14 @@
/**
* @oas [delete] /admin/exchanges/{id}/outbound/items/{action_id}
* operationId: DeleteExchangesIdOutboundItemsAction_id
* summary: Remove Items from Exchange
* description: Remove a list of items from a exchange. This doesn't delete the
* Item, only the association between the Item and the exchange.
* summary: Remove Outbound Item from Exchange
* x-sidebar-summary: Remove Outbound Item
* 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
* parameters:
* - name: id
@@ -14,7 +19,7 @@
* type: string
* - name: action_id
* in: path
* description: The exchange's action id.
* description: The ID of the new exchange item's `ITEM_ADD` action.
* required: true
* schema:
* type: string
@@ -76,9 +81,7 @@
* - lang: Shell
* label: cURL
* source: >-
* curl -X DELETE
* '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \
*
* curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/items/{action_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Exchanges

19
www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts
View File

@@ -1,10 +1,14 @@
/**
* @oas [delete] /admin/exchanges/{id}/outbound/shipping-method/{action_id}
* operationId: DeleteExchangesIdOutboundShippingMethodAction_id
* summary: Remove Shipping Methods from Exchange
* description: Remove a list of shipping methods from a exchange. This doesn't
* delete the Shipping Method, only the association between the Shipping Method
* and the exchange.
* summary: Remove Outbound Shipping Method from Exchange
* x-sidebar-summary: Remove Outbound Shipping Method
* description: >
* 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
* parameters:
* - name: id
@@ -15,7 +19,7 @@
* type: string
* - name: action_id
* in: path
* description: The exchange's action id.
* description: The ID of the shipping method's `SHIPPING_ADD` action.
* required: true
* schema:
* type: string
@@ -77,10 +81,7 @@
* - lang: Shell
* label: cURL
* source: >-
* curl -X DELETE
* '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}'
* \
*
* curl -X DELETE '{backend_url}/admin/exchanges/{id}/outbound/shipping-method/{action_id}'\
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Exchanges

10
www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_request.ts
View File

@@ -1,9 +1,8 @@
/**
* @oas [delete] /admin/exchanges/{id}/request
* operationId: DeleteExchangesIdRequest
* summary: Remove Requests from Exchange
* description: Remove a list of requests from a exchange. This doesn't delete the
* Request, only the association between the Request and the exchange.
* summary: Cancel Exchange Request
* description: Cancel a requested exchange.
* x-authenticated: true
* parameters:
* - name: id
@@ -94,11 +93,12 @@
* object:
* type: string
* title: object
* description: The exchange's object.
* description: The name of the deleted object.
* default: "exchange"
* deleted:
* type: boolean
* title: deleted
* description: The exchange's deleted.
* description: Whether the exchange was deleted.
* parent:
* type: object
* description: The exchange's parent.

2
www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id].ts
View File

@@ -1,7 +1,7 @@
/**
* @oas [delete] /admin/fulfillment-sets/{id}
* operationId: DeleteFulfillmentSetsId
* summary: Delete a Fulfillment Set
* summary: Delete Fulfillment Set
* description: Delete a fulfillment set.
* x-authenticated: true
* parameters:

22
www/utils/generated/oas-output/operations/admin/delete_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts
View File

@@ -1,10 +1,9 @@
/**
* @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.
* summary: Remove a Service Zone from Fulfillment Set
* x-sidebar-summary: Remove Service Zone
* description: Remove a service zone that belongs to a fulfillment set.
* x-authenticated: true
* parameters:
* - name: id
@@ -15,7 +14,7 @@
* type: string
* - name: zone_id
* in: path
* description: The fulfillment set's zone id.
* description: The service zone's ID.
* required: true
* schema:
* type: string
@@ -77,9 +76,7 @@
* - lang: Shell
* label: cURL
* source: >-
* curl -X DELETE
* '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \
*
* curl -X DELETE '{backend_url}/admin/fulfillment-sets/{id}/service-zones/{zone_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Fulfillment Sets
@@ -99,18 +96,19 @@
* id:
* type: string
* title: id
* description: The fulfillment set's ID.
* description: The service zone's ID.
* object:
* type: string
* title: object
* description: The fulfillment set's object.
* description: The name of the deleted object.
* default: service_zone
* deleted:
* type: boolean
* title: deleted
* description: The fulfillment set's deleted.
* description: Whether the service zone was deleted.
* parent:
* type: object
* description: The fulfillment set's parent.
* description: The fulfillment set that the service zone belongs to.
* "400":
* $ref: "#/components/responses/400_error"
* "401":

9
www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id].ts
View File

@@ -1,8 +1,8 @@
/**
* @oas [delete] /admin/inventory-items/{id}
* operationId: DeleteInventoryItemsId
* summary: Delete a Inventory Item
* description: Delete a inventory item.
* summary: Delete Inventory Item
* description: Delete an inventory item.
* x-authenticated: true
* parameters:
* - name: id
@@ -93,11 +93,12 @@
* object:
* type: string
* title: object
* description: The inventory item's object.
* description: The name of the deleted object.
* default: "inventory_item"
* deleted:
* type: boolean
* title: deleted
* description: The inventory item's deleted.
* description: Whether the inventory item was deleted.
* parent:
* type: object
* description: The inventory item's parent.

24
www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts
View File

@@ -1,10 +1,13 @@
/**
* @oas [delete] /admin/inventory-items/{id}/location-levels/{location_id}
* operationId: DeleteInventoryItemsIdLocationLevelsLocation_id
* summary: Remove Location Levels from Inventory Item
* description: Remove a list of location levels from a inventory item. This
* doesn't delete the Location Level, only the association between the Location
* Level and the inventory item.
* summary: Remove Inventory Level of Inventory Item
* x-sidebar-summary: Remove Inventory Level
* description: >
* 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
* parameters:
* - name: id
@@ -77,9 +80,7 @@
* - lang: Shell
* label: cURL
* source: >-
* curl -X DELETE
* '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \
*
* curl -X DELETE '{backend_url}/admin/inventory-items/{id}/location-levels/{location_id}' \
* -H 'x-medusa-access-token: {api_token}'
* tags:
* - Inventory Items
@@ -99,18 +100,19 @@
* id:
* type: string
* title: id
* description: The inventory item's ID.
* description: The inventory level's ID.
* object:
* type: string
* title: object
* description: The inventory item's object.
* description: The name of the deleted object.
* default: inventory-level
* deleted:
* type: boolean
* title: deleted
* description: The inventory item's deleted.
* description: Whether the inventory level was deleted.
* parent:
* type: object
* description: The inventory item's parent.
* description: The inventory item of the level.
* "400":
* $ref: "#/components/responses/400_error"
* "401":

9
www/utils/generated/oas-output/operations/admin/delete_admin_invites_[id].ts
View File

@@ -1,8 +1,8 @@
/**
* @oas [delete] /admin/invites/{id}
* operationId: DeleteInvitesId
* summary: Delete a Invite
* description: Delete a invite.
* summary: Delete Invite
* description: Delete an invite.
* x-authenticated: false
* parameters:
* - name: id
@@ -87,11 +87,12 @@
* object:
* type: string
* title: object
* description: The invite's object.
* description: The name of the deleted object.
* default: "invite"
* deleted:
* type: boolean
* title: deleted
* description: The invite's deleted.
* description: Whether the invite was deleted.
* parent:
* type: object
* description: The invite's parent.