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

medusajs · Aug 29, 2024 · 44d4af3 · 44d4af3
1 parent 75c5853
commit 44d4af3
Show file tree

Hide file tree

Showing 21 changed files with 151 additions and 124 deletions.
diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_api-keys_[id].ts
@@ -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":

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_campaigns_[id].ts
@@ -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.

diff --git a/...generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts b/...generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts
@@ -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

diff --git a/...nerated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts b/...nerated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts
@@ -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

diff --git a/...s-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts b/...s-output/operations/admin/delete_admin_claims_[id]_inbound_shipping-method_[action_id].ts
@@ -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

diff --git a/...erated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts b/...erated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts
@@ -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

diff --git a/...-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts b/...-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts
@@ -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

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_request.ts
@@ -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

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_collections_[id].ts
@@ -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

diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customer-groups_[id].ts
@@ -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

diff --git a/...nerated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts b/...nerated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts
@@ -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

diff --git a/...ated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts b/...ated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts
@@ -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

diff --git a/...utput/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts b/...utput/operations/admin/delete_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts
@@ -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