docs: Change :id to {id} in OAS comments (#2015)

packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts

@@ -19,12 +19,13 @@ import { Type } from "class-transformer"
 import { pickBy } from "lodash"
 
 /**
- * @oas [get] /price-lists/:id/products
+ * @oas [get] /price-lists/{id}/products
  * operationId: "GetPriceListsPriceListProducts"
  * summary: "List Product in a Price List"
  * description: "Retrieves a list of Product that are part of a Price List"
  * x-authenticated: true
  * parameters:
+ *   - (path) id=* {string} ID of the price list.
  *   - (query) q {string} Query used for searching product title and description, variant title and sku, and collection title.
  *   - (query) id {string} ID of the product to search for.
  *   - in: query

packages/medusa/src/api/routes/admin/tax-rates/add-to-product-types.ts

@@ -1,17 +1,18 @@
 import { IsArray, IsOptional } from "class-validator"
 import { getRetrieveConfig, pickByConfig } from "./utils/get-query-config"
 
+import { EntityManager } from "typeorm"
 import { TaxRate } from "../../../.."
 import { TaxRateService } from "../../../../services"
 import { validator } from "../../../../utils/validator"
-import { EntityManager } from "typeorm"
 
 /**
- * @oas [post] /tax-rates/:id/product-types/batch
+ * @oas [post] /tax-rates/{id}/product-types/batch
  * operationId: "PostTaxRatesTaxRateProductTypes"
  * summary: "Add Tax Rate to Product Types"
  * description: "Associates a Tax Rate with a list of Product Types"
  * parameters:
+ *   - (path) id=* {string} ID of the tax rate.
  *   - in: query
  *     name: fields
  *     description: "Which fields should be included in the result."

packages/medusa/src/api/routes/admin/tax-rates/add-to-products.ts

@@ -1,17 +1,18 @@
 import { IsArray, IsOptional } from "class-validator"
 import { getRetrieveConfig, pickByConfig } from "./utils/get-query-config"
 
+import { EntityManager } from "typeorm"
 import { TaxRate } from "../../../.."
 import { TaxRateService } from "../../../../services"
 import { validator } from "../../../../utils/validator"
-import { EntityManager } from "typeorm"
 
 /**
- * @oas [post] /tax-rates/:id/products/batch
+ * @oas [post] /tax-rates/{id}/products/batch
  * operationId: "PostTaxRatesTaxRateProducts"
  * summary: "Add Tax Rate to Products"
  * description: "Associates a Tax Rate with a list of Products"
  * parameters:
+ *   - (path) id=* {string} ID of the tax rate.
  *   - in: query
  *     name: fields
  *     description: "Which fields should be included in the result."

packages/medusa/src/api/routes/admin/tax-rates/add-to-shipping-options.ts

@@ -1,17 +1,18 @@
 import { IsArray, IsOptional } from "class-validator"
 import { getRetrieveConfig, pickByConfig } from "./utils/get-query-config"
 
+import { EntityManager } from "typeorm"
 import { TaxRate } from "../../../.."
 import { TaxRateService } from "../../../../services"
 import { validator } from "../../../../utils/validator"
-import { EntityManager } from "typeorm"
 
 /**
- * @oas [post] /tax-rates/:id/shipping-options/batch
+ * @oas [post] /tax-rates/{id}/shipping-options/batch
  * operationId: "PostTaxRatesTaxRateShippingOptions"
  * summary: "Add Tax Rate to Product Types"
  * description: "Associates a Tax Rate with a list of Shipping Options"
  * parameters:
+ *   - (path) id=* {string} ID of the tax rate.
  *   - in: query
  *     name: fields
  *     description: "Which fields should be included in the result."

packages/medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts

@@ -6,11 +6,12 @@ import { TaxRateService } from "../../../../services"
 import { validator } from "../../../../utils/validator"
 
 /**
- * @oas [get] /tax-rates/:id
+ * @oas [get] /tax-rates/{id}
  * operationId: "GetTaxRatesTaxRate"
  * summary: "Get Tax Rate"
  * description: "Retrieves a TaxRate"
  * parameters:
+ *   - (path) id=* {string} ID of the tax rate.
  *   - in: query
  *     name: fields
  *     description: "Which fields should be included in the result."

packages/medusa/src/api/routes/admin/tax-rates/remove-from-product-types.ts

@@ -1,17 +1,18 @@
 import { IsArray, IsOptional } from "class-validator"
 import { getRetrieveConfig, pickByConfig } from "./utils/get-query-config"
 
+import { EntityManager } from "typeorm"
 import { TaxRate } from "../../../.."
 import { TaxRateService } from "../../../../services"
 import { validator } from "../../../../utils/validator"
-import { EntityManager } from "typeorm"
 
 /**
- * @oas [delete] /tax-rates/:id/product-types/batch
+ * @oas [delete] /tax-rates/{id}/product-types/batch
  * operationId: "DeleteTaxRatesTaxRateProductTypes"
  * summary: "Remove Tax Rate from Product Types"
  * description: "Removes a Tax Rate from a list of Product Types"
  * parameters:
+ *   - (path) id=* {string} ID of the tax rate.
  *   - in: query
  *     name: fields
  *     description: "Which fields should be included in the result."

packages/medusa/src/api/routes/admin/tax-rates/remove-from-products.ts

@@ -1,17 +1,18 @@
 import { IsArray, IsOptional } from "class-validator"
 import { getRetrieveConfig, pickByConfig } from "./utils/get-query-config"
 
+import { EntityManager } from "typeorm"
 import { TaxRate } from "../../../.."
 import { TaxRateService } from "../../../../services"
 import { validator } from "../../../../utils/validator"
-import { EntityManager } from "typeorm"
 
 /**
- * @oas [delete] /tax-rates/:id/products/batch
+ * @oas [delete] /tax-rates/{id}/products/batch
  * operationId: "DeleteTaxRatesTaxRateProducts"
  * summary: "Removes Tax Rate from Products"
  * description: "Removes a Tax Rate from a list of Products"
  * parameters:
+ *   - (path) id=* {string} ID of the tax rate.
  *   - in: query
  *     name: fields
  *     description: "Which fields should be included in the result."

packages/medusa/src/api/routes/admin/tax-rates/remove-from-shipping-options.ts

@@ -1,17 +1,18 @@
 import { IsArray, IsOptional } from "class-validator"
 import { getRetrieveConfig, pickByConfig } from "./utils/get-query-config"
 
+import { EntityManager } from "typeorm"
 import { TaxRate } from "../../../.."
 import { TaxRateService } from "../../../../services"
 import { validator } from "../../../../utils/validator"
-import { EntityManager } from "typeorm"
 
 /**
- * @oas [delete] /tax-rates/:id/shipping-options/batch
+ * @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"
  * parameters:
+ *   - (path) id=* {string} ID of the tax rate.
  *   - in: query
  *     name: fields
  *     description: "Which fields should be included in the result."

packages/medusa/src/api/routes/admin/tax-rates/update-tax-rate.ts

@@ -9,11 +9,12 @@ import { omit } from "lodash"
 import { validator } from "../../../../utils/validator"
 
 /**
- * @oas [post] /tax-rates/:id
+ * @oas [post] /tax-rates/{id}
  * operationId: "PostTaxRatesTaxRate"
  * summary: "Update a Tax Rate"
  * description: "Updates a Tax Rate"
  * parameters:
+ *   - (path) id=* {string} ID of the tax rate.
  *   - in: query
  *     name: fields
  *     description: "Which fields should be included in the result."