docs: adjust summary length of endpoints (#2188)

* change titles for admin apis

* adjusted titles for storefront apis

* added a note about length in contribution guidelines

* adjusted title for get customer endpoint

docs/content/contribution-guidelines.md

@@ -67,7 +67,7 @@ When the documentation page is a tutorial documentation, the label in the sideba
 
 ### Character Count
 
-The character count of the sidebar item's label must be at most twenty seven characters.
+The character count of the sidebar item's label must be at most twenty seven characters. For the API Reference, the sidebar item's label must be at most twenty five characters.
 
 ## Notes and Additional Information
 

packages/medusa/src/api/routes/admin/apps/authorize-app.ts

@@ -6,7 +6,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [post] /apps/authorizations
  * operationId: "PostApps"
- * summary: "Generates a token for an application."
+ * summary: "Generate Token for App"
  * description: "Generates a token for an application."
  * x-authenticated: true
  * requestBody:

packages/medusa/src/api/routes/admin/apps/list.ts

@@ -3,7 +3,7 @@ import { OauthService } from "../../../../services"
 /**
  * @oas [get] /apps
  * operationId: "GetApps"
- * summary: "List applications"
+ * summary: "List Applications"
  * description: "Retrieve a list of applications."
  * x-authenticated: true
  * x-codeSamples:

packages/medusa/src/api/routes/admin/auth/create-session.ts

@@ -10,7 +10,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [post] /auth
  * operationId: "PostAuth"
- * summary: "Authenticate a User"
+ * summary: "User Login"
  * x-authenticated: false
  * description: "Logs a User in and authorizes them to manage Store settings."
  * parameters:

packages/medusa/src/api/routes/admin/auth/delete-session.ts

@@ -1,7 +1,7 @@
 /**
  * @oas [delete] /auth
  * operationId: "DeleteAuth"
- * summary: "Delete Session"
+ * summary: "User Logout"
  * x-authenticated: true
  * description: "Deletes the current session for the logged in user."
  * x-codeSamples:

packages/medusa/src/api/routes/admin/auth/get-session.ts

@@ -4,7 +4,7 @@ import _ from "lodash"
 /**
  * @oas [get] /auth
  * operationId: "GetAuth"
- * summary: "Get Session"
+ * summary: "Get Current User"
  * x-authenticated: true
  * description: "Gets the currently logged in User."
  * x-codeSamples:

packages/medusa/src/api/routes/admin/batch/cancel-batch-job.ts

@@ -4,7 +4,7 @@ import { EntityManager } from "typeorm"
 /**
  * @oas [post] /batch-jobs/{id}/cancel
  * operationId: "PostBatchJobsBatchJobCancel"
- * summary: "Marks a batch job as canceled"
+ * summary: "Cancel a Batch Job"
  * description: "Marks a batch job as canceled"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/batch/confirm-batch-job.ts

@@ -4,7 +4,7 @@ import { EntityManager } from "typeorm"
 /**
  * @oas [post] /batch-jobs/{id}/confirm
  * operationId: "PostBatchJobsBatchJobConfirmProcessing"
- * summary: "Confirm a batch job"
+ * summary: "Confirm a Batch Job"
  * description: "Confirms that a previously requested batch job should be executed."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/batch/get-batch-job.ts

@@ -1,7 +1,7 @@
 /**
  * @oas [get] /batch-jobs/{id}
  * operationId: "GetBatchJobsBatchJob"
- * summary: "Retrieve a Batch Job"
+ * summary: "Get a Batch Job"
  * description: "Retrieves a Batch Job."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/collections/add-products.ts

@@ -7,7 +7,7 @@ import ProductCollectionService from "../../../../services/product-collection"
 /**
  * @oas [post] /collections/{id}/products/batch
  * operationId: "PostProductsToCollection"
- * summary: "Updates products associated with a Product Collection"
+ * summary: "Update Products"
  * description: "Updates products associated with a Product Collection"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/collections/create-collection.ts

@@ -6,7 +6,7 @@ import { EntityManager } from "typeorm"
 /**
  * @oas [post] /collections
  * operationId: "PostCollections"
- * summary: "Create a Product Collection"
+ * summary: "Create a Collection"
  * description: "Creates a Product Collection."
  * x-authenticated: true
  * requestBody:

packages/medusa/src/api/routes/admin/collections/delete-collection.ts

@@ -6,7 +6,7 @@ import ProductCollectionService from "../../../../services/product-collection"
 /**
  * @oas [delete] /collections/{id}
  * operationId: "DeleteCollectionsCollection"
- * summary: "Delete a Product Collection"
+ * summary: "Delete a Collection"
  * description: "Deletes a Product Collection."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/collections/get-collection.ts

@@ -5,7 +5,7 @@ import { defaultAdminCollectionsRelations } from "."
 /**
  * @oas [get] /collections/{id}
  * operationId: "GetCollectionsCollection"
- * summary: "Retrieve a Product Collection"
+ * summary: "Get a Collection"
  * description: "Retrieves a Product Collection."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/collections/list-collections.ts

@@ -9,7 +9,7 @@ import { Type } from "class-transformer"
 /**
  * @oas [get] /collections
  * operationId: "GetCollections"
- * summary: "List Product Collections"
+ * summary: "List Collections"
  * description: "Retrieve a list of Product Collection."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/collections/remove-products.ts

@@ -7,7 +7,7 @@ import ProductCollectionService from "../../../../services/product-collection"
 /**
  * @oas [delete] /collections/{id}/products/batch
  * operationId: "DeleteProductsFromCollection"
- * summary: "Removes products associated with a Product Collection"
+ * summary: "Remove Product"
  * description: "Removes products associated with a Product Collection"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/collections/update-collection.ts

@@ -6,7 +6,7 @@ import ProductCollectionService from "../../../../services/product-collection"
 /**
  * @oas [post] /collections/{id}
  * operationId: "PostCollectionsCollection"
- * summary: "Update a Product Collection"
+ * summary: "Update a Collection"
  * description: "Updates a Product Collection."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/customer-groups/add-customers-batch.ts

@@ -10,7 +10,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [post] /customer-groups/{id}/customers/batch
  * operationId: "PostCustomerGroupsGroupCustomersBatch"
- * summary: "Add a list of customers to a customer group "
+ * summary: "Add Customers"
  * description: "Adds a list of customers, represented by id's, to a customer group."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts

@@ -8,7 +8,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [post] /customer-groups
  * operationId: "PostCustomerGroups"
- * summary: "Create a CustomerGroup"
+ * summary: "Create a Customer Group"
  * description: "Creates a CustomerGroup."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/customer-groups/delete-customer-group.ts

@@ -6,7 +6,7 @@ import { EntityManager } from "typeorm"
 /**
  * @oas [delete] /customer-groups/{id}
  * operationId: "DeleteCustomerGroupsCustomerGroup"
- * summary: "Delete a CustomerGroup"
+ * summary: "Delete a Customer Group"
  * description: "Deletes a CustomerGroup."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/customer-groups/delete-customers-batch.ts

@@ -10,7 +10,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [delete] /customer-groups/{id}/customers/batch
  * operationId: "DeleteCustomerGroupsGroupCustomerBatch"
- * summary: "Remove a list of customers from a customer group "
+ * summary: "Remove Customers"
  * description: "Removes a list of customers, represented by id's, from a customer group."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/customer-groups/get-customer-group.ts

@@ -6,7 +6,7 @@ import { FindParams } from "../../../../types/common"
 /**
  * @oas [get] /customer-groups/{id}
  * operationId: "GetCustomerGroupsGroup"
- * summary: "Retrieve a CustomerGroup"
+ * summary: "Get a Customer Group"
  * description: "Retrieves a Customer Group."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts

@@ -8,7 +8,7 @@ import { Type } from "class-transformer"
 /**
  * @oas [get] /customer-groups
  * operationId: "GetCustomerGroups"
- * summary: "Retrieve a list of customer groups"
+ * summary: "List Customer Groups"
  * description: "Retrieve a list of customer groups."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts

@@ -10,7 +10,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [post] /customer-groups/{id}
  * operationId: "PostCustomerGroupsGroup"
- * summary: "Update a CustomerGroup"
+ * summary: "Update a Customer Group"
  * description: "Update a CustomerGroup."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/customers/get-customer.ts

@@ -6,7 +6,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [get] /customers/{id}
  * operationId: "GetCustomersCustomer"
- * summary: "Retrieve a Customer"
+ * summary: "Get a Customer"
  * description: "Retrieves a Customer."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/discounts/add-region.ts

@@ -7,7 +7,7 @@ import { EntityManager } from "typeorm"
 /**
  * @oas [post] /discounts/{id}/regions/{region_id}
  * operationId: "PostDiscountsDiscountRegionsRegion"
- * summary: "Adds Region availability"
+ * summary: "Add Region"
  * description: "Adds a Region to the list of Regions that a Discount can be used in."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/discounts/create-condition.ts

@@ -12,7 +12,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [post] /discounts/{discount_id}/conditions
  * operationId: "PostDiscountsDiscountConditions"
- * summary: "Create a DiscountCondition"
+ * summary: "Create a Condition"
  * description: "Creates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/discounts/create-dynamic-code.ts

@@ -14,8 +14,8 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [post] /discounts/{id}/dynamic-codes
  * operationId: "PostDiscountsDiscountDynamicCodes"
- * summary: "Create a dynamic Discount code"
- * description: "Creates a unique code that can map to a parent Discount. This is useful if you want to automatically generate codes with the same behaviour."
+ * summary: "Create a Dynamic Code"
+ * description: "Creates a dynamic unique code that can map to a parent Discount. This is useful if you want to automatically generate codes with the same behaviour."
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Discount to create the dynamic code from."

packages/medusa/src/api/routes/admin/discounts/delete-condition.ts

@@ -12,7 +12,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [delete] /discounts/{discount_id}/conditions/{condition_id}
  * operationId: "DeleteDiscountsDiscountConditionsCondition"
- * summary: "Delete a DiscountCondition"
+ * summary: "Delete a Condition"
  * description: "Deletes a DiscountCondition"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/discounts/delete-dynamic-code.ts

@@ -6,7 +6,7 @@ import { EntityManager } from "typeorm"
 /**
  * @oas [delete] /discounts/{id}/dynamic-codes/{code}
  * operationId: "DeleteDiscountsDiscountDynamicCodesCode"
- * summary: "Delete a dynamic code"
+ * summary: "Delete a Dynamic Code"
  * description: "Deletes a dynamic code from a Discount."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/discounts/get-condition.ts

@@ -14,7 +14,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [get] /discounts/{discount_id}/conditions/{condition_id}
  * operationId: "GetDiscountsDiscountConditionsCondition"
- * summary: "Gets a DiscountCondition"
+ * summary: "Get a Condition"
  * description: "Gets a DiscountCondition"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/discounts/get-discount-by-code.ts

@@ -8,7 +8,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [get] /discounts/code/{code}
  * operationId: "GetDiscountsDiscountCode"
- * summary: "Retrieve a Discount by code"
+ * summary: "Get Discount by Code"
  * description: "Retrieves a Discount by its discount code"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/discounts/get-discount.ts

@@ -8,7 +8,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [get] /discounts/{id}
  * operationId: "GetDiscountsDiscount"
- * summary: "Retrieve a Discount"
+ * summary: "Get a Discount"
  * description: "Retrieves a Discount"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/discounts/remove-region.ts

@@ -6,7 +6,7 @@ import { EntityManager } from "typeorm"
 /**
  * @oas [delete] /discounts/{id}/regions/{region_id}
  * operationId: "DeleteDiscountsDiscountRegionsRegion"
- * summary: "Remove Region availability"
+ * summary: "Remove Region"
  * x-authenticated: true
  * description: "Removes a Region from the list of Regions that a Discount can be used in."
  * parameters:

packages/medusa/src/api/routes/admin/discounts/update-condition.ts

@@ -12,7 +12,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [post] /discounts/{discount_id}/conditions/{condition_id}
  * operationId: "PostDiscountsDiscountConditionsCondition"
- * summary: "Update a DiscountCondition"
+ * summary: "Update a Condition"
  * description: "Updates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/draft-orders/create-line-item.ts

@@ -24,7 +24,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [post] /draft-orders/{id}/line-items
  * operationId: "PostDraftOrdersDraftOrderLineItems"
- * summary: "Create a Line Item for Draft Order"
+ * summary: "Create a Line Item"
  * description: "Creates a Line Item for the Draft Order"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/draft-orders/get-draft-order.ts

@@ -11,7 +11,7 @@ import { DraftOrder } from "../../../.."
 /**
  * @oas [get] /draft-orders/{id}
  * operationId: "GetDraftOrdersDraftOrder"
- * summary: "Retrieve a Draft Order"
+ * summary: "Get a Draft Order"
  * description: "Retrieves a Draft Order."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/draft-orders/register-payment.ts

@@ -13,7 +13,7 @@ import { EntityManager } from "typeorm"
 
 /**
  * @oas [post] /draft-orders/{id}/pay
- * summary: "Registers a payment for a Draft Order"
+ * summary: "Registers a Payment"
  * operationId: "PostDraftOrdersDraftOrderRegisterPayment"
  * description: "Registers a payment for a Draft Order."
  * x-authenticated: true

packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts

@@ -22,7 +22,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [post] /admin/draft-orders/{id}
  * operationId: PostDraftOrdersDraftOrder
- * summary: Update a Draft Order"
+ * summary: Update a Draft Order
  * description: "Updates a Draft Order."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/draft-orders/update-line-item.ts

@@ -15,7 +15,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [post] /draft-orders/{id}/line-items/{line_id}
  * operationId: "PostDraftOrdersDraftOrderLineItemsItem"
- * summary: "Update a Line Item for a Draft Order"
+ * summary: "Update a Line Item"
  * description: "Updates a Line Item for a Draft Order"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/gift-cards/get-gift-card.ts

@@ -3,7 +3,7 @@ import { defaultAdminGiftCardFields, defaultAdminGiftCardRelations } from "./"
 /**
  * @oas [get] /gift-cards/{id}
  * operationId: "GetGiftCardsGiftCard"
- * summary: "Retrieve a Gift Card"
+ * summary: "Get a Gift Card"
  * description: "Retrieves a Gift Card."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/invites/list-invites.ts

@@ -3,7 +3,7 @@ import InviteService from "../../../../services/invite"
 /**
  * @oas [get] /invites
  * operationId: "GetInvites"
- * summary: "Lists all Invites"
+ * summary: "Lists Invites"
  * description: "Lists all Invites"
  * x-authenticated: true
  * x-codeSamples:

packages/medusa/src/api/routes/admin/notes/delete-note.ts

@@ -4,7 +4,7 @@ import NoteService from "../../../../services/note"
 /**
  * @oas [delete] /notes/{id}
  * operationId: "DeleteNotesNote"
- * summary: "Deletes a Note"
+ * summary: "Delete a Note"
  * description: "Deletes a Note."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/notes/get-note.ts

@@ -3,7 +3,7 @@ import NoteService from "../../../../services/note"
 /**
  * @oas [get] /notes/{id}
  * operationId: "GetNotesNote"
- * summary: "Get Note"
+ * summary: "Get a Note"
  * description: "Retrieves a single note using its id"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/notes/update-note.ts

@@ -6,7 +6,7 @@ import { EntityManager } from "typeorm"
 /**
  * @oas [post] /notes/{id}
  * operationId: "PostNotesNote"
- * summary: "Updates a Note"
+ * summary: "Update a Note"
  * x-authenticated: true
  * description: "Updates a Note associated with some resource"
  * parameters:

packages/medusa/src/api/routes/admin/orders/archive-order.ts

@@ -4,7 +4,7 @@ import { EntityManager } from "typeorm"
 /**
  * @oas [post] /orders/{id}/archive
  * operationId: "PostOrdersOrderArchive"
- * summary: "Archive order"
+ * summary: "Archive Order"
  * description: "Archives the order with the given id."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/orders/cancel-claim.ts

@@ -7,7 +7,7 @@ import { MedusaError } from "medusa-core-utils"
 /**
  * @oas [post] /orders/{id}/claims/{claim_id}/cancel
  * operationId: "PostOrdersClaimCancel"
- * summary: "Cancels a Claim"
+ * summary: "Cancel a Claim"
  * description: "Cancels a Claim"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.ts

@@ -11,8 +11,8 @@ import { MedusaError } from "medusa-core-utils"
 /**
  * @oas [post] /orders/{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel
  * operationId: "PostOrdersClaimFulfillmentsCancel"
- * summary: "Cancels a fulfilmment related to a Claim"
- * description: "Registers a Fulfillment as canceled."
+ * summary: "Cancel Claim Fulfillment"
+ * description: "Registers a claim's fulfillment as canceled."
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Order which the Claim relates to.

packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-swap.ts

@@ -11,8 +11,8 @@ import { MedusaError } from "medusa-core-utils"
 /**
  * @oas [post] /orders/{id}/swaps/{swap_id}/fulfillments/{fulfillment_id}/cancel
  * operationId: "PostOrdersSwapFulfillmentsCancel"
- * summary: "Cancels a fulfilmment related to a Swap"
- * description: "Registers a Fulfillment as canceled."
+ * summary: "Cancel Swap's Fulfilmment"
+ * description: "Registers a Swap's Fulfillment as canceled."
  * x-authenticated: true
  * parameters:
  *   - (path) id=* {string} The ID of the Order which the Swap relates to.

packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts

@@ -7,7 +7,7 @@ import { MedusaError } from "medusa-core-utils"
 /**
  * @oas [post] /orders/{id}/fulfillments/{fulfillment_id}/cancel
  * operationId: "PostOrdersOrderFulfillmentsCancel"
- * summary: "Cancels a fulfilmment"
+ * summary: "Cancels a Fulfilmment"
  * description: "Registers a Fulfillment as canceled."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/orders/capture-payment.ts

@@ -6,7 +6,7 @@ import { EntityManager } from "typeorm"
 /**
  * @oas [post] /orders/{id}/capture
  * operationId: "PostOrdersOrderCapture"
- * summary: "Capture an Order"
+ * summary: "Capture Order's Payment"
  * description: "Captures all the Payments associated with an Order."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts

@@ -8,7 +8,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [post] /orders/{id}/claims/{claim_id}/fulfillments
  * operationId: "PostOrdersOrderClaimsClaimFulfillments"
- * summary: "Create a Claim Fulfillment"
+ * summary: "Create Claim Fulfillment"
  * description: "Creates a Fulfillment for a Claim."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts

@@ -8,7 +8,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [post] /orders/{id}/swaps/{swap_id}/fulfillments
  * operationId: "PostOrdersOrderSwapsSwapFulfillments"
- * summary: "Create a Swap Fulfillment"
+ * summary: "Create Swap Fulfillment"
  * description: "Creates a Fulfillment for a Swap."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/orders/get-order.ts

@@ -3,7 +3,7 @@ import { OrderService } from "../../../../services"
 /**
  * @oas [get] /orders/{id}
  * operationId: "GetOrdersOrder"
- * summary: "Retrieve an Order"
+ * summary: "Get an Order"
  * description: "Retrieves an Order"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/orders/process-swap-payment.ts

@@ -6,7 +6,7 @@ import { EntityManager } from "typeorm"
 /**
  * @oas [post] /orders/{id}/swaps/{swap_id}/process-payment
  * operationId: "PostOrdersOrderSwapsSwapProcessPayment"
- * summary: "Process a Swap difference"
+ * summary: "Process Swap Payment"
  * description: "When there are differences between the returned and shipped Products in a Swap, the difference must be processed. Either a Refund will be issued or a Payment will be captured."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/orders/update-order.ts

@@ -19,7 +19,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [post] /orders/{id}
  * operationId: "PostOrdersOrder"
- * summary: "Update an order"
+ * summary: "Update an Order"
  * description: "Updates and order"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/price-lists/add-prices-batch.ts

@@ -11,7 +11,7 @@ import { EntityManager } from "typeorm"
 /**
  * @oas [post] /price-lists/{id}/prices/batch
  * operationId: "PostPriceListsPriceListPricesBatch"
- * summary: "Batch update prices for a Price List"
+ * summary: "Update Prices"
  * description: "Batch update prices for a Price List"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/price-lists/create-price-list.ts

@@ -20,7 +20,7 @@ import { Type } from "class-transformer"
 /**
  * @oas [post] /price-lists
  * operationId: "PostPriceListsPriceList"
- * summary: "Creates a Price List"
+ * summary: "Create a Price List"
  * description: "Creates a Price List"
  * x-authenticated: true
  * requestBody:

packages/medusa/src/api/routes/admin/price-lists/delete-prices-batch.ts

@@ -7,7 +7,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [delete] /price-lists/{id}/prices/batch
  * operationId: "DeletePriceListsPriceListPricesBatch"
- * summary: "Batch delete prices that belong to a Price List"
+ * summary: "Delete Prices"
  * description: "Batch delete prices that belong to a Price List"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/price-lists/delete-product-prices.ts

@@ -4,7 +4,7 @@ import PriceListService from "../../../../services/price-list"
 /**
  * @oas [delete] /price-lists/{id}/products/{product_id}/prices
  * operationId: "DeletePriceListsPriceListProductsProductPrices"
- * summary: "Delete all the prices related to a specific product in a price list"
+ * summary: "Delete Product's Prices"
  * description: "Delete all the prices related to a specific product in a price list"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/price-lists/delete-variant-prices.ts

@@ -4,7 +4,7 @@ import PriceListService from "../../../../services/price-list"
 /**
  * @oas [delete] /price-lists/{id}/variants/{variant_id}/prices
  * operationId: "DeletePriceListsPriceListVariantsVariantPrices"
- * summary: "Delete all the prices related to a specific variant in a price list"
+ * summary: "Delete Variant's Prices"
  * description: "Delete all the prices related to a specific variant in a price list"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/price-lists/get-price-list.ts

@@ -6,7 +6,7 @@ import PriceListService from "../../../../services/price-list"
 /**
  * @oas [get] /price-lists/{id}
  * operationId: "GetPriceListsPriceList"
- * summary: "Retrieve a Price List"
+ * summary: "Get a Price List"
  * description: "Retrieves a Price List."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts

@@ -22,7 +22,7 @@ import { isDefined } from "../../../../utils"
 /**
  * @oas [get] /price-lists/{id}/products
  * operationId: "GetPriceListsPriceListProducts"
- * summary: "List Product in a Price List"
+ * summary: "List Products"
  * description: "Retrieves a list of Product that are part of a Price List"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/products/get-product.ts

@@ -3,7 +3,7 @@ import { PricingService, ProductService } from "../../../../services"
 /**
  * @oas [get] /products/{id}
  * operationId: "GetProductsProduct"
- * summary: "Retrieve a Product"
+ * summary: "Get a Product"
  * description: "Retrieves a Product."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/products/list-products.ts

@@ -9,7 +9,7 @@ import { Type } from "class-transformer"
 /**
  * @oas [get] /products
  * operationId: "GetProducts"
- * summary: "List Product"
+ * summary: "List Products"
  * description: "Retrieves a list of Product"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/products/list-tag-usage-count.ts

@@ -3,7 +3,7 @@ import { ProductService } from "../../../../services"
 /**
  * @oas [get] /products/tag-usage
  * operationId: "GetProductsTagUsage"
- * summary: "List Product Tags Usage Number"
+ * summary: "List Tags Usage Number"
  * description: "Retrieves a list of Product Tags with how many times each is used."
  * x-authenticated: true
  * x-codeSamples:

packages/medusa/src/api/routes/admin/products/list-variants.ts

@@ -11,7 +11,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [get] /products/{id}/variants
  * operationId: "GetProductsProductVariants"
- * summary: "List a Product's Product Variants"
+ * summary: "List a Product's Variants"
  * description: "Retrieves a list of the Product Variants associated with a Product."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/products/set-metadata.ts

@@ -7,7 +7,7 @@ import { EntityManager } from "typeorm"
 /**
  * @oas [post] /products/{id}/metadata
  * operationId: "PostProductsProductMetadata"
- * summary: "Set Product metadata"
+ * summary: "Set Product Metadata"
  * description: "Set metadata key/value pair for Product"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/products/update-option.ts

@@ -8,7 +8,7 @@ import { EntityManager } from "typeorm"
 /**
  * @oas [post] /products/{id}/options/{option_id}
  * operationId: "PostProductsProductOptionsOption"
- * summary: "Update a Product Option."
+ * summary: "Update a Product Option"
  * description: "Updates a Product Option"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/regions/get-fulfillment-options.ts

@@ -5,7 +5,7 @@ import RegionService from "../../../../services/region"
 /**
  * @oas [get] /regions/{id}/fulfillment-options
  * operationId: "GetRegionsRegionFulfillmentOptions"
- * summary: "List Fulfillment Options available in the Region"
+ * summary: "List Fulfillment Options"
  * description: "Gathers all the fulfillment options available to in the Region."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/regions/get-region.ts

@@ -5,7 +5,7 @@ import RegionService from "../../../../services/region"
 /**
  * @oas [get] /regions/{id}
  * operationId: "GetRegionsRegion"
- * summary: "Retrieve a Region"
+ * summary: "Get a Region"
  * description: "Retrieves a Region."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/regions/remove-country.ts

@@ -6,7 +6,7 @@ import RegionService from "../../../../services/region"
 /**
  * @oas [delete] /regions/{id}/countries/{country_code}
  * operationId: "PostRegionsRegionCountriesCountry"
- * summary: "Remove Country"
+ * summary: "Delete Country"
  * x-authenticated: true
  * description: "Removes a Country from the list of Countries in a Region"
  * parameters:

packages/medusa/src/api/routes/admin/regions/remove-fulfillment-provider.ts

@@ -6,7 +6,7 @@ import RegionService from "../../../../services/region"
 /**
  * @oas [delete] /regions/{id}/fulfillment-providers/{provider_id}
  * operationId: "PostRegionsRegionFulfillmentProvidersProvider"
- * summary: "Remove Fulfillment Provider"
+ * summary: "Del. Fulfillment Provider"
  * description: "Removes a Fulfillment Provider."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/regions/remove-payment-provider.ts

@@ -6,7 +6,7 @@ import RegionService from "../../../../services/region"
 /**
  * @oas [delete] /regions/{id}/payment-providers/{provider_id}
  * operationId: "PostRegionsRegionPaymentProvidersProvider"
- * summary: "Remove Payment Provider"
+ * summary: "Delete Payment Provider"
  * description: "Removes a Payment Provider."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/return-reasons/delete-reason.ts

@@ -4,7 +4,7 @@ import { ReturnReasonService } from "../../../../services"
 /**
  * @oas [delete] /return-reasons/{id}
  * operationId: "DeleteReturnReason"
- * summary: "Delete a return reason"
+ * summary: "Delete a Return Reason"
  * description: "Deletes a return reason."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/return-reasons/get-reason.ts

@@ -8,7 +8,7 @@ import { ReturnReasonService } from "../../../../services"
 /**
  * @oas [get] /return-reasons/{id}
  * operationId: "GetReturnReasonsReason"
- * summary: "Retrieve a Return Reason"
+ * summary: "Get a Return Reason"
  * description: "Retrieves a Return Reason."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/sales-channels/add-product-batch.ts

@@ -9,7 +9,7 @@ import { Type } from "class-transformer"
 /**
  * @oas [post] /sales-channels/{id}/products/batch
  * operationId: "PostSalesChannelsChannelProductsBatch"
- * summary: "Assign a batch of product to a sales channel"
+ * summary: "Add Products"
  * description: "Assign a batch of product to a sales channel."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/sales-channels/delete-products-batch.ts

@@ -9,7 +9,7 @@ import { Type } from "class-transformer"
 /**
  * @oas [delete] /sales-channels/{id}/products/batch
  * operationId: "DeleteSalesChannelsChannelProductsBatch"
- * summary: "Remove a list of products from a sales channel"
+ * summary: "Delete Products"
  * description: "Remove a list of products from a sales channel."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/sales-channels/delete-sales-channel.ts

@@ -6,7 +6,7 @@ import { SalesChannelService } from "../../../../services/"
 /**
  * @oas [delete] /sales-channels/{id}
  * operationId: "DeleteSalesChannelsSalesChannel"
- * summary: "Delete a sales channel"
+ * summary: "Delete a Sales Channel"
  * description: "Deletes the sales channel."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/sales-channels/get-sales-channel.ts

@@ -5,7 +5,7 @@ import { SalesChannelService } from "../../../../services"
 /**
  * @oas [get] /sales-channels/{id}
  * operationId: "GetSalesChannelsSalesChannel"
- * summary: "Retrieve a sales channel"
+ * summary: "Get a Sales Channel"
  * description: "Retrieves the sales channel."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/sales-channels/list-sales-channels.ts

@@ -12,7 +12,7 @@ import { removeUndefinedProperties } from "../../../../utils"
 /**
  * @oas [get] /sales-channels
  * operationId: "GetSalesChannels"
- * summary: "List sales channels"
+ * summary: "List Sales Channels"
  * description: "Retrieves a list of sales channels"
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/shipping-options/get-shipping-option.ts

@@ -1,7 +1,7 @@
 /**
  * @oas [get] /shipping-options/{id}
  * operationId: "GetShippingOptionsOption"
- * summary: "Retrieve a Shipping Option"
+ * summary: "Get a Shipping Option"
  * description: "Retrieves a Shipping Option."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/shipping-profiles/get-shipping-profile.ts

@@ -8,7 +8,7 @@ import { ShippingProfileService } from "../../../../services"
 /**
  * @oas [get] /shipping-profiles/{id}
  * operationId: "GetShippingProfilesProfile"
- * summary: "Retrieve a Shipping Profile"
+ * summary: "Get a Shipping Profile"
  * description: "Retrieves a Shipping Profile."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/shipping-profiles/update-shipping-profile.ts

@@ -7,7 +7,7 @@ import { EntityManager } from "typeorm"
 /**
  * @oas [post] /shipping-profiles/{id}
  * operationId: "PostShippingProfilesProfile"
- * summary: "Update a Shipping Profiles"
+ * summary: "Update a Shipping Profile"
  * description: "Updates a Shipping Profile"
  * parameters:
  *   - (path) id=* {string} The ID of the Shipping Profile.

packages/medusa/src/api/routes/admin/store/get-store.ts

@@ -10,7 +10,7 @@ import { FlagRouter } from "../../../../utils/flag-router"
 /**
  * @oas [get] /store
  * operationId: "GetStore"
- * summary: "Retrieve Store details."
+ * summary: "Get Store details"
  * description: "Retrieves the Store details"
  * x-authenticated: true
  * x-codeSamples:

packages/medusa/src/api/routes/admin/store/list-payment-providers.ts

@@ -2,7 +2,7 @@ import { PaymentProviderService } from "../../../../services"
 /**
  * @oas [get] /store/payment-providers
  * operationId: "GetStorePaymentProviders"
- * summary: "Retrieve configured Payment Providers"
+ * summary: "List Payment Providers"
  * description: "Retrieves the configured Payment Providers"
  * x-authenticated: true
  * x-codeSamples:

packages/medusa/src/api/routes/admin/store/list-tax-providers.ts

@@ -3,7 +3,7 @@ import { TaxProviderService } from "../../../../services"
 /**
  * @oas [get] /store/tax-providers
  * operationId: "GetStoreTaxProviders"
- * summary: "Retrieve configured Tax Providers"
+ * summary: "List Tax Providers"
  * description: "Retrieves the configured Tax Providers"
  * x-authenticated: true
  * x-codeSamples:

packages/medusa/src/api/routes/admin/store/remove-currency.ts

@@ -4,7 +4,7 @@ import { EntityManager } from "typeorm"
 /**
  * @oas [delete] /store/currencies/{code}
  * operationId: "DeleteStoreCurrenciesCode"
- * summary: "Remove a Currency Code"
+ * summary: "Delete a Currency Code"
  * description: "Removes a Currency Code from the available currencies."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/store/update-store.ts

@@ -7,7 +7,7 @@ import { EntityManager } from "typeorm"
 /**
  * @oas [post] /store
  * operationId: "PostStore"
- * summary: "Update Store details."
+ * summary: "Update Store Details"
  * description: "Updates the Store details"
  * x-authenticated: true
  * requestBody:

packages/medusa/src/api/routes/admin/swaps/get-swap.ts

@@ -5,7 +5,7 @@ import { SwapService } from "../../../../services"
 /**
  * @oas [get] /swaps/{id}
  * operationId: "GetSwapsSwap"
- * summary: "Retrieve a Swap"
+ * summary: "Get a Swap"
  * description: "Retrieves a Swap."
  * x-authenticated: true
  * parameters:

packages/medusa/src/api/routes/admin/tax-rates/add-to-product-types.ts

@@ -9,7 +9,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [post] /tax-rates/{id}/product-types/batch
  * operationId: "PostTaxRatesTaxRateProductTypes"
- * summary: "Add Tax Rate to Product Types"
+ * summary: "Add to Product Types"
  * description: "Associates a Tax Rate with a list of Product Types"
  * parameters:
  *   - (path) id=* {string} ID of the tax rate.

packages/medusa/src/api/routes/admin/tax-rates/add-to-products.ts

@@ -9,7 +9,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [post] /tax-rates/{id}/products/batch
  * operationId: "PostTaxRatesTaxRateProducts"
- * summary: "Add Tax Rate to Products"
+ * summary: "Add to Products"
  * description: "Associates a Tax Rate with a list of Products"
  * parameters:
  *   - (path) id=* {string} ID of the tax rate.

packages/medusa/src/api/routes/admin/tax-rates/add-to-shipping-options.ts

@@ -9,7 +9,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [post] /tax-rates/{id}/shipping-options/batch
  * operationId: "PostTaxRatesTaxRateShippingOptions"
- * summary: "Add Tax Rate to Product Types"
+ * summary: "Add to Shipping Options"
  * description: "Associates a Tax Rate with a list of Shipping Options"
  * parameters:
  *   - (path) id=* {string} ID of the tax rate.

packages/medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts

@@ -8,7 +8,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [get] /tax-rates/{id}
  * operationId: "GetTaxRatesTaxRate"
- * summary: "Get Tax Rate"
+ * summary: "Get a Tax Rate"
  * description: "Retrieves a TaxRate"
  * parameters:
  *   - (path) id=* {string} ID of the tax rate.

packages/medusa/src/api/routes/admin/tax-rates/remove-from-product-types.ts

@@ -9,7 +9,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [delete] /tax-rates/{id}/product-types/batch
  * operationId: "DeleteTaxRatesTaxRateProductTypes"
- * summary: "Remove Tax Rate from Product Types"
+ * summary: "Delete from Product Types"
  * description: "Removes a Tax Rate from a list of Product Types"
  * parameters:
  *   - (path) id=* {string} ID of the tax rate.

packages/medusa/src/api/routes/admin/tax-rates/remove-from-products.ts

@@ -9,7 +9,7 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [delete] /tax-rates/{id}/products/batch
  * operationId: "DeleteTaxRatesTaxRateProducts"
- * summary: "Removes Tax Rate from Products"
+ * summary: "Delete from Products"
  * description: "Removes a Tax Rate from a list of Products"
  * parameters:
  *   - (path) id=* {string} ID of the tax rate.

packages/medusa/src/api/routes/admin/tax-rates/remove-from-shipping-options.ts

@@ -9,8 +9,8 @@ import { validator } from "../../../../utils/validator"
 /**
  * @oas [delete] /tax-rates/{id}/shipping-options/batch
  * operationId: "DeleteTaxRatesTaxRateShippingOptions"
- * summary: "Removes a Tax Rate from Product Types"
- * description: "Removes a Tax Rate from a list of Product Types"
+ * summary: "Del. for Shipping Options"
+ * description: "Removes a Tax Rate from a list of Shipping Options"
  * parameters:
  *   - (path) id=* {string} ID of the tax rate.
  *   - in: query

packages/medusa/src/api/routes/admin/uploads/create-upload.ts

@@ -3,7 +3,7 @@ import fs from "fs"
 /**
  * @oas [post] /uploads
  * operationId: "PostUploads"
- * summary: "Uploads a file"
+ * summary: "Upload a file"
  * description: "Uploads a file to the specific fileservice that is installed in Medusa."
  * x-authenticated: true
  * requestBody:

packages/medusa/src/api/routes/admin/uploads/delete-upload.ts

@@ -3,7 +3,7 @@ import { IsString } from "class-validator"
 /**
  * [delete] /uploads
  * operationId: "AdminDeleteUploads"
- * summary: "Removes an uploaded file"
+ * summary: "Delete an Uploaded File"
  * description: "Removes an uploaded file using the installed fileservice"
  * x-authenticated: true
  * requestBody:

packages/medusa/src/api/routes/admin/uploads/get-download-url.ts

@@ -4,7 +4,7 @@ import { IsString } from "class-validator"
 /**
  * [post] /uploads/download-url
  * operationId: "PostUploadsDownloadUrl"
- * summary: "Creates a presigned download url for a file"
+ * summary: "Get a File's Download URL"
  * description: "Creates a presigned download url for a file"
  * x-authenticated: true
  * requestBody:

packages/medusa/src/api/routes/admin/users/get-user.ts

@@ -3,7 +3,7 @@ import UserService from "../../../../services/user"
 /**
  * @oas [get] /users/{id}
  * operationId: "GetUsersUser"
- * summary: "Retrieve a User"
+ * summary: "Get a User"
  * description: "Retrieves a User."
  * x-authenticated: true
  * parameters: