chore(docs): Generated API Reference (#2191)

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
2022-09-13 10:59:51 +03:00
parent 5661250049
commit 6e0258f36c
107 changed files with 413 additions and 411 deletions
--- a/docs/api/admin/paths/admin_draft-orders_{id}.yaml
+++ b/docs/api/admin/paths/admin_draft-orders_{id}.yaml
@@ -1,6 +1,6 @@
 post:
  operationId: PostDraftOrdersDraftOrder
-  summary: Update a Draft Order"
+  summary: Update a Draft Order
  description: Updates a Draft Order.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/apps.yaml
+++ b/docs/api/admin/paths/apps.yaml
@@ -1,6 +1,6 @@
 get:
  operationId: GetApps
-  summary: List applications
+  summary: List Applications
  description: Retrieve a list of applications.
  x-authenticated: true
  x-codeSamples:
--- a/docs/api/admin/paths/apps_authorizations.yaml
+++ b/docs/api/admin/paths/apps_authorizations.yaml
@@ -1,6 +1,6 @@
 post:
  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:
--- a/docs/api/admin/paths/auth.yaml
+++ b/docs/api/admin/paths/auth.yaml
@@ -1,6 +1,6 @@
 post:
  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: []
@@ -53,7 +53,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 delete:
  operationId: DeleteAuth
-  summary: Delete Session
+  summary: User Logout
  x-authenticated: true
  description: Deletes the current session for the logged in user.
  x-codeSamples:
@@ -87,7 +87,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetAuth
-  summary: Get Session
+  summary: Get Current User
  x-authenticated: true
  description: Gets the currently logged in User.
  x-codeSamples:
--- a/docs/api/admin/paths/batch-jobs_{id}.yaml
+++ b/docs/api/admin/paths/batch-jobs_{id}.yaml
@@ -1,6 +1,6 @@
 get:
  operationId: GetBatchJobsBatchJob
-  summary: Retrieve a Batch Job
+  summary: Get a Batch Job
  description: Retrieves a Batch Job.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/batch-jobs_{id}_cancel.yaml
+++ b/docs/api/admin/paths/batch-jobs_{id}_cancel.yaml
@@ -1,6 +1,6 @@
 post:
  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:
--- a/docs/api/admin/paths/batch-jobs_{id}_confirm.yaml
+++ b/docs/api/admin/paths/batch-jobs_{id}_confirm.yaml
@@ -1,6 +1,6 @@
 post:
  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:
--- a/docs/api/admin/paths/collections.yaml
+++ b/docs/api/admin/paths/collections.yaml
@@ -1,6 +1,6 @@
 post:
  operationId: PostCollections
-  summary: Create a Product Collection
+  summary: Create a Collection
  description: Creates a Product Collection.
  x-authenticated: true
  requestBody:
@@ -60,7 +60,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetCollections
-  summary: List Product Collections
+  summary: List Collections
  description: Retrieve a list of Product Collection.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/collections_{id}.yaml
+++ b/docs/api/admin/paths/collections_{id}.yaml
@@ -1,6 +1,6 @@
 delete:
  operationId: DeleteCollectionsCollection
-  summary: Delete a Product Collection
+  summary: Delete a Collection
  description: Deletes a Product Collection.
  x-authenticated: true
  parameters:
@@ -56,7 +56,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetCollectionsCollection
-  summary: Retrieve a Product Collection
+  summary: Get a Collection
  description: Retrieves a Product Collection.
  x-authenticated: true
  parameters:
@@ -103,7 +103,7 @@ get:
      $ref: ../components/responses/500_error.yaml
 post:
  operationId: PostCollectionsCollection
-  summary: Update a Product Collection
+  summary: Update a Collection
  description: Updates a Product Collection.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/collections_{id}_products_batch.yaml
+++ b/docs/api/admin/paths/collections_{id}_products_batch.yaml
@@ -1,6 +1,6 @@
 post:
  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:
@@ -56,7 +56,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 delete:
  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:
--- a/docs/api/admin/paths/customer-groups.yaml
+++ b/docs/api/admin/paths/customer-groups.yaml
@@ -1,6 +1,6 @@
 post:
  operationId: PostCustomerGroups
-  summary: Create a CustomerGroup
+  summary: Create a Customer Group
  description: Creates a CustomerGroup.
  x-authenticated: true
  parameters: []
@@ -55,7 +55,7 @@ post:
              description: Metadata for the customer.
 get:
  operationId: GetCustomerGroups
-  summary: Retrieve a list of customer groups
+  summary: List Customer Groups
  description: Retrieve a list of customer groups.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/customer-groups_{id}.yaml
+++ b/docs/api/admin/paths/customer-groups_{id}.yaml
@@ -1,6 +1,6 @@
 delete:
  operationId: DeleteCustomerGroupsCustomerGroup
-  summary: Delete a CustomerGroup
+  summary: Delete a Customer Group
  description: Deletes a CustomerGroup.
  x-authenticated: true
  parameters:
@@ -56,7 +56,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetCustomerGroupsGroup
-  summary: Retrieve a CustomerGroup
+  summary: Get a Customer Group
  description: Retrieves a Customer Group.
  x-authenticated: true
  parameters:
@@ -113,7 +113,7 @@ get:
      $ref: ../components/responses/500_error.yaml
 post:
  operationId: PostCustomerGroupsGroup
-  summary: Update a CustomerGroup
+  summary: Update a Customer Group
  description: Update a CustomerGroup.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/customer-groups_{id}_customers_batch.yaml
+++ b/docs/api/admin/paths/customer-groups_{id}_customers_batch.yaml
@@ -1,6 +1,6 @@
 post:
  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:
@@ -66,7 +66,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 delete:
  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:
--- a/docs/api/admin/paths/customers_{id}.yaml
+++ b/docs/api/admin/paths/customers_{id}.yaml
@@ -1,6 +1,6 @@
 get:
  operationId: GetCustomersCustomer
-  summary: Retrieve a Customer
+  summary: Get a Customer
  description: Retrieves a Customer.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/discounts_code_{code}.yaml
+++ b/docs/api/admin/paths/discounts_code_{code}.yaml
@@ -1,6 +1,6 @@
 get:
  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:
--- a/docs/api/admin/paths/discounts_{discount_id}_conditions.yaml
+++ b/docs/api/admin/paths/discounts_{discount_id}_conditions.yaml
@@ -1,6 +1,6 @@
 post:
  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
--- a/docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}.yaml
+++ b/docs/api/admin/paths/discounts_{discount_id}_conditions_{condition_id}.yaml
@@ -1,6 +1,6 @@
 delete:
  operationId: DeleteDiscountsDiscountConditionsCondition
-  summary: Delete a DiscountCondition
+  summary: Delete a Condition
  description: Deletes a DiscountCondition
  x-authenticated: true
  parameters:
@@ -79,7 +79,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetDiscountsDiscountConditionsCondition
-  summary: Gets a DiscountCondition
+  summary: Get a Condition
  description: Gets a DiscountCondition
  x-authenticated: true
  parameters:
@@ -144,7 +144,7 @@ get:
      $ref: ../components/responses/500_error.yaml
 post:
  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
--- a/docs/api/admin/paths/discounts_{id}.yaml
+++ b/docs/api/admin/paths/discounts_{id}.yaml
@@ -56,7 +56,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetDiscountsDiscount
-  summary: Retrieve a Discount
+  summary: Get a Discount
  description: Retrieves a Discount
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/discounts_{id}_dynamic-codes.yaml
+++ b/docs/api/admin/paths/discounts_{id}_dynamic-codes.yaml
@@ -1,9 +1,9 @@
 post:
  operationId: PostDiscountsDiscountDynamicCodes
-  summary: Create a dynamic Discount code
+  summary: Create a Dynamic 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.
+    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:
    - in: path
--- a/docs/api/admin/paths/discounts_{id}_dynamic-codes_{code}.yaml
+++ b/docs/api/admin/paths/discounts_{id}_dynamic-codes_{code}.yaml
@@ -1,6 +1,6 @@
 delete:
  operationId: DeleteDiscountsDiscountDynamicCodesCode
-  summary: Delete a dynamic code
+  summary: Delete a Dynamic Code
  description: Deletes a dynamic code from a Discount.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/discounts_{id}_regions_{region_id}.yaml
+++ b/docs/api/admin/paths/discounts_{id}_regions_{region_id}.yaml
@@ -1,6 +1,6 @@
 post:
  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:
@@ -54,7 +54,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 delete:
  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:
--- a/docs/api/admin/paths/draft-orders_{id}.yaml
+++ b/docs/api/admin/paths/draft-orders_{id}.yaml
@@ -56,7 +56,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetDraftOrdersDraftOrder
-  summary: Retrieve a Draft Order
+  summary: Get a Draft Order
  description: Retrieves a Draft Order.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/draft-orders_{id}_line-items.yaml
+++ b/docs/api/admin/paths/draft-orders_{id}_line-items.yaml
@@ -1,6 +1,6 @@
 post:
  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:
--- a/docs/api/admin/paths/draft-orders_{id}_line-items_{line_id}.yaml
+++ b/docs/api/admin/paths/draft-orders_{id}_line-items_{line_id}.yaml
@@ -55,7 +55,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 post:
  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:
--- a/docs/api/admin/paths/draft-orders_{id}_pay.yaml
+++ b/docs/api/admin/paths/draft-orders_{id}_pay.yaml
@@ -1,5 +1,5 @@
 post:
-  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
--- a/docs/api/admin/paths/gift-cards_{id}.yaml
+++ b/docs/api/admin/paths/gift-cards_{id}.yaml
@@ -56,7 +56,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetGiftCardsGiftCard
-  summary: Retrieve a Gift Card
+  summary: Get a Gift Card
  description: Retrieves a Gift Card.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/invites.yaml
+++ b/docs/api/admin/paths/invites.yaml
@@ -53,7 +53,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetInvites
-  summary: Lists all Invites
+  summary: Lists Invites
  description: Lists all Invites
  x-authenticated: true
  x-codeSamples:
--- a/docs/api/admin/paths/notes_{id}.yaml
+++ b/docs/api/admin/paths/notes_{id}.yaml
@@ -1,6 +1,6 @@
 delete:
  operationId: DeleteNotesNote
-  summary: Deletes a Note
+  summary: Delete a Note
  description: Deletes a Note.
  x-authenticated: true
  parameters:
@@ -56,7 +56,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetNotesNote
-  summary: Get Note
+  summary: Get a Note
  description: Retrieves a single note using its id
  x-authenticated: true
  parameters:
@@ -103,7 +103,7 @@ get:
      $ref: ../components/responses/500_error.yaml
 post:
  operationId: PostNotesNote
-  summary: Updates a Note
+  summary: Update a Note
  x-authenticated: true
  description: Updates a Note associated with some resource
  parameters:
--- a/docs/api/admin/paths/orders_{id}.yaml
+++ b/docs/api/admin/paths/orders_{id}.yaml
@@ -1,6 +1,6 @@
 get:
  operationId: GetOrdersOrder
-  summary: Retrieve an Order
+  summary: Get an Order
  description: Retrieves an Order
  x-authenticated: true
  parameters:
@@ -47,7 +47,7 @@ get:
      $ref: ../components/responses/500_error.yaml
 post:
  operationId: PostOrdersOrder
-  summary: Update an order
+  summary: Update an Order
  description: Updates and order
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/orders_{id}_archive.yaml
+++ b/docs/api/admin/paths/orders_{id}_archive.yaml
@@ -1,6 +1,6 @@
 post:
  operationId: PostOrdersOrderArchive
-  summary: Archive order
+  summary: Archive Order
  description: Archives the order with the given id.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/orders_{id}_capture.yaml
+++ b/docs/api/admin/paths/orders_{id}_capture.yaml
@@ -1,6 +1,6 @@
 post:
  operationId: PostOrdersOrderCapture
-  summary: Capture an Order
+  summary: Capture Order's Payment
  description: Captures all the Payments associated with an Order.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_cancel.yaml
+++ b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_cancel.yaml
@@ -1,6 +1,6 @@
 post:
  operationId: PostOrdersClaimCancel
-  summary: Cancels a Claim
+  summary: Cancel a Claim
  description: Cancels a Claim
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments.yaml
+++ b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments.yaml
@@ -1,6 +1,6 @@
 post:
  operationId: PostOrdersOrderClaimsClaimFulfillments
-  summary: Create a Claim Fulfillment
+  summary: Create Claim Fulfillment
  description: Creates a Fulfillment for a Claim.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml
+++ b/docs/api/admin/paths/orders_{id}_claims_{claim_id}_fulfillments_{fulfillment_id}_cancel.yaml
@@ -1,7 +1,7 @@
 post:
  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:
    - in: path
--- a/docs/api/admin/paths/orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml
+++ b/docs/api/admin/paths/orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml
@@ -1,6 +1,6 @@
 post:
  operationId: PostOrdersOrderFulfillmentsCancel
-  summary: Cancels a fulfilmment
+  summary: Cancels a Fulfilmment
  description: Registers a Fulfillment as canceled.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments.yaml
+++ b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments.yaml
@@ -1,6 +1,6 @@
 post:
  operationId: PostOrdersOrderSwapsSwapFulfillments
-  summary: Create a Swap Fulfillment
+  summary: Create Swap Fulfillment
  description: Creates a Fulfillment for a Swap.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml
+++ b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_fulfillments_{fulfillment_id}_cancel.yaml
@@ -1,7 +1,7 @@
 post:
  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:
    - in: path
--- a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_process-payment.yaml
+++ b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_process-payment.yaml
@@ -1,6 +1,6 @@
 post:
  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
--- a/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_shipments.yaml
+++ b/docs/api/admin/paths/orders_{id}_swaps_{swap_id}_shipments.yaml
@@ -33,7 +33,7 @@ post:
                type: string
            no_notification:
              description: >-
-                If set to true no notification will be send related to this
+                If set to true no notification will be sent related to this
                Claim.
              type: boolean
  x-codeSamples:
--- a/docs/api/admin/paths/price-lists.yaml
+++ b/docs/api/admin/paths/price-lists.yaml
@@ -1,6 +1,6 @@
 post:
  operationId: PostPriceListsPriceList
-  summary: Creates a Price List
+  summary: Create a Price List
  description: Creates a Price List
  x-authenticated: true
  requestBody:
--- a/docs/api/admin/paths/price-lists_{id}.yaml
+++ b/docs/api/admin/paths/price-lists_{id}.yaml
@@ -56,7 +56,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetPriceListsPriceList
-  summary: Retrieve a Price List
+  summary: Get a Price List
  description: Retrieves a Price List.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/price-lists_{id}_prices_batch.yaml
+++ b/docs/api/admin/paths/price-lists_{id}_prices_batch.yaml
@@ -1,6 +1,6 @@
 post:
  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:
@@ -93,7 +93,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 delete:
  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:
--- a/docs/api/admin/paths/price-lists_{id}_products.yaml
+++ b/docs/api/admin/paths/price-lists_{id}_products.yaml
@@ -1,6 +1,6 @@
 get:
  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:
--- a/docs/api/admin/paths/price-lists_{id}_products_{product_id}_prices.yaml
+++ b/docs/api/admin/paths/price-lists_{id}_products_{product_id}_prices.yaml
@@ -1,6 +1,6 @@
 delete:
  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:
--- a/docs/api/admin/paths/price-lists_{id}_variants_{variant_id}_prices.yaml
+++ b/docs/api/admin/paths/price-lists_{id}_variants_{variant_id}_prices.yaml
@@ -1,6 +1,6 @@
 delete:
  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:
--- a/docs/api/admin/paths/products.yaml
+++ b/docs/api/admin/paths/products.yaml
@@ -215,7 +215,7 @@ post:
                            index in the Product's `options` field.
                          type: string
            weight:
-              description: The wieght of the Product.
+              description: The weight of the Product.
              type: number
            length:
              description: The length of the Product.
@@ -278,7 +278,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetProducts
-  summary: List Product
+  summary: List Products
  description: Retrieves a list of Product
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/products_tag-usage.yaml
+++ b/docs/api/admin/paths/products_tag-usage.yaml
@@ -1,6 +1,6 @@
 get:
  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:
--- a/docs/api/admin/paths/products_{id}.yaml
+++ b/docs/api/admin/paths/products_{id}.yaml
@@ -56,7 +56,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetProductsProduct
-  summary: Retrieve a Product
+  summary: Get a Product
  description: Retrieves a Product.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/products_{id}_metadata.yaml
+++ b/docs/api/admin/paths/products_{id}_metadata.yaml
@@ -1,6 +1,6 @@
 post:
  operationId: PostProductsProductMetadata
-  summary: Set Product metadata
+  summary: Set Product Metadata
  description: Set metadata key/value pair for Product
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/products_{id}_options_{option_id}.yaml
+++ b/docs/api/admin/paths/products_{id}_options_{option_id}.yaml
@@ -69,7 +69,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 post:
  operationId: PostProductsProductOptionsOption
-  summary: Update a Product Option.
+  summary: Update a Product Option
  description: Updates a Product Option
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/products_{id}_variants.yaml
+++ b/docs/api/admin/paths/products_{id}_variants.yaml
@@ -156,7 +156,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 get:
  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:
--- a/docs/api/admin/paths/products_{id}_variants_{variant_id}.yaml
+++ b/docs/api/admin/paths/products_{id}_variants_{variant_id}.yaml
@@ -119,7 +119,7 @@ post:
                Product Variant.
              type: boolean
            weight:
-              description: The wieght of the Product Variant.
+              description: The weight of the Product Variant.
              type: number
            length:
              description: The length of the Product Variant.
--- a/docs/api/admin/paths/regions_{id}.yaml
+++ b/docs/api/admin/paths/regions_{id}.yaml
@@ -56,7 +56,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetRegionsRegion
-  summary: Retrieve a Region
+  summary: Get a Region
  description: Retrieves a Region.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/regions_{id}_countries_{country_code}.yaml
+++ b/docs/api/admin/paths/regions_{id}_countries_{country_code}.yaml
@@ -1,6 +1,6 @@
 delete:
  operationId: PostRegionsRegionCountriesCountry
-  summary: Remove Country
+  summary: Delete Country
  x-authenticated: true
  description: Removes a Country from the list of Countries in a Region
  parameters:
--- a/docs/api/admin/paths/regions_{id}_fulfillment-options.yaml
+++ b/docs/api/admin/paths/regions_{id}_fulfillment-options.yaml
@@ -1,6 +1,6 @@
 get:
  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:
--- a/docs/api/admin/paths/regions_{id}_fulfillment-providers_{provider_id}.yaml
+++ b/docs/api/admin/paths/regions_{id}_fulfillment-providers_{provider_id}.yaml
@@ -1,6 +1,6 @@
 delete:
  operationId: PostRegionsRegionFulfillmentProvidersProvider
-  summary: Remove Fulfillment Provider
+  summary: Del. Fulfillment Provider
  description: Removes a Fulfillment Provider.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/regions_{id}_payment-providers_{provider_id}.yaml
+++ b/docs/api/admin/paths/regions_{id}_payment-providers_{provider_id}.yaml
@@ -1,6 +1,6 @@
 delete:
  operationId: PostRegionsRegionPaymentProvidersProvider
-  summary: Remove Payment Provider
+  summary: Delete Payment Provider
  description: Removes a Payment Provider.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/return-reasons_{id}.yaml
+++ b/docs/api/admin/paths/return-reasons_{id}.yaml
@@ -1,6 +1,6 @@
 delete:
  operationId: DeleteReturnReason
-  summary: Delete a return reason
+  summary: Delete a Return Reason
  description: Deletes a return reason.
  x-authenticated: true
  parameters:
@@ -56,7 +56,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetReturnReasonsReason
-  summary: Retrieve a Return Reason
+  summary: Get a Return Reason
  description: Retrieves a Return Reason.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/sales-channels.yaml
+++ b/docs/api/admin/paths/sales-channels.yaml
@@ -56,7 +56,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetSalesChannels
-  summary: List sales channels
+  summary: List Sales Channels
  description: Retrieves a list of sales channels
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/sales-channels_{id}.yaml
+++ b/docs/api/admin/paths/sales-channels_{id}.yaml
@@ -1,6 +1,6 @@
 delete:
  operationId: DeleteSalesChannelsSalesChannel
-  summary: Delete a sales channel
+  summary: Delete a Sales Channel
  description: Deletes the sales channel.
  x-authenticated: true
  parameters:
@@ -56,7 +56,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetSalesChannelsSalesChannel
-  summary: Retrieve a sales channel
+  summary: Get a Sales Channel
  description: Retrieves the sales channel.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/sales-channels_{id}_products_batch.yaml
+++ b/docs/api/admin/paths/sales-channels_{id}_products_batch.yaml
@@ -1,6 +1,6 @@
 post:
  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:
@@ -66,7 +66,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 delete:
  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:
--- a/docs/api/admin/paths/shipping-options_{id}.yaml
+++ b/docs/api/admin/paths/shipping-options_{id}.yaml
@@ -56,7 +56,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetShippingOptionsOption
-  summary: Retrieve a Shipping Option
+  summary: Get a Shipping Option
  description: Retrieves a Shipping Option.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/shipping-profiles_{id}.yaml
+++ b/docs/api/admin/paths/shipping-profiles_{id}.yaml
@@ -56,7 +56,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetShippingProfilesProfile
-  summary: Retrieve a Shipping Profile
+  summary: Get a Shipping Profile
  description: Retrieves a Shipping Profile.
  x-authenticated: true
  parameters:
@@ -103,7 +103,7 @@ get:
      $ref: ../components/responses/500_error.yaml
 post:
  operationId: PostShippingProfilesProfile
-  summary: Update a Shipping Profiles
+  summary: Update a Shipping Profile
  description: Updates a Shipping Profile
  parameters:
    - in: path
--- a/docs/api/admin/paths/store.yaml
+++ b/docs/api/admin/paths/store.yaml
@@ -1,6 +1,6 @@
 get:
  operationId: GetStore
-  summary: Retrieve Store details.
+  summary: Get Store details
  description: Retrieves the Store details
  x-authenticated: true
  x-codeSamples:
@@ -40,7 +40,7 @@ get:
      $ref: ../components/responses/500_error.yaml
 post:
  operationId: PostStore
-  summary: Update Store details.
+  summary: Update Store Details
  description: Updates the Store details
  x-authenticated: true
  requestBody:
--- a/docs/api/admin/paths/store_currencies_{code}.yaml
+++ b/docs/api/admin/paths/store_currencies_{code}.yaml
@@ -50,7 +50,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 delete:
  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:
--- a/docs/api/admin/paths/store_payment-providers.yaml
+++ b/docs/api/admin/paths/store_payment-providers.yaml
@@ -1,6 +1,6 @@
 get:
  operationId: GetStorePaymentProviders
-  summary: Retrieve configured Payment Providers
+  summary: List Payment Providers
  description: Retrieves the configured Payment Providers
  x-authenticated: true
  x-codeSamples:
--- a/docs/api/admin/paths/store_tax-providers.yaml
+++ b/docs/api/admin/paths/store_tax-providers.yaml
@@ -1,6 +1,6 @@
 get:
  operationId: GetStoreTaxProviders
-  summary: Retrieve configured Tax Providers
+  summary: List Tax Providers
  description: Retrieves the configured Tax Providers
  x-authenticated: true
  x-codeSamples:
--- a/docs/api/admin/paths/swaps_{id}.yaml
+++ b/docs/api/admin/paths/swaps_{id}.yaml
@@ -1,6 +1,6 @@
 get:
  operationId: GetSwapsSwap
-  summary: Retrieve a Swap
+  summary: Get a Swap
  description: Retrieves a Swap.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/tax-rates_{id}.yaml
+++ b/docs/api/admin/paths/tax-rates_{id}.yaml
@@ -56,7 +56,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetTaxRatesTaxRate
-  summary: Get Tax Rate
+  summary: Get a Tax Rate
  description: Retrieves a TaxRate
  parameters:
    - in: path
--- a/docs/api/admin/paths/tax-rates_{id}_product-types_batch.yaml
+++ b/docs/api/admin/paths/tax-rates_{id}_product-types_batch.yaml
@@ -1,6 +1,6 @@
 post:
  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:
    - in: path
@@ -78,7 +78,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 delete:
  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:
    - in: path
--- a/docs/api/admin/paths/tax-rates_{id}_products_batch.yaml
+++ b/docs/api/admin/paths/tax-rates_{id}_products_batch.yaml
@@ -1,6 +1,6 @@
 post:
  operationId: PostTaxRatesTaxRateProducts
-  summary: Add Tax Rate to Products
+  summary: Add to Products
  description: Associates a Tax Rate with a list of Products
  parameters:
    - in: path
@@ -77,7 +77,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 delete:
  operationId: DeleteTaxRatesTaxRateProducts
-  summary: Removes Tax Rate from Products
+  summary: Delete from Products
  description: Removes a Tax Rate from a list of Products
  parameters:
    - in: path
--- a/docs/api/admin/paths/tax-rates_{id}_shipping-options_batch.yaml
+++ b/docs/api/admin/paths/tax-rates_{id}_shipping-options_batch.yaml
@@ -1,6 +1,6 @@
 post:
  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:
    - in: path
@@ -79,8 +79,8 @@ post:
      $ref: ../components/responses/500_error.yaml
 delete:
  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:
    - in: path
      name: id
--- a/docs/api/admin/paths/uploads.yaml
+++ b/docs/api/admin/paths/uploads.yaml
@@ -1,6 +1,6 @@
 post:
  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:
--- a/docs/api/admin/paths/users.yaml
+++ b/docs/api/admin/paths/users.yaml
@@ -69,7 +69,7 @@ post:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetUsers
-  summary: Retrieve all users
+  summary: List Users
  description: Retrieves all users.
  x-authenticated: true
  x-codeSamples:
--- a/docs/api/admin/paths/users_password-token.yaml
+++ b/docs/api/admin/paths/users_password-token.yaml
@@ -1,6 +1,6 @@
 post:
  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:
--- a/docs/api/admin/paths/users_reset-password.yaml
+++ b/docs/api/admin/paths/users_reset-password.yaml
@@ -1,6 +1,6 @@
 post:
  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:
--- a/docs/api/admin/paths/users_{id}.yaml
+++ b/docs/api/admin/paths/users_{id}.yaml
@@ -56,7 +56,7 @@ delete:
      $ref: ../components/responses/500_error.yaml
 get:
  operationId: GetUsersUser
-  summary: Retrieve a User
+  summary: Get a User
  description: Retrieves a User.
  x-authenticated: true
  parameters:
--- a/docs/api/admin/paths/variants.yaml
+++ b/docs/api/admin/paths/variants.yaml
@@ -1,6 +1,6 @@
 get:
  operationId: GetVariants
-  summary: List Product Variants.
+  summary: List Product Variants
  description: Retrieves a list of Product Variants
  x-authenticated: true
  parameters: