feat(oas): declare x-codegen on Store routes

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

@@ -10,9 +10,13 @@ import { validator } from "../../../../utils/validator"
  * operationId: "PostAuth"
  * 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.
- *   - (body) password=* {string} The Customer's password.
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/StorePostAuthReq"
+ * x-codegen:
+ *   method: authenticate
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client
@@ -93,6 +97,20 @@ export default async (req, res) => {
   res.json({ customer })
 }
 
+/**
+ * @schema StorePostAuthReq
+ * type: object
+ * required:
+ *   - email
+ *   - password
+ * properties:
+ *   email:
+ *     type: string
+ *     description: The Customer's email.
+ *   password:
+ *     type: string
+ *     description: The Customer's password.
+ */
 export class StorePostAuthReq {
   @IsEmail()
   email: string

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

@@ -4,6 +4,8 @@
  * summary: "Customer Log out"
  * description: "Destroys a Customer's authenticated session."
  * x-authenticated: true
+ * x-codegen:
+ *   method: deleteSession
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

packages/medusa/src/api/routes/store/auth/exists.ts

@@ -13,6 +13,8 @@ import CustomerService from "../../../../services/customer"
  *       format: email
  *     required: true
  *     description: The email to check if exists.
+ * x-codegen:
+ *   method: exists
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

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

@@ -6,6 +6,8 @@ import CustomerService from "../../../../services/customer"
  * summary: "Get Current Customer"
  * description: "Gets the currently logged in Customer."
  * x-authenticated: true
+ * x-codegen:
+ *   method: getSession
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/store/carts/add-shipping-method.ts

@@ -12,8 +12,13 @@ import { validator } from "../../../../utils/validator"
  * summary: "Add a Shipping Method"
  * parameters:
  *   - (path) id=* {string} The cart ID.
- *   - (body) option_id=* {string} ID of the shipping option to create the method from
- *   - (body) data {Object} Used to hold any data that the shipping method may need to process the fulfillment of the order. Look at the documentation for your installed fulfillment providers to find out what to send.
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/StorePostCartsCartShippingMethodReq"
+ * x-codegen:
+ *   method: addShippingMethod
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client
@@ -91,6 +96,19 @@ export default async (req, res) => {
   res.status(200).json({ cart: data })
 }
 
+/**
+ * @schema StorePostCartsCartShippingMethodReq
+ * type: object
+ * required:
+ *   - option_id
+ * properties:
+ *   option_id:
+ *     type: string
+ *     description: ID of the shipping option to create the method from
+ *   data:
+ *     type: object
+ *     description: Used to hold any data that the shipping method may need to process the fulfillment of the order. Look at the documentation for your installed fulfillment providers to find out what to send.
+ */
 export class StorePostCartsCartShippingMethodReq {
   @IsString()
   option_id: string

packages/medusa/src/api/routes/store/carts/calculate-taxes.ts

@@ -11,6 +11,8 @@ import { IdempotencyKey } from "../../../../models/idempotency-key"
  *   this may involve making 3rd party API calls to a Tax Provider service."
  * parameters:
  *   - (path) id=* {String} The Cart ID.
+ * x-codegen:
+ *   method: calculateTaxes
  * x-codeSamples:
  *   - lang: Shell
  *     label: cURL

packages/medusa/src/api/routes/store/carts/complete-cart.ts

@@ -15,6 +15,8 @@ import { IdempotencyKeyService } from "../../../../services"
  *   will generate one for the request."
  * parameters:
  *   - (path) id=* {String} The Cart id.
+ * x-codegen:
+ *   method: complete
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/store/carts/create-cart.ts

@@ -37,6 +37,8 @@ import PublishableAPIKeysFeatureFlag from "../../../../loaders/feature-flags/pub
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/StorePostCartReq"
+ * x-codegen:
+ *   method: create
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/store/carts/create-line-item/index.ts

@@ -20,9 +20,13 @@ import {
  *   to the Cart"
  * parameters:
  *   - (path) id=* {string} The id of the Cart to add the Line Item to.
- *   - (body) variant_id=* {string} The id of the Product Variant to generate the Line Item from.
- *   - (body) quantity=* {integer} The quantity of the Product Variant to add to the Line Item.
- *   - (body) metadata {object} An optional key-value map with additional details about the Line Item.
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/StorePostCartsCartLineItemsReq"
+ * x-codegen:
+ *   method: createLineItem
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client
@@ -129,6 +133,23 @@ export default async (req, res) => {
   res.status(idempotencyKey.response_code).json(idempotencyKey.response_body)
 }
 
+/**
+ * @schema StorePostCartsCartLineItemsReq
+ * type: object
+ * required:
+ *   - variant_id
+ *   - quantity
+ * properties:
+ *   variant_id:
+ *     type: string
+ *     description: The id of the Product Variant to generate the Line Item from.
+ *   quantity:
+ *     type: number
+ *     description: The quantity of the Product Variant to add to the Line Item.
+ *   metadata:
+ *     type: object
+ *     description: An optional key-value map with additional details about the Line Item.
+ */
 export class StorePostCartsCartLineItemsReq {
   @IsString()
   variant_id: string

packages/medusa/src/api/routes/store/carts/create-payment-sessions.ts

@@ -10,6 +10,8 @@ import IdempotencyKeyService from "../../../../services/idempotency-key"
  * 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.
+ * x-codegen:
+ *   method: createPaymentSessions
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/store/carts/delete-discount.ts

@@ -10,6 +10,8 @@ import { CartService } from "../../../../services"
  * parameters:
  *   - (path) id=* {string} The id of the Cart.
  *   - (path) code=* {string} The unique Discount code.
+ * x-codegen:
+ *   method: deleteDiscount
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/store/carts/delete-line-item.ts

@@ -10,6 +10,8 @@ import { CartService } from "../../../../services"
  * parameters:
  *   - (path) id=* {string} The id of the Cart.
  *   - (path) line_id=* {string} The id of the Line Item.
+ * x-codegen:
+ *   method: deleteLineItem
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/store/carts/delete-payment-session.ts

@@ -10,6 +10,8 @@ import { EntityManager } from "typeorm"
  * parameters:
  *   - (path) id=* {string} The id of the Cart.
  *   - (path) provider_id=* {string} The id of the Payment Provider used to create the Payment Session to be deleted.
+ * x-codegen:
+ *   method: deletePaymentSession
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/store/carts/get-cart.ts

@@ -7,6 +7,8 @@ import { CartService } from "../../../../services"
  * description: "Retrieves a Cart."
  * parameters:
  *   - (path) id=* {string} The id of the Cart.
+ * x-codegen:
+ *   method: retrieve
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/store/carts/refresh-payment-session.ts

@@ -9,6 +9,8 @@ import { EntityManager } from "typeorm"
  * parameters:
  *   - (path) id=* {string} The id of the Cart.
  *   - (path) provider_id=* {string} The id of the Payment Provider that created the Payment Session to be refreshed.
+ * x-codegen:
+ *   method: refreshPaymentSession
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/store/carts/set-payment-session.ts

@@ -13,6 +13,13 @@ import { validator } from "../../../../utils/validator"
  * parameters:
  *   - (path) id=* {string} The ID of the Cart.
  *   - (body) provider_id=* {string} The ID of the Payment Provider.
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/StorePostCartsCartPaymentSessionReq"
+ * x-codegen:
+ *   method: setPaymentSession
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client
@@ -78,6 +85,16 @@ export default async (req, res) => {
   res.status(200).json({ cart: data })
 }
 
+/**
+ * @schema StorePostCartsCartPaymentSessionReq
+ * type: object
+ * required:
+ *   - provider_id
+ * properties:
+ *   provider_id:
+ *     type: string
+ *     description: The ID of the Payment Provider.
+ */
 export class StorePostCartsCartPaymentSessionReq {
   @IsString()
   provider_id: string

packages/medusa/src/api/routes/store/carts/update-cart.ts

@@ -27,6 +27,8 @@ import { IsType } from "../../../../utils/validators/is-type"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/StorePostCartsCartReq"
+ * x-codegen:
+ *   method: update
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/store/carts/update-line-item.ts

@@ -13,7 +13,13 @@ import { validator } from "../../../../utils/validator"
  * parameters:
  *   - (path) id=* {string} The id of the Cart.
  *   - (path) line_id=* {string} The id of the Line Item.
- *   - (body) quantity=* {integer} The quantity to set the Line Item to.
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/StorePostCartsCartLineItemsItemReq"
+ * x-codegen:
+ *   method: updateLineItem
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client
@@ -112,6 +118,16 @@ export default async (req, res) => {
   res.status(200).json({ cart: data })
 }
 
+/**
+ * @schema StorePostCartsCartLineItemsItemReq
+ * type: object
+ * required:
+ *   - quantity
+ * properties:
+ *   quantity:
+ *     type: number
+ *     description: The quantity to set the Line Item to.
+ */
 export class StorePostCartsCartLineItemsItemReq {
   @IsInt()
   quantity: number

packages/medusa/src/api/routes/store/carts/update-payment-session.ts

@@ -12,7 +12,13 @@ import { EntityManager } from "typeorm"
  * parameters:
  *   - (path) id=* {string} The id of the Cart.
  *   - (path) provider_id=* {string} The id of the payment provider.
- *   - (body) data=* {object} The data to update the payment session with.
+ * requestBody:
+ *   content:
+ *     application/json:
+ *       schema:
+ *         $ref: "#/components/schemas/StorePostCartsCartPaymentSessionUpdateReq"
+ * x-codegen:
+ *   method: updatePaymentSession
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client
@@ -83,6 +89,16 @@ export default async (req, res) => {
   res.status(200).json({ cart: data })
 }
 
+/**
+ * @schema StorePostCartsCartPaymentSessionUpdateReq
+ * type: object
+ * required:
+ *   - data
+ * properties:
+ *   data:
+ *     type: object
+ *     description: The data to update the payment session with.
+ */
 export class StorePostCartsCartPaymentSessionUpdateReq {
   @IsObject()
   data: Record<string, unknown>

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

@@ -7,6 +7,8 @@ import ProductCollectionService from "../../../../services/product-collection"
  * description: "Retrieves a Product Collection."
  * parameters:
  *   - (path) id=* {string} The id of the Product Collection
+ * x-codegen:
+ *   method: retrieve
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

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

@@ -56,6 +56,9 @@ import { Type } from "class-transformer"
  *            type: string
  *            description: filter by dates greater than or equal to this date
  *            format: date
+ * x-codegen:
+ *   method: list
+ *   queryParams: StoreGetCollectionsParams
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/store/customers/create-address.ts

@@ -17,6 +17,8 @@ import { validator } from "../../../../utils/validator"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/StorePostCustomersCustomerAddressesReq"
+ * x-codegen:
+ *   method: addAddress
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/store/customers/create-customer.ts

@@ -17,6 +17,8 @@ import { validator } from "../../../../utils/validator"
  *     application/json:
  *       schema:
  *         $ref: "#/components/schemas/StorePostCustomersReq"
+ * x-codegen:
+ *   method: create
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/store/customers/delete-address.ts

@@ -11,6 +11,8 @@ import CustomerService from "../../../../services/customer"
  * x-authenticated: true
  * parameters:
  *   - (path) address_id=* {string} The id of the Address to remove.
+ * x-codegen:
+ *   method: deleteAddress
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

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

@@ -7,6 +7,8 @@ import CustomerService from "../../../../services/customer"
  * summary: Get a Customer
  * description: "Retrieves a Customer - the Customer must be logged in to retrieve their details."
  * x-authenticated: true
+ * x-codegen:
+ *   method: retrieve
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client

packages/medusa/src/api/routes/store/customers/get-payment-methods.ts

@@ -9,6 +9,8 @@ import { PaymentProvider } from "../../../../models"
  * 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-codegen:
+ *   method: listPaymentMethods
  * x-codeSamples:
  *   - lang: JavaScript
  *     label: JS Client