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

Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>

docs/api/store/paths/auth.yaml

@@ -1,6 +1,6 @@
 post:
   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.
@@ -54,7 +54,7 @@ post:
               description: The Customer's password.
 delete:
   operationId: DeleteAuth
-  summary: Log out
+  summary: Customer Log out
   description: Destroys a Customer's authenticated session.
   x-authenticated: true
   x-codeSamples:
@@ -83,7 +83,7 @@ delete:
       $ref: ../components/responses/500_error.yaml
 get:
   operationId: GetAuth
-  summary: Get Session
+  summary: Get Current Customer
   description: Gets the currently logged in Customer.
   x-authenticated: true
   x-codeSamples:

docs/api/store/paths/auth_{email}.yaml

@@ -1,6 +1,6 @@
 get:
   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

docs/api/store/paths/carts_{id}.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetCartsCart
-  summary: Retrieve a Cart
+  summary: Get a Cart
   description: Retrieves a Cart.
   parameters:
     - in: path

docs/api/store/paths/carts_{id}_discounts_{code}.yaml

@@ -1,7 +1,7 @@
 delete:
   operationId: DeleteCartsCartDiscountsDiscount
   description: Removes a Discount from a Cart.
-  summary: Remove Discount from Cart
+  summary: Remove Discount
   parameters:
     - in: path
       name: id

docs/api/store/paths/carts_{id}_payment-sessions.yaml

@@ -1,6 +1,6 @@
 post:
   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.

docs/api/store/paths/collections.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetCollections
-  summary: List Product Collections
+  summary: List Collections
   description: Retrieve a list of Product Collection.
   parameters:
     - in: query

docs/api/store/paths/collections_{id}.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetCollectionsCollection
-  summary: Retrieve a Product Collection
+  summary: Get a Collection
   description: Retrieves a Product Collection.
   parameters:
     - in: path

docs/api/store/paths/customers_me.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetCustomersCustomer
-  summary: Retrieves a Customer
+  summary: Get a Customer
   description: >-
     Retrieves a Customer - the Customer must be logged in to retrieve their
     details.
@@ -41,7 +41,7 @@ get:
       $ref: ../components/responses/500_error.yaml
 post:
   operationId: PostCustomersCustomer
-  summary: Update Customer details
+  summary: Update Customer
   description: Updates a Customer's saved details.
   x-authenticated: true
   requestBody:

docs/api/store/paths/customers_me_orders.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetCustomersCustomerOrders
-  summary: Retrieve Customer Orders
+  summary: List Orders
   description: Retrieves a list of a Customer's Orders.
   x-authenticated: true
   parameters:

docs/api/store/paths/customers_me_payment-methods.yaml

@@ -1,6 +1,6 @@
 get:
   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

docs/api/store/paths/customers_password-reset.yaml

@@ -1,6 +1,6 @@
 post:
   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.

docs/api/store/paths/customers_password-token.yaml

@@ -1,6 +1,6 @@
 post:
   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

docs/api/store/paths/gift-cards_{code}.yaml

@@ -1,6 +1,6 @@
 get:
   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:
     - in: path

docs/api/store/paths/orders_cart_{cart_id}.yaml

@@ -1,6 +1,6 @@
 get:
   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:
     - in: path

docs/api/store/paths/orders_{id}.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetOrdersOrder
-  summary: Retrieves an Order
+  summary: Get an Order
   description: Retrieves an Order
   parameters:
     - in: path

docs/api/store/paths/products_{id}.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetProductsProduct
-  summary: Retrieves a Product
+  summary: Get a Product
   description: Retrieves a Product.
   parameters:
     - in: path

docs/api/store/paths/regions_{id}.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetRegionsRegion
-  summary: Retrieves a Region
+  summary: Get a Region
   description: Retrieves a Region.
   parameters:
     - in: path

docs/api/store/paths/return-reasons_{id}.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetReturnReasonsReason
-  summary: Retrieve a Return Reason
+  summary: Get a Return Reason
   description: Retrieves a Return Reason.
   parameters:
     - in: path

docs/api/store/paths/shipping-options.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetShippingOptions
-  summary: Retrieve Shipping Options
+  summary: Get Shipping Options
   description: Retrieves a list of Shipping Options.
   parameters:
     - in: query

docs/api/store/paths/shipping-options_{cart_id}.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetShippingOptionsCartId
-  summary: Retrieve Shipping Options for Cart
+  summary: List for Cart
   description: Retrieves a list of Shipping Options available to a cart.
   parameters:
     - in: path

docs/api/store/paths/swaps_{cart_id}.yaml

@@ -1,6 +1,6 @@
 get:
   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:
     - in: path

docs/api/store/paths/variants.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetVariants
-  summary: Retrieve Product Variants
+  summary: Get Product Variants
   description: Retrieves a list of Product Variants
   parameters:
     - in: query

docs/api/store/paths/variants_{variant_id}.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetVariantsVariant
-  summary: Retrieve a Product Variant
+  summary: Get a Product Variant
   description: Retrieves a Product Variant by id
   parameters:
     - in: path