diff --git a/docs/content/contribution-guidelines.md b/docs/content/contribution-guidelines.md index 421b4bd88e..7c27e2b432 100644 --- a/docs/content/contribution-guidelines.md +++ b/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 diff --git a/packages/medusa/src/api/routes/admin/apps/authorize-app.ts b/packages/medusa/src/api/routes/admin/apps/authorize-app.ts index 65b126b150..53e2985db2 100644 --- a/packages/medusa/src/api/routes/admin/apps/authorize-app.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/apps/list.ts b/packages/medusa/src/api/routes/admin/apps/list.ts index 69e7ea67fe..c587e105d8 100644 --- a/packages/medusa/src/api/routes/admin/apps/list.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/auth/create-session.ts b/packages/medusa/src/api/routes/admin/auth/create-session.ts index e0339c653a..a349232f1a 100644 --- a/packages/medusa/src/api/routes/admin/auth/create-session.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/auth/delete-session.ts b/packages/medusa/src/api/routes/admin/auth/delete-session.ts index 3a87ee4196..b7319bb94e 100644 --- a/packages/medusa/src/api/routes/admin/auth/delete-session.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/auth/get-session.ts b/packages/medusa/src/api/routes/admin/auth/get-session.ts index 1e36a9e616..5dcf8170e2 100644 --- a/packages/medusa/src/api/routes/admin/auth/get-session.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/batch/cancel-batch-job.ts b/packages/medusa/src/api/routes/admin/batch/cancel-batch-job.ts index 21dd02012d..9095921825 100644 --- a/packages/medusa/src/api/routes/admin/batch/cancel-batch-job.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/batch/confirm-batch-job.ts b/packages/medusa/src/api/routes/admin/batch/confirm-batch-job.ts index 3cafd8ff6e..4f4b8c5b63 100644 --- a/packages/medusa/src/api/routes/admin/batch/confirm-batch-job.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/batch/get-batch-job.ts b/packages/medusa/src/api/routes/admin/batch/get-batch-job.ts index 5884d210e4..e3061c2a38 100644 --- a/packages/medusa/src/api/routes/admin/batch/get-batch-job.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/collections/add-products.ts b/packages/medusa/src/api/routes/admin/collections/add-products.ts index 02a3d2d773..1223d58186 100644 --- a/packages/medusa/src/api/routes/admin/collections/add-products.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/collections/create-collection.ts b/packages/medusa/src/api/routes/admin/collections/create-collection.ts index d232e1edaf..a75d31124c 100644 --- a/packages/medusa/src/api/routes/admin/collections/create-collection.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/collections/delete-collection.ts b/packages/medusa/src/api/routes/admin/collections/delete-collection.ts index 963d6212dc..59ea266dbc 100644 --- a/packages/medusa/src/api/routes/admin/collections/delete-collection.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/collections/get-collection.ts b/packages/medusa/src/api/routes/admin/collections/get-collection.ts index 96c404d449..7ae27efe0a 100644 --- a/packages/medusa/src/api/routes/admin/collections/get-collection.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/collections/list-collections.ts b/packages/medusa/src/api/routes/admin/collections/list-collections.ts index 82e9ce6afc..fd81d9d6f3 100644 --- a/packages/medusa/src/api/routes/admin/collections/list-collections.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/collections/remove-products.ts b/packages/medusa/src/api/routes/admin/collections/remove-products.ts index a1e95e0563..973d2d1993 100644 --- a/packages/medusa/src/api/routes/admin/collections/remove-products.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/collections/update-collection.ts b/packages/medusa/src/api/routes/admin/collections/update-collection.ts index dd90c1323f..944c012b96 100644 --- a/packages/medusa/src/api/routes/admin/collections/update-collection.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/customer-groups/add-customers-batch.ts b/packages/medusa/src/api/routes/admin/customer-groups/add-customers-batch.ts index 16df1ea384..b91bb0e884 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/add-customers-batch.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts index 0b3fb044c5..c6fb4d4d5d 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/customer-groups/delete-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/delete-customer-group.ts index 8d1264bbf7..9d7545999b 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/delete-customer-group.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/customer-groups/delete-customers-batch.ts b/packages/medusa/src/api/routes/admin/customer-groups/delete-customers-batch.ts index ff6fe76a25..96cc01ef6b 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/delete-customers-batch.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group.ts index dc31c59c23..6c3d902f0c 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts b/packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts index 84b50f76e1..892a631175 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts index 6b39ea2355..e526b1ccb9 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/customers/get-customer.ts b/packages/medusa/src/api/routes/admin/customers/get-customer.ts index 85c997eb6a..c1432b7255 100644 --- a/packages/medusa/src/api/routes/admin/customers/get-customer.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/discounts/add-region.ts b/packages/medusa/src/api/routes/admin/discounts/add-region.ts index 957061cb7c..5ebf82b21b 100644 --- a/packages/medusa/src/api/routes/admin/discounts/add-region.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/discounts/create-condition.ts b/packages/medusa/src/api/routes/admin/discounts/create-condition.ts index 5018ed4fe5..a331a932e3 100644 --- a/packages/medusa/src/api/routes/admin/discounts/create-condition.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/discounts/create-dynamic-code.ts b/packages/medusa/src/api/routes/admin/discounts/create-dynamic-code.ts index 5a96802261..429f859b7f 100644 --- a/packages/medusa/src/api/routes/admin/discounts/create-dynamic-code.ts +++ b/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." diff --git a/packages/medusa/src/api/routes/admin/discounts/delete-condition.ts b/packages/medusa/src/api/routes/admin/discounts/delete-condition.ts index 4cfd133f7b..81802a779a 100644 --- a/packages/medusa/src/api/routes/admin/discounts/delete-condition.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/discounts/delete-dynamic-code.ts b/packages/medusa/src/api/routes/admin/discounts/delete-dynamic-code.ts index c2308d758c..37a65527c4 100644 --- a/packages/medusa/src/api/routes/admin/discounts/delete-dynamic-code.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/discounts/get-condition.ts b/packages/medusa/src/api/routes/admin/discounts/get-condition.ts index aed2572d74..2d5414c7f1 100644 --- a/packages/medusa/src/api/routes/admin/discounts/get-condition.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/discounts/get-discount-by-code.ts b/packages/medusa/src/api/routes/admin/discounts/get-discount-by-code.ts index 3abfd3e3a5..389e7e23e0 100644 --- a/packages/medusa/src/api/routes/admin/discounts/get-discount-by-code.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/discounts/get-discount.ts b/packages/medusa/src/api/routes/admin/discounts/get-discount.ts index ea9061449f..f7b45f83ff 100644 --- a/packages/medusa/src/api/routes/admin/discounts/get-discount.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/discounts/remove-region.ts b/packages/medusa/src/api/routes/admin/discounts/remove-region.ts index 445244ec79..0db446ae12 100644 --- a/packages/medusa/src/api/routes/admin/discounts/remove-region.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/discounts/update-condition.ts b/packages/medusa/src/api/routes/admin/discounts/update-condition.ts index bcc2f181fb..7687826e33 100644 --- a/packages/medusa/src/api/routes/admin/discounts/update-condition.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/draft-orders/create-line-item.ts b/packages/medusa/src/api/routes/admin/draft-orders/create-line-item.ts index c25ad0bbac..48d69bdabd 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/create-line-item.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/draft-orders/get-draft-order.ts b/packages/medusa/src/api/routes/admin/draft-orders/get-draft-order.ts index ee80b5fa79..863d739582 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/get-draft-order.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/draft-orders/register-payment.ts b/packages/medusa/src/api/routes/admin/draft-orders/register-payment.ts index 3f1a425c45..fb8dce918b 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/register-payment.ts +++ b/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 diff --git a/packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts b/packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts index 721c815c0c..d1596e37d7 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/draft-orders/update-line-item.ts b/packages/medusa/src/api/routes/admin/draft-orders/update-line-item.ts index 6a51c3a9d0..d40c36a229 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/update-line-item.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/gift-cards/get-gift-card.ts b/packages/medusa/src/api/routes/admin/gift-cards/get-gift-card.ts index c1366fd520..bff67c154d 100644 --- a/packages/medusa/src/api/routes/admin/gift-cards/get-gift-card.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/invites/list-invites.ts b/packages/medusa/src/api/routes/admin/invites/list-invites.ts index a859fa3923..e7b857ff02 100644 --- a/packages/medusa/src/api/routes/admin/invites/list-invites.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/notes/delete-note.ts b/packages/medusa/src/api/routes/admin/notes/delete-note.ts index f427060d3b..520df281e5 100644 --- a/packages/medusa/src/api/routes/admin/notes/delete-note.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/notes/get-note.ts b/packages/medusa/src/api/routes/admin/notes/get-note.ts index 4df52b5f9f..77014c036a 100644 --- a/packages/medusa/src/api/routes/admin/notes/get-note.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/notes/update-note.ts b/packages/medusa/src/api/routes/admin/notes/update-note.ts index 12befc7937..f2bf264560 100644 --- a/packages/medusa/src/api/routes/admin/notes/update-note.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/orders/archive-order.ts b/packages/medusa/src/api/routes/admin/orders/archive-order.ts index 7070647323..f42d674fab 100644 --- a/packages/medusa/src/api/routes/admin/orders/archive-order.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-claim.ts b/packages/medusa/src/api/routes/admin/orders/cancel-claim.ts index 0c34e6ee8a..6e1e18cc23 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-claim.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.ts b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.ts index bd465d5fee..649eb27236 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.ts +++ b/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. diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-swap.ts b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-swap.ts index 18d723943e..135f703631 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-swap.ts +++ b/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. diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts index 5f34a01f21..cb6f365e66 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/orders/capture-payment.ts b/packages/medusa/src/api/routes/admin/orders/capture-payment.ts index 8678ce866d..3494f87a5a 100644 --- a/packages/medusa/src/api/routes/admin/orders/capture-payment.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts b/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts index 6995187cdd..5005f24d62 100644 --- a/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts b/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts index 245e408d97..c56f1348a7 100644 --- a/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/orders/get-order.ts b/packages/medusa/src/api/routes/admin/orders/get-order.ts index 1444b6f872..cb51c74847 100644 --- a/packages/medusa/src/api/routes/admin/orders/get-order.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/orders/process-swap-payment.ts b/packages/medusa/src/api/routes/admin/orders/process-swap-payment.ts index aa383ef42a..704bea221e 100644 --- a/packages/medusa/src/api/routes/admin/orders/process-swap-payment.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/orders/update-order.ts b/packages/medusa/src/api/routes/admin/orders/update-order.ts index ff013dc7e1..9d3b5e8511 100644 --- a/packages/medusa/src/api/routes/admin/orders/update-order.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/price-lists/add-prices-batch.ts b/packages/medusa/src/api/routes/admin/price-lists/add-prices-batch.ts index facfd03ade..3c2cf18cf5 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/add-prices-batch.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/price-lists/create-price-list.ts b/packages/medusa/src/api/routes/admin/price-lists/create-price-list.ts index 94525eda00..05ac6fee66 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/create-price-list.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/price-lists/delete-prices-batch.ts b/packages/medusa/src/api/routes/admin/price-lists/delete-prices-batch.ts index 084bb1cefb..8dbe6c1235 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/delete-prices-batch.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/price-lists/delete-product-prices.ts b/packages/medusa/src/api/routes/admin/price-lists/delete-product-prices.ts index f42df8dca6..52b59b5363 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/delete-product-prices.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/price-lists/delete-variant-prices.ts b/packages/medusa/src/api/routes/admin/price-lists/delete-variant-prices.ts index 0c7163533f..6ffee336fc 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/delete-variant-prices.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/price-lists/get-price-list.ts b/packages/medusa/src/api/routes/admin/price-lists/get-price-list.ts index cece6f6a3b..e5b5103027 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/get-price-list.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts b/packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts index c00598ad77..6b7d3df341 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/products/get-product.ts b/packages/medusa/src/api/routes/admin/products/get-product.ts index f4ac30e6cb..7ec3d735b5 100644 --- a/packages/medusa/src/api/routes/admin/products/get-product.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/products/list-products.ts b/packages/medusa/src/api/routes/admin/products/list-products.ts index c71e6a1e2b..e2e1e72429 100644 --- a/packages/medusa/src/api/routes/admin/products/list-products.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/products/list-tag-usage-count.ts b/packages/medusa/src/api/routes/admin/products/list-tag-usage-count.ts index 3c70f8a212..a640a5246b 100644 --- a/packages/medusa/src/api/routes/admin/products/list-tag-usage-count.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/products/list-variants.ts b/packages/medusa/src/api/routes/admin/products/list-variants.ts index a3a22ed26b..768748c7be 100644 --- a/packages/medusa/src/api/routes/admin/products/list-variants.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/products/set-metadata.ts b/packages/medusa/src/api/routes/admin/products/set-metadata.ts index b3eaac5fb0..5beede034b 100644 --- a/packages/medusa/src/api/routes/admin/products/set-metadata.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/products/update-option.ts b/packages/medusa/src/api/routes/admin/products/update-option.ts index b9a293f6b0..db130c0b75 100644 --- a/packages/medusa/src/api/routes/admin/products/update-option.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/regions/get-fulfillment-options.ts b/packages/medusa/src/api/routes/admin/regions/get-fulfillment-options.ts index 0061941f06..3bab93a575 100644 --- a/packages/medusa/src/api/routes/admin/regions/get-fulfillment-options.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/regions/get-region.ts b/packages/medusa/src/api/routes/admin/regions/get-region.ts index e52aa5234c..3a7bf72f6f 100644 --- a/packages/medusa/src/api/routes/admin/regions/get-region.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/regions/remove-country.ts b/packages/medusa/src/api/routes/admin/regions/remove-country.ts index 820fb3df99..8ad1305115 100644 --- a/packages/medusa/src/api/routes/admin/regions/remove-country.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/regions/remove-fulfillment-provider.ts b/packages/medusa/src/api/routes/admin/regions/remove-fulfillment-provider.ts index 458c7928a3..bdafbb2480 100644 --- a/packages/medusa/src/api/routes/admin/regions/remove-fulfillment-provider.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/regions/remove-payment-provider.ts b/packages/medusa/src/api/routes/admin/regions/remove-payment-provider.ts index 04841566a6..b7bc047149 100644 --- a/packages/medusa/src/api/routes/admin/regions/remove-payment-provider.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/return-reasons/delete-reason.ts b/packages/medusa/src/api/routes/admin/return-reasons/delete-reason.ts index c27b7677f4..7186cf5c61 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/delete-reason.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/return-reasons/get-reason.ts b/packages/medusa/src/api/routes/admin/return-reasons/get-reason.ts index 581ca1cbc0..6ca80f9b05 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/get-reason.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/sales-channels/add-product-batch.ts b/packages/medusa/src/api/routes/admin/sales-channels/add-product-batch.ts index 98a6fea8c4..b124bb65c5 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/add-product-batch.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/sales-channels/delete-products-batch.ts b/packages/medusa/src/api/routes/admin/sales-channels/delete-products-batch.ts index d7983c2710..e74a22c295 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/delete-products-batch.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/sales-channels/delete-sales-channel.ts b/packages/medusa/src/api/routes/admin/sales-channels/delete-sales-channel.ts index c11aed6442..ae5e1944fd 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/delete-sales-channel.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/sales-channels/get-sales-channel.ts b/packages/medusa/src/api/routes/admin/sales-channels/get-sales-channel.ts index d5511740e9..cc32746c03 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/get-sales-channel.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/sales-channels/list-sales-channels.ts b/packages/medusa/src/api/routes/admin/sales-channels/list-sales-channels.ts index f1aa54f16f..3fac708c33 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/list-sales-channels.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/shipping-options/get-shipping-option.ts b/packages/medusa/src/api/routes/admin/shipping-options/get-shipping-option.ts index 6716f38987..92f78f2af3 100644 --- a/packages/medusa/src/api/routes/admin/shipping-options/get-shipping-option.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/shipping-profiles/get-shipping-profile.ts b/packages/medusa/src/api/routes/admin/shipping-profiles/get-shipping-profile.ts index 2220695c10..078da08f4c 100644 --- a/packages/medusa/src/api/routes/admin/shipping-profiles/get-shipping-profile.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/shipping-profiles/update-shipping-profile.ts b/packages/medusa/src/api/routes/admin/shipping-profiles/update-shipping-profile.ts index 5410fad46b..1832a5a0bc 100644 --- a/packages/medusa/src/api/routes/admin/shipping-profiles/update-shipping-profile.ts +++ b/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. diff --git a/packages/medusa/src/api/routes/admin/store/get-store.ts b/packages/medusa/src/api/routes/admin/store/get-store.ts index c448b1d84d..b8139571fa 100644 --- a/packages/medusa/src/api/routes/admin/store/get-store.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/store/list-payment-providers.ts b/packages/medusa/src/api/routes/admin/store/list-payment-providers.ts index 51a036848b..145b10c80c 100644 --- a/packages/medusa/src/api/routes/admin/store/list-payment-providers.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/store/list-tax-providers.ts b/packages/medusa/src/api/routes/admin/store/list-tax-providers.ts index 77223ad10b..42feda2a08 100644 --- a/packages/medusa/src/api/routes/admin/store/list-tax-providers.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/store/remove-currency.ts b/packages/medusa/src/api/routes/admin/store/remove-currency.ts index 3e0aa55763..06c31968f5 100644 --- a/packages/medusa/src/api/routes/admin/store/remove-currency.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/store/update-store.ts b/packages/medusa/src/api/routes/admin/store/update-store.ts index 87b975c2d3..68a98b2273 100644 --- a/packages/medusa/src/api/routes/admin/store/update-store.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/swaps/get-swap.ts b/packages/medusa/src/api/routes/admin/swaps/get-swap.ts index f07f007ff5..5823fe8f58 100644 --- a/packages/medusa/src/api/routes/admin/swaps/get-swap.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/tax-rates/add-to-product-types.ts b/packages/medusa/src/api/routes/admin/tax-rates/add-to-product-types.ts index 6679550469..5d81d6e8fd 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/add-to-product-types.ts +++ b/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. diff --git a/packages/medusa/src/api/routes/admin/tax-rates/add-to-products.ts b/packages/medusa/src/api/routes/admin/tax-rates/add-to-products.ts index c8b7a0016a..33efd0f5be 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/add-to-products.ts +++ b/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. diff --git a/packages/medusa/src/api/routes/admin/tax-rates/add-to-shipping-options.ts b/packages/medusa/src/api/routes/admin/tax-rates/add-to-shipping-options.ts index fac7d76315..5a3b008553 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/add-to-shipping-options.ts +++ b/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. diff --git a/packages/medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts b/packages/medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts index 747220a3c4..f7aa817008 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts +++ b/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. diff --git a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-product-types.ts b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-product-types.ts index e146d3ff46..9d88eca0f9 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-product-types.ts +++ b/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. diff --git a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-products.ts b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-products.ts index 430b80db5f..44b35ec1ed 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-products.ts +++ b/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. diff --git a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-shipping-options.ts b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-shipping-options.ts index 0e8845e4c8..a63edbb3d2 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-shipping-options.ts +++ b/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 diff --git a/packages/medusa/src/api/routes/admin/uploads/create-upload.ts b/packages/medusa/src/api/routes/admin/uploads/create-upload.ts index 7e93d532db..ac3f2574bd 100644 --- a/packages/medusa/src/api/routes/admin/uploads/create-upload.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/uploads/delete-upload.ts b/packages/medusa/src/api/routes/admin/uploads/delete-upload.ts index b5551fdedc..a549d18497 100644 --- a/packages/medusa/src/api/routes/admin/uploads/delete-upload.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/uploads/get-download-url.ts b/packages/medusa/src/api/routes/admin/uploads/get-download-url.ts index 16298e0975..f4c73672ce 100644 --- a/packages/medusa/src/api/routes/admin/uploads/get-download-url.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/users/get-user.ts b/packages/medusa/src/api/routes/admin/users/get-user.ts index b14b662fda..098c1b5a5b 100644 --- a/packages/medusa/src/api/routes/admin/users/get-user.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/users/list-users.ts b/packages/medusa/src/api/routes/admin/users/list-users.ts index 80c653fffa..4e1946c82f 100644 --- a/packages/medusa/src/api/routes/admin/users/list-users.ts +++ b/packages/medusa/src/api/routes/admin/users/list-users.ts @@ -3,7 +3,7 @@ import UserService from "../../../../services/user" /** * @oas [get] /users * operationId: "GetUsers" - * summary: "Retrieve all users" + * summary: "List Users" * description: "Retrieves all users." * x-authenticated: true * x-codeSamples: diff --git a/packages/medusa/src/api/routes/admin/users/reset-password-token.ts b/packages/medusa/src/api/routes/admin/users/reset-password-token.ts index 807a188234..01f453547c 100644 --- a/packages/medusa/src/api/routes/admin/users/reset-password-token.ts +++ b/packages/medusa/src/api/routes/admin/users/reset-password-token.ts @@ -6,7 +6,7 @@ import { EntityManager } from "typeorm" /** * @oas [post] /users/password-token * operationId: "PostUsersUserPasswordToken" - * summary: "Generate a password token for a User." + * summary: "Request Password Reset" * description: "Generates a password token for a User with a given email." * x-authenticated: true * requestBody: diff --git a/packages/medusa/src/api/routes/admin/users/reset-password.ts b/packages/medusa/src/api/routes/admin/users/reset-password.ts index f7769bcb5b..cc104d71a1 100644 --- a/packages/medusa/src/api/routes/admin/users/reset-password.ts +++ b/packages/medusa/src/api/routes/admin/users/reset-password.ts @@ -11,7 +11,7 @@ import { EntityManager } from "typeorm" /** * @oas [post] /users/reset-password * operationId: "PostUsersUserPassword" - * summary: "Set the password for a User." + * summary: "Reset Password" * description: "Sets the password for a User given the correct token." * x-authenticated: true * requestBody: diff --git a/packages/medusa/src/api/routes/admin/variants/list-variants.ts b/packages/medusa/src/api/routes/admin/variants/list-variants.ts index 9b996dfb3b..dcbd18d98b 100644 --- a/packages/medusa/src/api/routes/admin/variants/list-variants.ts +++ b/packages/medusa/src/api/routes/admin/variants/list-variants.ts @@ -11,7 +11,7 @@ import { validator } from "../../../../utils/validator" /** * @oas [get] /variants * operationId: "GetVariants" - * summary: "List Product Variants." + * summary: "List Product Variants" * description: "Retrieves a list of Product Variants" * x-authenticated: true * parameters: diff --git a/packages/medusa/src/api/routes/store/auth/create-session.ts b/packages/medusa/src/api/routes/store/auth/create-session.ts index f2037a988c..10360e409e 100644 --- a/packages/medusa/src/api/routes/store/auth/create-session.ts +++ b/packages/medusa/src/api/routes/store/auth/create-session.ts @@ -8,7 +8,7 @@ import { EntityManager } from "typeorm" /** * @oas [post] /auth * operationId: "PostAuth" - * summary: "Authenticate Customer" + * summary: "Customer Login" * description: "Logs a Customer in and authorizes them to view their details. Successful authentication will set a session cookie in the Customer's browser." * parameters: * - (body) email=* {string} The Customer's email. diff --git a/packages/medusa/src/api/routes/store/auth/delete-session.ts b/packages/medusa/src/api/routes/store/auth/delete-session.ts index 91be8254ef..b9851dbb46 100644 --- a/packages/medusa/src/api/routes/store/auth/delete-session.ts +++ b/packages/medusa/src/api/routes/store/auth/delete-session.ts @@ -1,7 +1,7 @@ /** * @oas [delete] /auth * operationId: "DeleteAuth" - * summary: "Log out" + * summary: "Customer Log out" * description: "Destroys a Customer's authenticated session." * x-authenticated: true * x-codeSamples: diff --git a/packages/medusa/src/api/routes/store/auth/exists.ts b/packages/medusa/src/api/routes/store/auth/exists.ts index 0dbdc1a92c..5d1321f45c 100644 --- a/packages/medusa/src/api/routes/store/auth/exists.ts +++ b/packages/medusa/src/api/routes/store/auth/exists.ts @@ -2,7 +2,7 @@ import CustomerService from "../../../../services/customer" /** * @oas [get] /auth/{email} * operationId: "GetAuthEmail" - * summary: "Check if email has account" + * summary: "Check if email exists" * description: "Checks if a Customer with the given email has signed up." * parameters: * - in: path diff --git a/packages/medusa/src/api/routes/store/auth/get-session.ts b/packages/medusa/src/api/routes/store/auth/get-session.ts index e37b4ec491..d0ebd602d2 100644 --- a/packages/medusa/src/api/routes/store/auth/get-session.ts +++ b/packages/medusa/src/api/routes/store/auth/get-session.ts @@ -2,7 +2,7 @@ import CustomerService from "../../../../services/customer" /** * @oas [get] /auth * operationId: "GetAuth" - * summary: "Get Session" + * summary: "Get Current Customer" * description: "Gets the currently logged in Customer." * x-authenticated: true * x-codeSamples: diff --git a/packages/medusa/src/api/routes/store/carts/create-payment-sessions.ts b/packages/medusa/src/api/routes/store/carts/create-payment-sessions.ts index c7f7bfe485..34fc15f1fd 100644 --- a/packages/medusa/src/api/routes/store/carts/create-payment-sessions.ts +++ b/packages/medusa/src/api/routes/store/carts/create-payment-sessions.ts @@ -7,7 +7,7 @@ import IdempotencyKeyService from "../../../../services/idempotency-key"; /** * @oas [post] /carts/{id}/payment-sessions * operationId: "PostCartsCartPaymentSessions" - * summary: "Initialize Payment Sessions" + * summary: "Create Payment Sessions" * description: "Creates Payment Sessions for each of the available Payment Providers in the Cart's Region." * parameters: * - (path) id=* {string} The id of the Cart. diff --git a/packages/medusa/src/api/routes/store/carts/delete-discount.ts b/packages/medusa/src/api/routes/store/carts/delete-discount.ts index 28fa514348..8e56619127 100644 --- a/packages/medusa/src/api/routes/store/carts/delete-discount.ts +++ b/packages/medusa/src/api/routes/store/carts/delete-discount.ts @@ -7,7 +7,7 @@ import { decorateLineItemsWithTotals } from "./decorate-line-items-with-totals" * @oas [delete] /carts/{id}/discounts/{code} * operationId: DeleteCartsCartDiscountsDiscount * description: "Removes a Discount from a Cart." - * summary: "Remove Discount from Cart" + * summary: "Remove Discount" * parameters: * - (path) id=* {string} The id of the Cart. * - (path) code=* {string} The unique Discount code. diff --git a/packages/medusa/src/api/routes/store/carts/get-cart.ts b/packages/medusa/src/api/routes/store/carts/get-cart.ts index cf71f89f26..c74359d6e4 100644 --- a/packages/medusa/src/api/routes/store/carts/get-cart.ts +++ b/packages/medusa/src/api/routes/store/carts/get-cart.ts @@ -4,7 +4,7 @@ import { decorateLineItemsWithTotals } from "./decorate-line-items-with-totals" /** * @oas [get] /carts/{id} * operationId: "GetCartsCart" - * summary: "Retrieve a Cart" + * summary: "Get a Cart" * description: "Retrieves a Cart." * parameters: * - (path) id=* {string} The id of the Cart. diff --git a/packages/medusa/src/api/routes/store/collections/get-collection.ts b/packages/medusa/src/api/routes/store/collections/get-collection.ts index a810ecf8f7..f32bd5b2ec 100644 --- a/packages/medusa/src/api/routes/store/collections/get-collection.ts +++ b/packages/medusa/src/api/routes/store/collections/get-collection.ts @@ -2,7 +2,7 @@ import ProductCollectionService from "../../../../services/product-collection" /** * @oas [get] /collections/{id} * operationId: "GetCollectionsCollection" - * summary: "Retrieve a Product Collection" + * summary: "Get a Collection" * description: "Retrieves a Product Collection." * parameters: * - (path) id=* {string} The id of the Product Collection diff --git a/packages/medusa/src/api/routes/store/collections/list-collections.ts b/packages/medusa/src/api/routes/store/collections/list-collections.ts index 948599d0ee..35bca814b0 100644 --- a/packages/medusa/src/api/routes/store/collections/list-collections.ts +++ b/packages/medusa/src/api/routes/store/collections/list-collections.ts @@ -8,7 +8,7 @@ import { validator } from "../../../../utils/validator" /** * @oas [get] /collections * operationId: "GetCollections" - * summary: "List Product Collections" + * summary: "List Collections" * description: "Retrieve a list of Product Collection." * parameters: * - (query) offset=0 {integer} The number of collections to skip before starting to collect the collections set diff --git a/packages/medusa/src/api/routes/store/customers/get-customer.ts b/packages/medusa/src/api/routes/store/customers/get-customer.ts index b5404355b5..29d6292ad8 100644 --- a/packages/medusa/src/api/routes/store/customers/get-customer.ts +++ b/packages/medusa/src/api/routes/store/customers/get-customer.ts @@ -4,7 +4,7 @@ import CustomerService from "../../../../services/customer" /** * @oas [get] /customers/me * operationId: GetCustomersCustomer - * summary: Retrieves a Customer + * summary: Get a Customer * description: "Retrieves a Customer - the Customer must be logged in to retrieve their details." * x-authenticated: true * x-codeSamples: diff --git a/packages/medusa/src/api/routes/store/customers/get-payment-methods.ts b/packages/medusa/src/api/routes/store/customers/get-payment-methods.ts index 35c284833c..d4dfe6c40f 100644 --- a/packages/medusa/src/api/routes/store/customers/get-payment-methods.ts +++ b/packages/medusa/src/api/routes/store/customers/get-payment-methods.ts @@ -7,7 +7,7 @@ import { PaymentProvider } from "../../../../models" /** * @oas [get] /customers/me/payment-methods * operationId: GetCustomersCustomerPaymentMethods - * summary: Retrieve saved payment methods + * summary: Get Payment Methods * description: "Retrieves a list of a Customer's saved payment methods. Payment methods are saved with Payment Providers and it is their responsibility to fetch saved methods." * x-authenticated: true * x-codeSamples: diff --git a/packages/medusa/src/api/routes/store/customers/list-orders.ts b/packages/medusa/src/api/routes/store/customers/list-orders.ts index 9b8f0db48a..8165883d75 100644 --- a/packages/medusa/src/api/routes/store/customers/list-orders.ts +++ b/packages/medusa/src/api/routes/store/customers/list-orders.ts @@ -20,7 +20,7 @@ import { Type } from "class-transformer" /** * @oas [get] /customers/me/orders * operationId: GetCustomersCustomerOrders - * summary: Retrieve Customer Orders + * summary: List Orders * description: "Retrieves a list of a Customer's Orders." * x-authenticated: true * parameters: diff --git a/packages/medusa/src/api/routes/store/customers/reset-password-token.ts b/packages/medusa/src/api/routes/store/customers/reset-password-token.ts index 4ff708369a..6fb8d4b3a8 100644 --- a/packages/medusa/src/api/routes/store/customers/reset-password-token.ts +++ b/packages/medusa/src/api/routes/store/customers/reset-password-token.ts @@ -6,7 +6,7 @@ import { EntityManager } from "typeorm" /** * @oas [post] /customers/password-token * operationId: PostCustomersCustomerPasswordToken - * summary: Creates a reset password token + * summary: Request Password Reset * description: "Creates a reset password token to be used in a subsequent /reset-password request. The password token should be sent out of band e.g. via email and will not be returned." * requestBody: * content: diff --git a/packages/medusa/src/api/routes/store/customers/reset-password.ts b/packages/medusa/src/api/routes/store/customers/reset-password.ts index 84138d3732..ec134c60ec 100644 --- a/packages/medusa/src/api/routes/store/customers/reset-password.ts +++ b/packages/medusa/src/api/routes/store/customers/reset-password.ts @@ -8,7 +8,7 @@ import { EntityManager } from "typeorm" /** * @oas [post] /customers/password-reset * operationId: PostCustomersResetPassword - * summary: Resets Customer password + * summary: Reset Password * description: "Resets a Customer's password using a password token created by a previous /password-token request." * requestBody: * content: diff --git a/packages/medusa/src/api/routes/store/customers/update-customer.ts b/packages/medusa/src/api/routes/store/customers/update-customer.ts index 8d5a2d463a..52cc5a7f02 100644 --- a/packages/medusa/src/api/routes/store/customers/update-customer.ts +++ b/packages/medusa/src/api/routes/store/customers/update-customer.ts @@ -10,7 +10,7 @@ import { EntityManager } from "typeorm" /** * @oas [post] /customers/me * operationId: PostCustomersCustomer - * summary: Update Customer details + * summary: Update Customer * description: "Updates a Customer's saved details." * x-authenticated: true * requestBody: diff --git a/packages/medusa/src/api/routes/store/gift-cards/get-gift-card.ts b/packages/medusa/src/api/routes/store/gift-cards/get-gift-card.ts index d4dc1372fc..23308ea562 100644 --- a/packages/medusa/src/api/routes/store/gift-cards/get-gift-card.ts +++ b/packages/medusa/src/api/routes/store/gift-cards/get-gift-card.ts @@ -5,7 +5,7 @@ import GiftCardService from "../../../../services/gift-card" /** * @oas [get] /gift-cards/{code} * operationId: "GetGiftCardsCode" - * summary: "Retrieve Gift Card by Code" + * summary: "Get Gift Card by Code" * description: "Retrieves a Gift Card by its associated unqiue code." * parameters: * - (path) code=* {string} The unique Gift Card code. diff --git a/packages/medusa/src/api/routes/store/orders/get-order-by-cart.ts b/packages/medusa/src/api/routes/store/orders/get-order-by-cart.ts index f83cfde797..7e67fb8f4e 100644 --- a/packages/medusa/src/api/routes/store/orders/get-order-by-cart.ts +++ b/packages/medusa/src/api/routes/store/orders/get-order-by-cart.ts @@ -5,7 +5,7 @@ import { OrderService } from "../../../../services" /** * @oas [get] /orders/cart/{cart_id} * operationId: GetOrdersOrderCartId - * summary: Retrieves Order by Cart id + * summary: Get by Cart ID * description: "Retrieves an Order by the id of the Cart that was used to create the Order." * parameters: * - (path) cart_id=* {string} The ID of Cart. diff --git a/packages/medusa/src/api/routes/store/orders/get-order.ts b/packages/medusa/src/api/routes/store/orders/get-order.ts index 248d9686f2..49658f55a9 100644 --- a/packages/medusa/src/api/routes/store/orders/get-order.ts +++ b/packages/medusa/src/api/routes/store/orders/get-order.ts @@ -5,7 +5,7 @@ import { OrderService } from "../../../../services" /** * @oas [get] /orders/{id} * operationId: GetOrdersOrder - * summary: Retrieves an Order + * summary: Get an Order * description: "Retrieves an Order" * parameters: * - (path) id=* {string} The id of the Order. diff --git a/packages/medusa/src/api/routes/store/products/get-product.ts b/packages/medusa/src/api/routes/store/products/get-product.ts index 9ea12010f9..e8b478094b 100644 --- a/packages/medusa/src/api/routes/store/products/get-product.ts +++ b/packages/medusa/src/api/routes/store/products/get-product.ts @@ -11,7 +11,7 @@ import { validator } from "../../../../utils/validator" /** * @oas [get] /products/{id} * operationId: GetProductsProduct - * summary: Retrieves a Product + * summary: Get a Product * description: "Retrieves a Product." * parameters: * - (path) id=* {string} The id of the Product. diff --git a/packages/medusa/src/api/routes/store/regions/get-region.ts b/packages/medusa/src/api/routes/store/regions/get-region.ts index d7766d6079..e515713ece 100644 --- a/packages/medusa/src/api/routes/store/regions/get-region.ts +++ b/packages/medusa/src/api/routes/store/regions/get-region.ts @@ -2,7 +2,7 @@ import RegionService from "../../../../services/region" /** * @oas [get] /regions/{id} * operationId: GetRegionsRegion - * summary: Retrieves a Region + * summary: Get a Region * description: "Retrieves a Region." * parameters: * - (path) id=* {string} The id of the Region. diff --git a/packages/medusa/src/api/routes/store/return-reasons/get-reason.ts b/packages/medusa/src/api/routes/store/return-reasons/get-reason.ts index 241d1166a4..6e41a82dea 100644 --- a/packages/medusa/src/api/routes/store/return-reasons/get-reason.ts +++ b/packages/medusa/src/api/routes/store/return-reasons/get-reason.ts @@ -7,7 +7,7 @@ import ReturnReasonService from "../../../../services/return-reason" /** * @oas [get] /return-reasons/{id} * operationId: "GetReturnReasonsReason" - * summary: "Retrieve a Return Reason" + * summary: "Get a Return Reason" * description: "Retrieves a Return Reason." * parameters: * - (path) id=* {string} The id of the Return Reason. diff --git a/packages/medusa/src/api/routes/store/shipping-options/list-options.ts b/packages/medusa/src/api/routes/store/shipping-options/list-options.ts index 452184509a..ff30524b61 100644 --- a/packages/medusa/src/api/routes/store/shipping-options/list-options.ts +++ b/packages/medusa/src/api/routes/store/shipping-options/list-options.ts @@ -6,7 +6,7 @@ import { validator } from "../../../../utils/validator" /** * @oas [get] /shipping-options * operationId: GetShippingOptions - * summary: Retrieve Shipping Options + * summary: Get Shipping Options * description: "Retrieves a list of Shipping Options." * parameters: * - (query) is_return {boolean} Whether return Shipping Options should be included. By default all Shipping Options are returned. diff --git a/packages/medusa/src/api/routes/store/shipping-options/list-shipping-options.ts b/packages/medusa/src/api/routes/store/shipping-options/list-shipping-options.ts index 8711654ce2..0455ac33d5 100644 --- a/packages/medusa/src/api/routes/store/shipping-options/list-shipping-options.ts +++ b/packages/medusa/src/api/routes/store/shipping-options/list-shipping-options.ts @@ -4,7 +4,7 @@ import ShippingProfileService from "../../../../services/shipping-profile" /** * @oas [get] /shipping-options/{cart_id} * operationId: GetShippingOptionsCartId - * summary: Retrieve Shipping Options for Cart + * summary: List for Cart * description: "Retrieves a list of Shipping Options available to a cart." * parameters: * - (path) cart_id {string} The id of the Cart. diff --git a/packages/medusa/src/api/routes/store/swaps/get-swap-by-cart.ts b/packages/medusa/src/api/routes/store/swaps/get-swap-by-cart.ts index 99f842ff65..7d9c10991c 100644 --- a/packages/medusa/src/api/routes/store/swaps/get-swap-by-cart.ts +++ b/packages/medusa/src/api/routes/store/swaps/get-swap-by-cart.ts @@ -2,7 +2,7 @@ import SwapService from "../../../../services/swap" /** * @oas [get] /swaps/{cart_id} * operationId: GetSwapsSwapCartId - * summary: Retrieve Swap by Cart id + * summary: Get by Cart ID * description: "Retrieves a Swap by the id of the Cart used to confirm the Swap." * parameters: * - (path) cart_id {string} The id of the Cart diff --git a/packages/medusa/src/api/routes/store/variants/get-variant.ts b/packages/medusa/src/api/routes/store/variants/get-variant.ts index ea47f3b065..c3c4714b7d 100644 --- a/packages/medusa/src/api/routes/store/variants/get-variant.ts +++ b/packages/medusa/src/api/routes/store/variants/get-variant.ts @@ -12,7 +12,7 @@ import { validator } from "../../../../utils/validator" /** * @oas [get] /variants/{variant_id} * operationId: GetVariantsVariant - * summary: Retrieve a Product Variant + * summary: Get a Product Variant * description: "Retrieves a Product Variant by id" * parameters: * - (path) variant_id=* {string} The id of the Product Variant. diff --git a/packages/medusa/src/api/routes/store/variants/list-variants.ts b/packages/medusa/src/api/routes/store/variants/list-variants.ts index 01be56e307..1899f82267 100644 --- a/packages/medusa/src/api/routes/store/variants/list-variants.ts +++ b/packages/medusa/src/api/routes/store/variants/list-variants.ts @@ -18,7 +18,7 @@ import { validator } from "../../../../utils/validator" /** * @oas [get] /variants * operationId: GetVariants - * summary: Retrieve Product Variants + * summary: Get Product Variants * description: "Retrieves a list of Product Variants" * parameters: * - (query) ids {string} A comma separated list of Product Variant ids to filter by.