docs: shortened summaries in API reference (#2902)

2022-12-26 18:09:22 +02:00
parent 035790606e
commit 1f1b85afbb
30 changed files with 36 additions and 36 deletions
--- a/packages/medusa/src/api/routes/admin/discounts/add-resources-to-condition-batch.ts
+++ b/packages/medusa/src/api/routes/admin/discounts/add-resources-to-condition-batch.ts
@@ -12,7 +12,7 @@ import { FindParams } from "../../../../types/common"
 /**
 * @oas [post] /discounts/{discount_id}/conditions/{condition_id}/batch
 * operationId: "PostDiscountsDiscountConditionsConditionBatch"
- * summary: "Add a batch of resources to a discount condition"
+ * summary: "Add Batch Resources"
 * description: "Add a batch of resources to a discount condition."
 * x-authenticated: true
 * parameters:
--- a/packages/medusa/src/api/routes/admin/discounts/delete-resources-from-condition-batch.ts
+++ b/packages/medusa/src/api/routes/admin/discounts/delete-resources-from-condition-batch.ts
@@ -11,7 +11,7 @@ import { FindParams } from "../../../../types/common"
 /**
 * @oas [delete] /discounts/{discount_id}/conditions/{condition_id}/batch
 * operationId: "DeleteDiscountsDiscountConditionsConditionBatch"
- * summary: "Delete a batch of resources from a discount condition"
+ * summary: "Delete Batch Resources"
 * description: "Delete a batch of resources from a discount condition."
 * x-authenticated: true
 * parameters:
--- a/packages/medusa/src/api/routes/admin/order-edits/add-line-item.ts
+++ b/packages/medusa/src/api/routes/admin/order-edits/add-line-item.ts
@@ -11,7 +11,7 @@ import {
 /**
 * @oas [post] /order-edits/{id}/items
 * operationId: "PostOrderEditsEditLineItems"
- * summary: "Add an line item to an order (edit)"
+ * summary: "Add a Line Item"
 * description: "Create an OrderEdit LineItem."
 * parameters:
 *   - (path) id=* {string} The ID of the Order Edit.
--- a/packages/medusa/src/api/routes/admin/order-edits/delete-line-item.ts
+++ b/packages/medusa/src/api/routes/admin/order-edits/delete-line-item.ts
@@ -9,7 +9,7 @@ import {
 /**
 * @oas [delete] /order-edits/{id}/items/{item_id}
 * operationId: "DeleteOrderEditsOrderEditLineItemsLineItem"
- * summary: "Delete line items from an order edit and create change item"
+ * summary: "Delete a Line Item"
 * description: "Delete line items from an order edit and create change item"
 * x-authenticated: true
 * parameters:
--- a/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit.ts
+++ b/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit.ts
@@ -5,7 +5,7 @@ import { OrderEditService } from "../../../../services"
 * @oas [delete] /order-edits/{id}
 * operationId: "DeleteOrderEditsOrderEdit"
 * summary: "Delete an Order Edit"
- * description: "Deletes an Order Edit"
+ * description: "Delete an Order Edit"
 * x-authenticated: true
 * parameters:
 *   - (path) id=* {string} The ID of the Order Edit to delete.
--- a/packages/medusa/src/api/routes/admin/order-edits/get-order-edit.ts
+++ b/packages/medusa/src/api/routes/admin/order-edits/get-order-edit.ts
@@ -5,7 +5,7 @@ import { FindParams } from "../../../../types/common"
 /**
 * @oas [get] /order-edits/{id}
 * operationId: "GetOrderEditsOrderEdit"
- * summary: "Retrieve an OrderEdit"
+ * summary: "Get an OrderEdit"
 * description: "Retrieves a OrderEdit."
 * x-authenticated: true
 * parameters:
--- a/packages/medusa/src/api/routes/admin/order-edits/request-confirmation.ts
+++ b/packages/medusa/src/api/routes/admin/order-edits/request-confirmation.ts
@@ -14,7 +14,7 @@ import { PaymentCollectionType } from "../../../../models"
 /**
 * @oas [post] /order-edits/{id}/request
 * operationId: "PostOrderEditsOrderEditRequest"
- * summary: "Request order edit confirmation"
+ * summary: "Request Confirmation"
 * description: "Request customer confirmation of an Order Edit"
 * x-authenticated: true
 * parameters:
--- a/packages/medusa/src/api/routes/admin/order-edits/update-order-edit-line-item.ts
+++ b/packages/medusa/src/api/routes/admin/order-edits/update-order-edit-line-item.ts
@@ -10,7 +10,7 @@ import {
 /**
 * @oas [post] /order-edits/{id}/items/{item_id}
 * operationId: "PostOrderEditsEditLineItemsLineItem"
- * summary: "Create or update the order edit change holding the line item changes"
+ * summary: "Upsert Line Item Change"
 * description: "Create or update the order edit change holding the line item changes"
 * x-authenticated: true
 * parameters:
--- a/packages/medusa/src/api/routes/admin/order-edits/update-order-edit.ts
+++ b/packages/medusa/src/api/routes/admin/order-edits/update-order-edit.ts
@@ -11,7 +11,7 @@ import {
 /**
 * @oas [post] /order-edits/{id}
 * operationId: "PostOrderEditsOrderEdit"
- * summary: "Updates an OrderEdit"
+ * summary: "Update an OrderEdit"
 * description: "Updates a OrderEdit."
 * x-authenticated: true
 * parameters:
--- a/packages/medusa/src/api/routes/admin/payment-collections/delete-payment-collection.ts
+++ b/packages/medusa/src/api/routes/admin/payment-collections/delete-payment-collection.ts
@@ -3,7 +3,7 @@ import { PaymentCollectionService } from "../../../../services"
 /**
 * @oas [delete] /payment-collections/{id}
 * operationId: "DeletePaymentCollectionsPaymentCollection"
- * summary: "Delete a Payment Collection"
+ * summary: "Del a PaymentCollection"
 * description: "Deletes a Payment Collection"
 * x-authenticated: true
 * parameters:
--- a/packages/medusa/src/api/routes/admin/payment-collections/get-payment-collection.ts
+++ b/packages/medusa/src/api/routes/admin/payment-collections/get-payment-collection.ts
@@ -4,7 +4,7 @@ import { FindParams } from "../../../../types/common"
 /**
 * @oas [get] /payment-collections/{id}
 * operationId: "GetPaymentCollectionsPaymentCollection"
- * summary: "Retrieve an PaymentCollection"
+ * summary: "Get a PaymentCollection"
 * description: "Retrieves a PaymentCollection."
 * x-authenticated: true
 * parameters:
--- a/packages/medusa/src/api/routes/admin/payment-collections/mark-authorized-payment-collection.ts
+++ b/packages/medusa/src/api/routes/admin/payment-collections/mark-authorized-payment-collection.ts
@@ -4,7 +4,7 @@ import { PaymentCollectionService } from "../../../../services"
 /**
 * @oas [post] /payment-collections/{id}/authorize
 * operationId: "PostPaymentCollectionsPaymentCollectionAuthorize"
- * summary: "Set the status of PaymentCollection as Authorized"
+ * summary: "Mark Authorized"
 * description: "Sets the status of PaymentCollection as Authorized."
 * x-authenticated: true
 * parameters:
--- a/packages/medusa/src/api/routes/admin/payment-collections/update-payment-collection.ts
+++ b/packages/medusa/src/api/routes/admin/payment-collections/update-payment-collection.ts
@@ -6,7 +6,7 @@ import { PaymentCollectionService } from "../../../../services"
 /**
 * @oas [post] /payment-collections/{id}
 * operationId: "PostPaymentCollectionsPaymentCollection"
- * summary: "Updates a PaymentCollection"
+ * summary: "Update PaymentCollection"
 * description: "Updates a PaymentCollection."
 * x-authenticated: true
 * parameters:
--- a/packages/medusa/src/api/routes/admin/publishable-api-keys/add-channels-batch.ts
+++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/add-channels-batch.ts
@@ -9,7 +9,7 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key"
 /**
 * @oas [post] /publishable-api-keys/{id}/sales-channels/batch
 * operationId: "PostPublishableApiKeySalesChannelsChannelsBatch"
- * summary: "Add sales channel to a publishable api key scope"
+ * summary: "Add SalesChannels"
 * description: "Assign a batch of sales channels to a publishable api key."
 * x-authenticated: true
 * parameters:
--- a/packages/medusa/src/api/routes/admin/publishable-api-keys/create-publishable-api-key.ts
+++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/create-publishable-api-key.ts
@@ -7,7 +7,7 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key"
 /**
 * @oas [post] /publishable-api-keys
 * operationId: "PostPublishableApiKeys"
- * summary: "Create a PublishableApiKey"
+ * summary: "Create PublishableApiKey"
 * description: "Creates a PublishableApiKey."
 * requestBody:
 *   content:
--- a/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-channels-batch.ts
+++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-channels-batch.ts
@@ -9,7 +9,7 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key"
 /**
 * @oas [delete] /publishable-api-keys/{id}/sales-channels/batch
 * operationId: "DeletePublishableApiKeySalesChannelsChannelsBatch"
- * summary: "Remove sales channel from a publishable api key scope"
+ * summary: "Delete SalesChannels"
 * description: "Remove a batch of sales channels from a publishable api key."
 * x-authenticated: true
 * parameters:
--- a/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-publishable-api-key.ts
+++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-publishable-api-key.ts
@@ -5,7 +5,7 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key"
 /**
 * @oas [delete] /publishable-api-keys/{id}
 * operationId: "DeletePublishableApiKeysPublishableApiKey"
- * summary: "Delete a PublishableApiKey"
+ * summary: "Delete PublishableApiKey"
 * description: "Deletes a PublishableApiKeys"
 * x-authenticated: true
 * parameters:
--- a/packages/medusa/src/api/routes/admin/publishable-api-keys/get-publishable-api-key.ts
+++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/get-publishable-api-key.ts
@@ -5,7 +5,7 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key"
 /**
 * @oas [get] /publishable-api-keys/{id}
 * operationId: "GetPublishableApiKeysPublishableApiKey"
- * summary: "Get a Publishable API Key"
+ * summary: "Get a PublishableApiKey"
 * description: "Retrieve the Publishable Api Key."
 * parameters:
 *   - (path) id=* {string} The ID of the PublishableApiKey.
--- a/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.ts
+++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.ts
@@ -7,7 +7,7 @@ import { extendedFindParamsMixin } from "../../../../types/common"
 /**
 * @oas [get] /publishable-api-keys/{id}/sales-channels
 * operationId: "GetPublishableApiKeySalesChannels"
- * summary: "List PublishableApiKey's SalesChannels"
+ * summary: "List SalesChannels"
 * description: "List PublishableApiKey's SalesChannels"
 * x-authenticated: true
 * parameters:
--- a/packages/medusa/src/api/routes/admin/publishable-api-keys/revoke-publishable-api-key.ts
+++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/revoke-publishable-api-key.ts
@@ -6,7 +6,7 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key"
 /**
 * @oas [post] /publishable-api-keys/{id}/revoke
 * operationId: "PostPublishableApiKeysPublishableApiKeyRevoke"
- * summary: "Revoke a PublishableApiKey"
+ * summary: "Revoke PublishableApiKey"
 * description: "Revokes a PublishableApiKey."
 * parameters:
 *   - (path) id=* {string} The ID of the PublishableApiKey.
--- a/packages/medusa/src/api/routes/admin/publishable-api-keys/update-publishable-api-key.ts
+++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/update-publishable-api-key.ts
@@ -7,7 +7,7 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key"
 /**
 * @oas [post] /publishable-api-key/{id}
 * operationId: "PostPublishableApiKysPublishableApiKey"
- * summary: "Updates a PublishableApiKey"
+ * summary: "Update PublishableApiKey"
 * description: "Updates a PublishableApiKey."
 * x-authenticated: true
 * parameters:
--- a/packages/medusa/src/api/routes/admin/uploads/create-protected-upload.ts
+++ b/packages/medusa/src/api/routes/admin/uploads/create-protected-upload.ts
@@ -4,8 +4,8 @@ import { IFileService } from "../../../../interfaces"
 /**
 * @oas [post] /uploads/protected
 * operationId: "PostUploadsProtected"
- * summary: "Upload files with acl or in a non-public bucket"
- * description: "Uploads at least one file to the specific fileservice that is installed in Medusa."
+ * summary: "Protected File Upload"
+ * description: "Uploads at least one file with ACL or a non-public bucket to the specific fileservice that is installed in Medusa."
 * x-authenticated: true
 * requestBody:
 *   content:
--- a/packages/medusa/src/api/routes/store/orders/confirm-order-request.ts
+++ b/packages/medusa/src/api/routes/store/orders/confirm-order-request.ts
@@ -9,7 +9,7 @@ import {
 /**
 * @oas [post] /orders/customer/confirm
 * operationId: "PostOrdersCustomerOrderClaimsCustomerOrderClaimAccept"
- * summary: "Verify a claim to orders"
+ * summary: "Verify an Order Claim"
 * description: "Verifies the claim order token provided to the customer upon request of order ownership"
 * requestBody:
 *   content:
@@ -44,7 +44,7 @@ import {
 *   - api_token: []
 *   - cookie_auth: []
 * tags:
- *   - Invite
+ *   - Order
 * responses:
 *   200:
 *     description: OK
--- a/packages/medusa/src/api/routes/store/orders/request-order.ts
+++ b/packages/medusa/src/api/routes/store/orders/request-order.ts
@@ -11,7 +11,7 @@ import { TokenEvents } from "../../../../types/token"
 /**
 * @oas [post] /orders/batch/customer/token
 * operationId: "PostOrdersCustomerOrderClaim"
- * summary: "Claim orders for signed in account"
+ * summary: "Claim an Order"
 * description: "Sends an email to emails registered to orders provided with link to transfer order ownership"
 * requestBody:
 *   content:
--- a/packages/medusa/src/api/routes/store/payment-collections/authorize-batch-payment-sessions.ts
+++ b/packages/medusa/src/api/routes/store/payment-collections/authorize-batch-payment-sessions.ts
@@ -4,7 +4,7 @@ import { PaymentCollectionService } from "../../../../services"
 /**
 * @oas [post] /payment-collections/{id}/sessions/batch/authorize
 * operationId: "PostPaymentCollectionsSessionsBatchAuthorize"
- * summary: "Authorize Payment Sessions of a Payment Collection"
+ * summary: "Authorize PaymentSessions"
 * description: "Authorizes Payment Sessions of a Payment Collection."
 * x-authenticated: false
 * parameters:
@@ -33,7 +33,7 @@ import { PaymentCollectionService } from "../../../../services"
 *   - api_token: []
 *   - cookie_auth: []
 * tags:
- *   - Payment
+ *   - PaymentCollection
 * responses:
 *   200:
 *     description: OK
--- a/packages/medusa/src/api/routes/store/payment-collections/authorize-payment-session.ts
+++ b/packages/medusa/src/api/routes/store/payment-collections/authorize-payment-session.ts
@@ -5,7 +5,7 @@ import { PaymentCollectionService } from "../../../../services"
 /**
 * @oas [post] /payment-collections/{id}/sessions/{session_id}/authorize
 * operationId: "PostPaymentCollectionsSessionsSessionAuthorize"
- * summary: "Authorize a Payment Session of a Payment Collection"
+ * summary: "Authorize Payment Session"
 * description: "Authorizes a Payment Session of a Payment Collection."
 * x-authenticated: false
 * parameters:
@@ -30,7 +30,7 @@ import { PaymentCollectionService } from "../../../../services"
 *   - api_token: []
 *   - cookie_auth: []
 * tags:
- *   - Payment
+ *   - PaymentCollection
 * responses:
 *   200:
 *     description: OK
--- a/packages/medusa/src/api/routes/store/payment-collections/get-payment-collection.ts
+++ b/packages/medusa/src/api/routes/store/payment-collections/get-payment-collection.ts
@@ -5,7 +5,7 @@ import { FindParams } from "../../../../types/common"
 * @oas [get] /payment-collections/{id}
 * operationId: "GetPaymentCollectionsPaymentCollection"
 * summary: "Retrieve an PaymentCollection"
- * description: "Retrieves a PaymentCollection."
+ * description: "Get a Payment Collection"
 * x-authenticated: false
 * parameters:
 *   - (path) id=* {string} The ID of the PaymentCollection.
--- a/packages/medusa/src/api/routes/store/payment-collections/manage-batch-payment-sessions.ts
+++ b/packages/medusa/src/api/routes/store/payment-collections/manage-batch-payment-sessions.ts
@@ -7,7 +7,7 @@ import { PaymentCollectionService } from "../../../../services"
 /**
 * @oas [post] /payment-collections/{id}/sessions/batch
 * operationId: "PostPaymentCollectionsPaymentCollectionSessionsBatch"
- * summary: "Manage Multiple Payment Sessions from Payment Collections"
+ * summary: "Manage Payment Sessions"
 * description: "Manages Multiple Payment Sessions from Payment Collections."
 * x-authenticated: false
 * parameters:
@@ -61,7 +61,7 @@ import { PaymentCollectionService } from "../../../../services"
 *   - api_token: []
 *   - cookie_auth: []
 * tags:
- *   - Payment
+ *   - PaymentCollection
 * responses:
 *   200:
 *     description: OK
--- a/packages/medusa/src/api/routes/store/payment-collections/manage-payment-session.ts
+++ b/packages/medusa/src/api/routes/store/payment-collections/manage-payment-session.ts
@@ -6,7 +6,7 @@ import { PaymentCollectionService } from "../../../../services"
 /**
 * @oas [post] /payment-collections/{id}/sessions
 * operationId: "PostPaymentCollectionsSessions"
- * summary: "Manage Payment Sessions from Payment Collections"
+ * summary: "Manage a Payment Session"
 * description: "Manages Payment Sessions from Payment Collections."
 * x-authenticated: false
 * parameters:
@@ -40,7 +40,7 @@ import { PaymentCollectionService } from "../../../../services"
 *   - api_token: []
 *   - cookie_auth: []
 * tags:
- *   - Payment
+ *   - PaymentCollection
 * responses:
 *   200:
 *     description: OK
--- a/packages/medusa/src/api/routes/store/payment-collections/refresh-payment-session.ts
+++ b/packages/medusa/src/api/routes/store/payment-collections/refresh-payment-session.ts
@@ -4,7 +4,7 @@ import { PaymentCollectionService } from "../../../../services"
 /**
 * @oas [post] /payment-collections/{id}/sessions/{session_id}
 * operationId: PostPaymentCollectionsPaymentCollectionPaymentSessionsSession
- * summary: Refresh a Payment Session
+ * summary: "Refresh a Payment Session"
 * description: "Refreshes a Payment Session to ensure that it is in sync with the Payment Collection."
 * x-authenticated: false
 * parameters: