docs: fixed errors in OAS comments (#2215)

packages/medusa/src/api/routes/admin/currencies/update-currency.ts

@@ -6,7 +6,7 @@ import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators
 import TaxInclusivePricingFeatureFlag from "../../../../loaders/feature-flags/tax-inclusive-pricing"
 
 /**
- * @oas [post] /currencies/:code
+ * @oas [post] /currencies/{code}
  * operationId: "PostCurrenciesCurrency"
  * summary: "Update a Currency"
  * description: "Update a Currency"
@@ -20,7 +20,7 @@ import TaxInclusivePricingFeatureFlag from "../../../../loaders/feature-flags/ta
  *         properties:
  *           includes_tax:
  *             type: boolean
- *             description: [EXPERIMENTAL] Tax included in prices of currency.
+ *             description: "[EXPERIMENTAL] Tax included in prices of currency."
  * tags:
  *   - Currency
  * responses:

packages/medusa/src/api/routes/admin/regions/update-region.ts

@@ -51,7 +51,7 @@ import { validator } from "../../../../utils/validator"
  *           tax_rate:
  *             description: "The tax rate to use on Orders in the Region."
  *             type: number
- *          includes_tax:
+ *           includes_tax:
  *             description: "[EXPERIMENTAL] Tax included in prices of region"
  *             type: boolean
  *           payment_providers:

packages/medusa/src/models/custom-shipping-option.ts

@@ -92,7 +92,7 @@ export class CustomShippingOption extends SoftDeletableEntity {
  *     type: object
  *     description: An optional key-value map with additional details
  *     example: {car: "white"}
- *  includes_tax:
+ *   includes_tax:
  *     description: "[EXPERIMENTAL] Indicates if the custom shipping option price include tax"
  *     type: boolean
  */

packages/medusa/src/models/order-edit.ts

@@ -97,7 +97,7 @@ export class OrderEdit extends SoftDeletableEntity {
  *     type: array
  *     description: Line item changes array.
  *     items:
- *       $ref: "#/components/schemas/order_item_changes"
+ *       $ref: "#/components/schemas/order_item_change"
  *   internal_note:
  *     description: "An optional note with additional details about the order edit."
  *     type: string

packages/medusa/src/models/order.ts

@@ -449,7 +449,7 @@ export class Order extends BaseEntity {
  *       $ref: "#/components/schemas/line_item"
  *   edits:
  *     type: array
- *     description: [EXPERIMENTAL] Order edits done on the order. Available if the relation `edits` is expanded.
+ *     description: "[EXPERIMENTAL] Order edits done on the order. Available if the relation `edits` is expanded."
  *     items:
  *       $ref: "#/components/schemas/order_edit"
  *   gift_card_transactions:

packages/medusa/src/models/price-list.ts

@@ -122,8 +122,9 @@ export class PriceList extends SoftDeletableEntity {
  *     description: The Money Amounts that are associated with the Price List. Available if the relation `prices` is expanded.
  *     type: array
  *     items:
- *       $ref: "#/components/schemas/money_amount"
+ *       oneOf:
- *       $ref: "#/components/schemas/customer_group"
+ *         - $ref: "#/components/schemas/money_amount"
+ *         - $ref: "#/components/schemas/customer_group"
  *   includes_tax:
  *     description: "[EXPERIMENTAL] Does the price list prices include tax"
  *     type: boolean

scripts/build-openapi.js

@@ -28,6 +28,11 @@ swaggerInline(
       process.exit(1)
     })
 })
+.catch((err) => {
+  console.log("Error in store")
+  console.error(err)
+  process.exit(1)
+});
 
 swaggerInline(
   ["./packages/medusa/src/models", "./packages/medusa/src/api/middlewares" , "./packages/medusa/src/api/routes/store"],
@@ -48,6 +53,11 @@ swaggerInline(
     console.log('No errors occurred while generating Store API Reference');
   }
 })
+.catch((err) => {
+  console.log("Error in store")
+  console.error(err)
+  process.exit(1)
+})
 
 // Admin API
 swaggerInline(
@@ -70,6 +80,11 @@ swaggerInline(
       process.exit(1)
     })
 })
+.catch((err) => {
+  console.log("Error in admin")
+  console.error(err)
+  process.exit(1)
+})
 
 swaggerInline(
   ["./packages/medusa/src/models", "./packages/medusa/src/api/middlewares" , "./packages/medusa/src/api/routes/admin"],
@@ -91,3 +106,8 @@ swaggerInline(
     console.log('No errors occurred while generating Admin API Reference');
   }
 })
+.catch((err) => {
+  console.log("Error in admin")
+  console.error(err)
+  process.exit(1)
+})