From 7c6521101e8022d5dd70182fdf40bc994251e5f3 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Thu, 15 Sep 2022 16:01:34 +0300 Subject: [PATCH] docs: fixed errors in OAS comments (#2215) --- .../admin/currencies/update-currency.ts | 4 ++-- .../api/routes/admin/regions/update-region.ts | 2 +- .../src/models/custom-shipping-option.ts | 2 +- packages/medusa/src/models/order-edit.ts | 2 +- packages/medusa/src/models/order.ts | 2 +- packages/medusa/src/models/price-list.ts | 5 +++-- scripts/build-openapi.js | 20 +++++++++++++++++++ 7 files changed, 29 insertions(+), 8 deletions(-) diff --git a/packages/medusa/src/api/routes/admin/currencies/update-currency.ts b/packages/medusa/src/api/routes/admin/currencies/update-currency.ts index c91640977f..27b3fc11bb 100644 --- a/packages/medusa/src/api/routes/admin/currencies/update-currency.ts +++ b/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: diff --git a/packages/medusa/src/api/routes/admin/regions/update-region.ts b/packages/medusa/src/api/routes/admin/regions/update-region.ts index a92c757580..c30469a81e 100644 --- a/packages/medusa/src/api/routes/admin/regions/update-region.ts +++ b/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: diff --git a/packages/medusa/src/models/custom-shipping-option.ts b/packages/medusa/src/models/custom-shipping-option.ts index dd779c2338..f0ce57cc05 100644 --- a/packages/medusa/src/models/custom-shipping-option.ts +++ b/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 */ diff --git a/packages/medusa/src/models/order-edit.ts b/packages/medusa/src/models/order-edit.ts index 9150477a6f..5c3343e13c 100644 --- a/packages/medusa/src/models/order-edit.ts +++ b/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 diff --git a/packages/medusa/src/models/order.ts b/packages/medusa/src/models/order.ts index dd7771a075..2268cbc504 100644 --- a/packages/medusa/src/models/order.ts +++ b/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: diff --git a/packages/medusa/src/models/price-list.ts b/packages/medusa/src/models/price-list.ts index 85754723c6..6df5ba4055 100644 --- a/packages/medusa/src/models/price-list.ts +++ b/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" - * $ref: "#/components/schemas/customer_group" + * oneOf: + * - $ref: "#/components/schemas/money_amount" + * - $ref: "#/components/schemas/customer_group" * includes_tax: * description: "[EXPERIMENTAL] Does the price list prices include tax" * type: boolean diff --git a/scripts/build-openapi.js b/scripts/build-openapi.js index 2fd99bffe4..c6bcff1d99 100755 --- a/scripts/build-openapi.js +++ b/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"], @@ -90,4 +105,9 @@ swaggerInline( } else { console.log('No errors occurred while generating Admin API Reference'); } +}) +.catch((err) => { + console.log("Error in admin") + console.error(err) + process.exit(1) }) \ No newline at end of file