From a027d5ff9eb821a1c8728476e4f8bf5f4dd102c8 Mon Sep 17 00:00:00 2001 From: Patrick <116003638+patrick-medusajs@users.noreply.github.com> Date: Tue, 20 Dec 2022 05:58:57 -0500 Subject: [PATCH] chore(oas): PascalCase for schemas + remove x-resourceId (#2847) ### What Rename all JSDoc OAS `@schema` and `$ref: #/components/schemas/` from snake_case to PascalCase, `foo_bar -> FooBar` Extra scope: Remove `x-resourceId` from JSDoc OAS. ### Why Classes use PascalCase as a convention but the OAS @schemas describing them were using snake_case. OAS code generators tend to use the schema name when generating typed models. In order to avoid mismatch between source code, the OAS, and the generated client code, it is advised to align OAS @schemas formatting to the classes they represent. Extra scope: x-resourceId is not a widely used OAS property. It's current usage in our OAS does not provide additional value. Therefore, we recommend to remove it in order to have one less item to maintain. ### How Good old search & replace. Regex search to further make sure we didn't miss any. The scope is limited to `@schema` definition and their usage in `$ref: #/components/schemas/`. ### Test * Ran OAS validator. * Ran docs build script. Expect no visible changes to the documentation. Resolves: CORE-852, CORE-859 --- .changeset/witty-jars-learn.md | 5 + docs/api/admin-spec3-base.yaml | 205 ++++++++---------- docs/api/store-spec3-base.yaml | 114 +++++----- .../src/api/middlewares/await-middleware.ts | 5 +- .../src/api/middlewares/error-handler.ts | 3 +- .../api/routes/admin/auth/create-session.ts | 2 +- .../src/api/routes/admin/auth/get-session.ts | 2 +- .../routes/admin/batch/cancel-batch-job.ts | 2 +- .../routes/admin/batch/confirm-batch-job.ts | 2 +- .../routes/admin/batch/create-batch-job.ts | 2 +- .../api/routes/admin/batch/get-batch-job.ts | 2 +- .../api/routes/admin/batch/list-batch-jobs.ts | 2 +- .../routes/admin/collections/add-products.ts | 2 +- .../admin/collections/create-collection.ts | 2 +- .../admin/collections/get-collection.ts | 3 +- .../admin/collections/list-collections.ts | 2 +- .../admin/collections/update-collection.ts | 2 +- .../admin/currencies/list-currencies.ts | 2 +- .../admin/currencies/update-currency.ts | 2 +- .../customer-groups/add-customers-batch.ts | 2 +- .../customer-groups/create-customer-group.ts | 2 +- .../customer-groups/delete-customers-batch.ts | 2 +- .../get-customer-group-customers.ts | 2 +- .../customer-groups/get-customer-group.ts | 2 +- .../customer-groups/list-customer-groups.ts | 2 +- .../customer-groups/update-customer-group.ts | 2 +- .../routes/admin/customers/create-customer.ts | 2 +- .../routes/admin/customers/get-customer.ts | 2 +- .../routes/admin/customers/list-customers.ts | 2 +- .../routes/admin/customers/update-customer.ts | 2 +- .../api/routes/admin/discounts/add-region.ts | 2 +- .../add-resources-to-condition-batch.ts | 2 +- .../admin/discounts/create-condition.ts | 2 +- .../routes/admin/discounts/create-discount.ts | 6 +- .../admin/discounts/create-dynamic-code.ts | 2 +- .../admin/discounts/delete-condition.ts | 2 +- .../admin/discounts/delete-dynamic-code.ts | 2 +- .../delete-resources-from-condition-batch.ts | 2 +- .../routes/admin/discounts/get-condition.ts | 2 +- .../admin/discounts/get-discount-by-code.ts | 2 +- .../routes/admin/discounts/get-discount.ts | 2 +- .../routes/admin/discounts/list-discounts.ts | 2 +- .../routes/admin/discounts/remove-region.ts | 2 +- .../admin/discounts/update-condition.ts | 2 +- .../routes/admin/discounts/update-discount.ts | 2 +- .../admin/draft-orders/create-draft-order.ts | 7 +- .../admin/draft-orders/create-line-item.ts | 2 +- .../admin/draft-orders/delete-line-item.ts | 2 +- .../admin/draft-orders/get-draft-order.ts | 2 +- .../admin/draft-orders/list-draft-orders.ts | 2 +- .../admin/draft-orders/register-payment.ts | 2 +- .../admin/draft-orders/update-draft-order.ts | 7 +- .../admin/draft-orders/update-line-item.ts | 2 +- .../admin/gift-cards/create-gift-card.ts | 2 +- .../routes/admin/gift-cards/get-gift-card.ts | 2 +- .../admin/gift-cards/list-gift-cards.ts | 2 +- .../admin/gift-cards/update-gift-card.ts | 2 +- .../api/routes/admin/invites/list-invites.ts | 2 +- .../src/api/routes/admin/notes/create-note.ts | 2 +- .../src/api/routes/admin/notes/get-note.ts | 2 +- .../src/api/routes/admin/notes/list-notes.ts | 2 +- .../src/api/routes/admin/notes/update-note.ts | 2 +- .../admin/notifications/list-notifications.ts | 2 +- .../notifications/resend-notification.ts | 5 +- .../routes/admin/order-edits/add-line-item.ts | 6 +- .../admin/order-edits/cancel-order-edit.ts | 2 +- .../admin/order-edits/confirm-order-edit.ts | 2 +- .../admin/order-edits/create-order-edit.ts | 2 +- .../admin/order-edits/delete-line-item.ts | 3 +- .../admin/order-edits/get-order-edit.ts | 2 +- .../admin/order-edits/list-order-edit.ts | 2 +- .../admin/order-edits/request-confirmation.ts | 4 +- .../update-order-edit-line-item.ts | 2 +- .../admin/order-edits/update-order-edit.ts | 2 +- .../admin/orders/add-shipping-method.ts | 2 +- .../api/routes/admin/orders/archive-order.ts | 2 +- .../api/routes/admin/orders/cancel-claim.ts | 2 +- .../admin/orders/cancel-fulfillment-claim.ts | 2 +- .../admin/orders/cancel-fulfillment-swap.ts | 2 +- .../routes/admin/orders/cancel-fulfillment.ts | 2 +- .../api/routes/admin/orders/cancel-order.ts | 2 +- .../api/routes/admin/orders/cancel-swap.ts | 2 +- .../routes/admin/orders/capture-payment.ts | 2 +- .../api/routes/admin/orders/complete-order.ts | 2 +- .../admin/orders/create-claim-shipment.ts | 2 +- .../api/routes/admin/orders/create-claim.ts | 4 +- .../routes/admin/orders/create-fulfillment.ts | 2 +- .../routes/admin/orders/create-shipment.ts | 2 +- .../admin/orders/create-swap-shipment.ts | 2 +- .../api/routes/admin/orders/create-swap.ts | 2 +- .../api/routes/admin/orders/fulfill-claim.ts | 2 +- .../api/routes/admin/orders/fulfill-swap.ts | 2 +- .../src/api/routes/admin/orders/get-order.ts | 2 +- .../api/routes/admin/orders/list-orders.ts | 2 +- .../admin/orders/process-swap-payment.ts | 2 +- .../api/routes/admin/orders/refund-payment.ts | 2 +- .../api/routes/admin/orders/request-return.ts | 2 +- .../api/routes/admin/orders/update-claim.ts | 2 +- .../api/routes/admin/orders/update-order.ts | 12 +- .../get-payment-collection.ts | 2 +- .../mark-authorized-payment-collection.ts | 2 +- .../update-payment-collection.ts | 2 +- .../routes/admin/payments/capture-payment.ts | 2 +- .../api/routes/admin/payments/get-payment.ts | 2 +- .../routes/admin/payments/refund-payment.ts | 2 +- .../admin/price-lists/add-prices-batch.ts | 2 +- .../admin/price-lists/create-price-list.ts | 2 +- .../admin/price-lists/get-price-list.ts | 2 +- .../price-lists/list-price-list-products.ts | 2 +- .../admin/price-lists/list-price-lists.ts | 2 +- .../admin/price-lists/update-price-list.ts | 2 +- .../admin/product-tags/list-product-tags.ts | 2 +- .../admin/product-types/list-product-types.ts | 2 +- .../api/routes/admin/products/add-option.ts | 2 +- .../routes/admin/products/create-product.ts | 2 +- .../routes/admin/products/create-variant.ts | 2 +- .../routes/admin/products/delete-option.ts | 2 +- .../routes/admin/products/delete-variant.ts | 2 +- .../api/routes/admin/products/get-product.ts | 2 +- .../routes/admin/products/list-products.ts | 2 +- .../api/routes/admin/products/list-types.ts | 2 +- .../routes/admin/products/list-variants.ts | 2 +- .../api/routes/admin/products/set-metadata.ts | 2 +- .../routes/admin/products/update-option.ts | 2 +- .../routes/admin/products/update-product.ts | 2 +- .../routes/admin/products/update-variant.ts | 2 +- .../add-channels-batch.ts | 2 +- .../create-publishable-api-key.ts | 2 +- .../delete-channels-batch.ts | 2 +- .../get-publishable-api-key.ts | 2 +- ...list-publishable-api-key-sales-channels.ts | 2 +- .../list-publishable-api-keys.ts | 2 +- .../revoke-publishable-api-key.ts | 2 +- .../update-publishable-api-key.ts | 2 +- .../api/routes/admin/regions/add-country.ts | 2 +- .../admin/regions/add-fulfillment-provider.ts | 2 +- .../admin/regions/add-payment-provider.ts | 2 +- .../api/routes/admin/regions/create-region.ts | 2 +- .../api/routes/admin/regions/get-region.ts | 2 +- .../api/routes/admin/regions/list-regions.ts | 2 +- .../routes/admin/regions/remove-country.ts | 2 +- .../regions/remove-fulfillment-provider.ts | 2 +- .../admin/regions/remove-payment-provider.ts | 2 +- .../api/routes/admin/regions/update-region.ts | 2 +- .../admin/return-reasons/create-reason.ts | 2 +- .../routes/admin/return-reasons/get-reason.ts | 2 +- .../admin/return-reasons/list-reasons.ts | 4 +- .../admin/return-reasons/update-reason.ts | 2 +- .../api/routes/admin/returns/cancel-return.ts | 2 +- .../api/routes/admin/returns/list-returns.ts | 2 +- .../routes/admin/returns/receive-return.ts | 2 +- .../admin/sales-channels/add-product-batch.ts | 2 +- .../sales-channels/create-sales-channel.ts | 2 +- .../sales-channels/delete-products-batch.ts | 2 +- .../admin/sales-channels/get-sales-channel.ts | 2 +- .../sales-channels/list-sales-channels.ts | 2 +- .../sales-channels/update-sales-channel.ts | 2 +- .../create-shipping-option.ts | 2 +- .../shipping-options/get-shipping-option.ts | 2 +- .../shipping-options/list-shipping-options.ts | 2 +- .../update-shipping-option.ts | 2 +- .../create-shipping-profile.ts | 2 +- .../shipping-profiles/get-shipping-profile.ts | 2 +- .../list-shipping-profiles.ts | 2 +- .../update-shipping-profile.ts | 2 +- .../api/routes/admin/store/add-currency.ts | 3 +- .../src/api/routes/admin/store/get-store.ts | 2 +- .../admin/store/list-payment-providers.ts | 3 +- .../routes/admin/store/list-tax-providers.ts | 2 +- .../api/routes/admin/store/remove-currency.ts | 2 +- .../api/routes/admin/store/update-store.ts | 2 +- .../src/api/routes/admin/swaps/get-swap.ts | 2 +- .../src/api/routes/admin/swaps/list-swaps.ts | 2 +- .../admin/tax-rates/add-to-product-types.ts | 2 +- .../routes/admin/tax-rates/add-to-products.ts | 2 +- .../tax-rates/add-to-shipping-options.ts | 2 +- .../routes/admin/tax-rates/create-tax-rate.ts | 2 +- .../routes/admin/tax-rates/get-tax-rate.ts | 2 +- .../routes/admin/tax-rates/list-tax-rates.ts | 2 +- .../tax-rates/remove-from-product-types.ts | 2 +- .../admin/tax-rates/remove-from-products.ts | 2 +- .../tax-rates/remove-from-shipping-options.ts | 2 +- .../routes/admin/tax-rates/update-tax-rate.ts | 2 +- .../src/api/routes/admin/users/create-user.ts | 2 +- .../src/api/routes/admin/users/get-user.ts | 2 +- .../src/api/routes/admin/users/list-users.ts | 2 +- .../api/routes/admin/users/reset-password.ts | 3 +- .../src/api/routes/admin/users/update-user.ts | 2 +- .../routes/admin/variants/list-variants.ts | 2 +- .../api/routes/store/auth/create-session.ts | 2 +- .../src/api/routes/store/auth/get-session.ts | 2 +- .../routes/store/carts/add-shipping-method.ts | 2 +- .../api/routes/store/carts/calculate-taxes.ts | 2 +- .../api/routes/store/carts/complete-cart.ts | 6 +- .../src/api/routes/store/carts/create-cart.ts | 2 +- .../store/carts/create-line-item/index.ts | 2 +- .../store/carts/create-payment-sessions.ts | 2 +- .../api/routes/store/carts/delete-discount.ts | 2 +- .../routes/store/carts/delete-line-item.ts | 2 +- .../store/carts/delete-payment-session.ts | 2 +- .../src/api/routes/store/carts/get-cart.ts | 2 +- .../store/carts/refresh-payment-session.ts | 2 +- .../routes/store/carts/set-payment-session.ts | 2 +- .../src/api/routes/store/carts/update-cart.ts | 6 +- .../routes/store/carts/update-line-item.ts | 2 +- .../store/carts/update-payment-session.ts | 2 +- .../store/collections/get-collection.ts | 3 +- .../store/collections/list-collections.ts | 2 +- .../routes/store/customers/create-address.ts | 4 +- .../routes/store/customers/create-customer.ts | 2 +- .../routes/store/customers/delete-address.ts | 2 +- .../routes/store/customers/get-customer.ts | 2 +- .../api/routes/store/customers/list-orders.ts | 2 +- .../routes/store/customers/reset-password.ts | 2 +- .../routes/store/customers/update-address.ts | 4 +- .../routes/store/customers/update-customer.ts | 4 +- .../routes/store/gift-cards/get-gift-card.ts | 2 +- .../store/order-edits/complete-order-edit.ts | 2 +- .../store/order-edits/decline-order-edit.ts | 2 +- .../store/order-edits/get-order-edit.ts | 2 +- .../routes/store/orders/get-order-by-cart.ts | 2 +- .../src/api/routes/store/orders/get-order.ts | 2 +- .../api/routes/store/orders/lookup-order.ts | 2 +- .../authorize-batch-payment-sessions.ts | 2 +- .../authorize-payment-session.ts | 2 +- .../get-payment-collection.ts | 2 +- .../manage-batch-payment-sessions.ts | 2 +- .../manage-payment-session.ts | 2 +- .../refresh-payment-session.ts | 4 +- .../store/product-types/list-product-types.ts | 2 +- .../api/routes/store/products/get-product.ts | 10 +- .../routes/store/products/list-products.ts | 6 +- .../api/routes/store/regions/get-region.ts | 3 +- .../api/routes/store/regions/list-regions.ts | 2 +- .../routes/store/return-reasons/get-reason.ts | 2 +- .../store/return-reasons/list-reasons.ts | 2 +- .../api/routes/store/returns/create-return.ts | 2 +- .../store/shipping-options/list-options.ts | 2 +- .../shipping-options/list-shipping-options.ts | 2 +- .../src/api/routes/store/swaps/create-swap.ts | 2 +- .../routes/store/swaps/get-swap-by-cart.ts | 3 +- .../api/routes/store/variants/get-variant.ts | 4 +- .../routes/store/variants/list-variants.ts | 4 +- packages/medusa/src/models/address.ts | 8 +- packages/medusa/src/models/batch-job.ts | 18 +- packages/medusa/src/models/cart.ts | 17 +- packages/medusa/src/models/claim-image.ts | 3 +- packages/medusa/src/models/claim-item.ts | 9 +- packages/medusa/src/models/claim-order.ts | 13 +- packages/medusa/src/models/claim-tag.ts | 3 +- packages/medusa/src/models/country.ts | 3 +- packages/medusa/src/models/currency.ts | 3 +- .../src/models/custom-shipping-option.ts | 3 +- packages/medusa/src/models/customer-group.ts | 7 +- packages/medusa/src/models/customer.ts | 9 +- .../discount-condition-customer-group.ts | 7 +- .../discount-condition-product-collection.ts | 7 +- .../models/discount-condition-product-tag.ts | 7 +- .../models/discount-condition-product-type.ts | 7 +- .../src/models/discount-condition-product.ts | 7 +- .../medusa/src/models/discount-condition.ts | 5 +- packages/medusa/src/models/discount-rule.ts | 3 +- packages/medusa/src/models/discount.ts | 7 +- packages/medusa/src/models/draft-order.ts | 3 +- .../medusa/src/models/fulfillment-item.ts | 5 +- .../medusa/src/models/fulfillment-provider.ts | 3 +- packages/medusa/src/models/fulfillment.ts | 9 +- .../src/models/gift-card-transaction.ts | 3 +- packages/medusa/src/models/gift-card.ts | 3 +- packages/medusa/src/models/idempotency-key.ts | 5 +- packages/medusa/src/models/image.ts | 3 +- packages/medusa/src/models/invite.ts | 3 +- .../medusa/src/models/line-item-adjustment.ts | 9 +- .../medusa/src/models/line-item-tax-line.ts | 7 +- packages/medusa/src/models/line-item.ts | 7 +- packages/medusa/src/models/money-amount.ts | 7 +- packages/medusa/src/models/note.ts | 5 +- .../src/models/notification-provider.ts | 3 +- packages/medusa/src/models/notification.ts | 14 +- packages/medusa/src/models/oauth.ts | 1 - packages/medusa/src/models/order-edit.ts | 11 +- .../medusa/src/models/order-item-change.ts | 9 +- packages/medusa/src/models/order.ts | 21 +- .../medusa/src/models/payment-collection.ts | 11 +- .../medusa/src/models/payment-provider.ts | 3 +- packages/medusa/src/models/payment-session.ts | 13 +- packages/medusa/src/models/payment.ts | 5 +- packages/medusa/src/models/price-list.ts | 9 +- .../medusa/src/models/product-collection.ts | 3 +- .../medusa/src/models/product-option-value.ts | 7 +- packages/medusa/src/models/product-option.ts | 5 +- packages/medusa/src/models/product-tag.ts | 3 +- .../medusa/src/models/product-tax-rate.ts | 7 +- .../src/models/product-type-tax-rate.ts | 7 +- packages/medusa/src/models/product-type.ts | 3 +- packages/medusa/src/models/product-variant.ts | 14 +- packages/medusa/src/models/product.ts | 15 +- .../publishable-api-key-sales-channel.ts | 3 +- .../medusa/src/models/publishable-api-key.ts | 3 +- packages/medusa/src/models/refund.ts | 3 +- packages/medusa/src/models/region.ts | 15 +- packages/medusa/src/models/return-item.ts | 9 +- packages/medusa/src/models/return-reason.ts | 7 +- packages/medusa/src/models/return.ts | 7 +- packages/medusa/src/models/sales-channel.ts | 5 +- .../src/models/shipping-method-tax-line.ts | 7 +- packages/medusa/src/models/shipping-method.ts | 7 +- .../src/models/shipping-option-requirement.ts | 5 +- packages/medusa/src/models/shipping-option.ts | 9 +- .../medusa/src/models/shipping-profile.ts | 5 +- .../medusa/src/models/shipping-tax-rate.ts | 7 +- packages/medusa/src/models/staged-job.ts | 5 +- packages/medusa/src/models/store.ts | 7 +- packages/medusa/src/models/swap.ts | 13 +- packages/medusa/src/models/tax-line.ts | 3 +- packages/medusa/src/models/tax-provider.ts | 3 +- packages/medusa/src/models/tax-rate.ts | 3 +- packages/medusa/src/models/tracking-link.ts | 5 +- packages/medusa/src/models/user.ts | 3 +- 319 files changed, 654 insertions(+), 747 deletions(-) create mode 100644 .changeset/witty-jars-learn.md diff --git a/.changeset/witty-jars-learn.md b/.changeset/witty-jars-learn.md new file mode 100644 index 0000000000..36b558a5b5 --- /dev/null +++ b/.changeset/witty-jars-learn.md @@ -0,0 +1,5 @@ +--- +"@medusajs/medusa": patch +--- + +chore(oas): PascalCase for schemas + remove x-resourceId diff --git a/docs/api/admin-spec3-base.yaml b/docs/api/admin-spec3-base.yaml index d96907f12a..3253d88df8 100644 --- a/docs/api/admin-spec3-base.yaml +++ b/docs/api/admin-spec3-base.yaml @@ -55,111 +55,82 @@ info: name: MIT url: https://github.com/medusajs/medusa/blob/master/LICENSE tags: -- name: Auth - description: Auth endpoints that allow authorization of admin Users and manages - their sessions. -- name: App - description: App endpoints that allow handling apps in Medusa. - x-resourceId: OAuth -- name: Batch Job - description: Batch Job endpoints that allow handling batch jobs in Medusa. - x-resourceId: batch_job -- name: Claim - description: Claim endpoints that allow handling claims in Medusa. - x-resourceId: claim_order -- name: Collection - description: Collection endpoints that allow handling collections in Medusa. - x-resourceId: product_collection -- name: Customer - description: Customer endpoints that allow handling customers in Medusa. - x-resourceId: customer -- name: Customer Group - description: Customer Group endpoints that allow handling customer groups in Medusa. - x-resourceId: customer_group -- name: Discount - description: Discount endpoints that allow handling discounts in Medusa. - x-resourceId: discount -- name: Discount Condition - description: Discount Condition endpoints that allow handling discount conditions - in Medusa. - x-resourceId: discount_condition -- name: Draft Order - description: Draft Order endpoints that allow handling draft orders in Medusa. - x-resourceId: draft-order -- name: Gift Card - description: Gift Card endpoints that allow handling gift cards in Medusa. - x-resourceId: gift_card -- name: Invite - description: Invite endpoints that allow handling invites in Medusa. - x-resourceId: invite -- name: Note - description: Note endpoints that allow handling notes in Medusa. - x-resourceId: note -- name: Notification - description: Notification endpoints that allow handling notifications in Medusa. - x-resourceId: notification -- name: Order - description: Order endpoints that allow handling orders in Medusa. - x-resourceId: order -- name: Price List - description: Price List endpoints that allow handling price lists in Medusa. - x-resourceId: price_list -- name: Product - description: Product endpoints that allow handling products in Medusa. - x-resourceId: product -- name: Product Tag - description: Product Tag endpoints that allow handling product tags in Medusa. - x-resourceId: product_tag -- name: Product Type - description: Product Types endpoints that allow handling product types in Medusa. - x-resourceId: product_type -- name: Product Variant - description: Product Variant endpoints that allow handling product variants in Medusa. - x-resourceId: product_variant -- name: Region - description: Region endpoints that allow handling regions in Medusa. - x-resourceId: region -- name: Return Reason - description: Return Reason endpoints that allow handling return reasons in Medusa. - x-resourceId: return_reason -- name: Return - description: Return endpoints that allow handling returns in Medusa. - x-resourceId: return -- name: Sales Channel - description: Sales Channel endpoints that allow handling sales channels in Medusa. - x-resourceId: sales_channel -- name: Shipping Option - description: Shipping Option endpoints that allow handling shipping options in Medusa. - x-resourceId: shipping_option -- name: Shipping Profile - description: Shipping Profile endpoints that allow handling shipping profiles in - Medusa. - x-resourceId: shipping_profile -- name: Store - description: Store endpoints that allow handling stores in Medusa. - x-resourceId: store -- name: Swap - description: Swap endpoints that allow handling swaps in Medusa. - x-resourceId: swap -- name: Tax Rate - description: Tax Rate endpoints that allow handling tax rates in Medusa. - x-resourceId: tax_rate -- name: Upload - description: Upload endpoints that allow handling uploads in Medusa. -- name: User - description: User endpoints that allow handling users in Medusa. - x-resourceId: user + - name: Auth + description: Auth endpoints that allow authorization of admin Users and manages + their sessions. + - name: App + description: App endpoints that allow handling apps in Medusa. + - name: Batch Job + description: Batch Job endpoints that allow handling batch jobs in Medusa. + - name: Claim + description: Claim endpoints that allow handling claims in Medusa. + - name: Collection + description: Collection endpoints that allow handling collections in Medusa. + - name: Customer + description: Customer endpoints that allow handling customers in Medusa. + - name: Customer Group + description: Customer Group endpoints that allow handling customer groups in Medusa. + - name: Discount + description: Discount endpoints that allow handling discounts in Medusa. + - name: Discount Condition + description: Discount Condition endpoints that allow handling discount conditions + in Medusa. + - name: Draft Order + description: Draft Order endpoints that allow handling draft orders in Medusa. + - name: Gift Card + description: Gift Card endpoints that allow handling gift cards in Medusa. + - name: Invite + description: Invite endpoints that allow handling invites in Medusa. + - name: Note + description: Note endpoints that allow handling notes in Medusa. + - name: Notification + description: Notification endpoints that allow handling notifications in Medusa. + - name: Order + description: Order endpoints that allow handling orders in Medusa. + - name: Price List + description: Price List endpoints that allow handling price lists in Medusa. + - name: Product + description: Product endpoints that allow handling products in Medusa. + - name: Product Tag + description: Product Tag endpoints that allow handling product tags in Medusa. + - name: Product Type + description: Product Types endpoints that allow handling product types in Medusa. + - name: Product Variant + description: Product Variant endpoints that allow handling product variants in Medusa. + - name: Region + description: Region endpoints that allow handling regions in Medusa. + - name: Return Reason + description: Return Reason endpoints that allow handling return reasons in Medusa. + - name: Return + description: Return endpoints that allow handling returns in Medusa. + - name: Sales Channel + description: Sales Channel endpoints that allow handling sales channels in Medusa. + - name: Shipping Option + description: Shipping Option endpoints that allow handling shipping options in Medusa. + - name: Shipping Profile + description: Shipping Profile endpoints that allow handling shipping profiles in + Medusa. + - name: Store + description: Store endpoints that allow handling stores in Medusa. + - name: Swap + description: Swap endpoints that allow handling swaps in Medusa. + - name: Tax Rate + description: Tax Rate endpoints that allow handling tax rates in Medusa. + - name: Upload + description: Upload endpoints that allow handling uploads in Medusa. + - name: User + description: User endpoints that allow handling users in Medusa. servers: -- url: https://api.medusa-commerce.com/admin -paths: {} + - url: https://api.medusa-commerce.com/admin +paths: { } components: - responses: + responses: default_error: description: Default Error content: application/json: - schema: - $ref: "#/components/schemas/error" + schema: + $ref: "#/components/schemas/Error" example: code: "unknown_error" message: "An unknown error occurred." @@ -168,8 +139,8 @@ components: description: Invalid State Error content: application/json: - schema: - $ref: "#/components/schemas/error" + schema: + $ref: "#/components/schemas/Error" example: code: "unknown_error" message: "The request conflicted with another request. You may retry the request with the provided Idempotency-Key." @@ -178,8 +149,8 @@ components: description: Invalid Request Error content: application/json: - schema: - $ref: "#/components/schemas/error" + schema: + $ref: "#/components/schemas/Error" example: code: "invalid_request_error" message: "Discount with code TEST already exists." @@ -188,8 +159,8 @@ components: description: Not Found Error content: application/json: - schema: - $ref: "#/components/schemas/error" + schema: + $ref: "#/components/schemas/Error" example: message: "Entity with id 1 was not found" type: "not_found" @@ -198,23 +169,23 @@ components: content: application/json: schema: - oneOf: - - $ref: "#/components/schemas/error" - - $ref: "#/components/schemas/multiple_errors" - examples: + oneOf: + - $ref: "#/components/schemas/Error" + - $ref: "#/components/schemas/MultipleErrors" + examples: not_allowed: $ref: "#/components/examples/not_allowed_error" invalid_data: $ref: "#/components/examples/invalid_data_error" - multiple_errors: + MultipleErrors: $ref: "#/components/examples/multiple_errors" 500_error: description: Server Error content: application/json: - schema: - $ref: "#/components/schemas/error" - examples: + schema: + $ref: "#/components/schemas/Error" + examples: database: $ref: "#/components/examples/database_error" unexpected_state: @@ -225,17 +196,17 @@ components: $ref: "#/components/examples/default_error" unauthorized: description: 'User is not authorized. Must log in first' - content: + content: text/plain: - schema: + schema: type: string default: Unauthorized example: Unauthorized incorrect_credentials: description: 'User does not exist or incorrect credentials' - content: + content: text/plain: - schema: + schema: type: string default: Unauthorized example: Unauthorized diff --git a/docs/api/store-spec3-base.yaml b/docs/api/store-spec3-base.yaml index c21ebfacdd..01978d36e0 100644 --- a/docs/api/store-spec3-base.yaml +++ b/docs/api/store-spec3-base.yaml @@ -50,61 +50,49 @@ info: `count` is the total number of available items of this entity. It can be used to determine how many pages are there. For example, if the `count` is 100 and the `limit` is 50, you can divide the `count` by the `limit` to get the number of pages: `100/50 = 2 pages`. - + license: name: MIT url: https://github.com/medusajs/medusa/blob/master/LICENSE tags: -- name: Auth - description: Auth endpoints that allow authorization of customers and manages their - sessions. -- name: Cart - description: Cart endpoints that allow handling carts in Medusa. - x-resourceId: cart -- name: Collection - description: Collection endpoints that allow handling collections in Medusa. - x-resourceId: product_collection -- name: Customer - description: Customer endpoints that allow handling customers in Medusa. - x-resourceId: customer -- name: Gift Card - description: Gift Card endpoints that allow handling gift cards in Medusa. - x-resourceId: gift_card -- name: Order - description: Order endpoints that allow handling orders in Medusa. - x-resourceId: order -- name: Product - description: Product endpoints that allow handling products in Medusa. - x-resourceId: product -- name: Product Variant - description: Product Variant endpoints that allow handling product variants in Medusa. - x-resourceId: product_variant -- name: Region - description: Region endpoints that allow handling regions in Medusa. - x-resourceId: region -- name: Return Reason - description: Return Reason endpoints that allow handling return reasons in Medusa. - x-resourceId: return_reason -- name: Return - description: Return endpoints that allow handling returns in Medusa. - x-resourceId: return -- name: Shipping Option - description: Shipping Option endpoints that allow handling shipping options in Medusa. - x-resourceId: shipping_option -- name: Swap - description: Swap endpoints that allow handling swaps in Medusa. - x-resourceId: swap + - name: Auth + description: Auth endpoints that allow authorization of customers and manages their + sessions. + - name: Cart + description: Cart endpoints that allow handling carts in Medusa. + - name: Collection + description: Collection endpoints that allow handling collections in Medusa. + - name: Customer + description: Customer endpoints that allow handling customers in Medusa. + - name: Gift Card + description: Gift Card endpoints that allow handling gift cards in Medusa. + - name: Order + description: Order endpoints that allow handling orders in Medusa. + - name: Product + description: Product endpoints that allow handling products in Medusa. + - name: Product Variant + description: Product Variant endpoints that allow handling product variants in Medusa. + - name: Region + description: Region endpoints that allow handling regions in Medusa. + - name: Return Reason + description: Return Reason endpoints that allow handling return reasons in Medusa. + - name: Return + description: Return endpoints that allow handling returns in Medusa. + - name: Shipping Option + description: Shipping Option endpoints that allow handling shipping options in Medusa. + - name: Swap + description: Swap endpoints that allow handling swaps in Medusa. servers: -- url: https://api.medusa-commerce.com/store -paths: {} + - url: https://api.medusa-commerce.com/store +paths: { } components: - responses: + responses: default_error: description: Default Error content: application/json: - schema: - $ref: "#/components/schemas/error" + schema: + $ref: "#/components/schemas/Error" example: code: "unknown_error" message: "An unknown error occurred." @@ -113,8 +101,8 @@ components: description: Invalid State Error content: application/json: - schema: - $ref: "#/components/schemas/error" + schema: + $ref: "#/components/schemas/Error" example: code: "unknown_error" message: "The request conflicted with another request. You may retry the request with the provided Idempotency-Key." @@ -123,8 +111,8 @@ components: description: Invalid Request Error content: application/json: - schema: - $ref: "#/components/schemas/error" + schema: + $ref: "#/components/schemas/Error" example: code: "invalid_request_error" message: "Discount with code TEST already exists." @@ -133,8 +121,8 @@ components: description: Not Found Error content: application/json: - schema: - $ref: "#/components/schemas/error" + schema: + $ref: "#/components/schemas/Error" example: message: "Entity with id 1 was not found" type: "not_found" @@ -143,23 +131,23 @@ components: content: application/json: schema: - oneOf: - - $ref: "#/components/schemas/error" - - $ref: "#/components/schemas/multiple_errors" - examples: + oneOf: + - $ref: "#/components/schemas/Error" + - $ref: "#/components/schemas/MultipleErrors" + examples: not_allowed: $ref: "#/components/examples/not_allowed_error" invalid_data: $ref: "#/components/examples/invalid_data_error" - multiple_errors: + MultipleErrors: $ref: "#/components/examples/multiple_errors" 500_error: description: Server Error content: application/json: - schema: - $ref: "#/components/schemas/error" - examples: + schema: + $ref: "#/components/schemas/Error" + examples: database: $ref: "#/components/examples/database_error" unexpected_state: @@ -170,17 +158,17 @@ components: $ref: "#/components/examples/default_error" unauthorized: description: 'User is not authorized. Must log in first' - content: + content: text/plain: - schema: + schema: type: string default: Unauthorized example: Unauthorized incorrect_credentials: description: 'User does not exist or incorrect credentials' - content: + content: text/plain: - schema: + schema: type: string default: Unauthorized example: Unauthorized diff --git a/packages/medusa/src/api/middlewares/await-middleware.ts b/packages/medusa/src/api/middlewares/await-middleware.ts index 3100e549e7..5e9f728219 100644 --- a/packages/medusa/src/api/middlewares/await-middleware.ts +++ b/packages/medusa/src/api/middlewares/await-middleware.ts @@ -17,16 +17,15 @@ export default (fn: handler): RequestHandler => { } /** - * @schema multiple_errors + * @schema MultipleErrors * title: "Multiple Errors" - * x-resourceId: multiple_errors * type: object * properties: * errors: * type: array * description: Array of errors * items: - * $ref: "#/components/schemas/error" + * $ref: "#/components/schemas/Error" * message: * type: string * default: "Provided request body contains errors. Please check the data and retry the request" diff --git a/packages/medusa/src/api/middlewares/error-handler.ts b/packages/medusa/src/api/middlewares/error-handler.ts index 382544e009..ccb2727e02 100644 --- a/packages/medusa/src/api/middlewares/error-handler.ts +++ b/packages/medusa/src/api/middlewares/error-handler.ts @@ -79,9 +79,8 @@ export default () => { } /** - * @schema error + * @schema Error * title: "Response Error" - * x-resourceId: error * type: object * properties: * code: diff --git a/packages/medusa/src/api/routes/admin/auth/create-session.ts b/packages/medusa/src/api/routes/admin/auth/create-session.ts index 2c24b5cd65..49dfc11f83 100644 --- a/packages/medusa/src/api/routes/admin/auth/create-session.ts +++ b/packages/medusa/src/api/routes/admin/auth/create-session.ts @@ -65,7 +65,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * user: - * $ref: "#/components/schemas/user" + * $ref: "#/components/schemas/User" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/auth/get-session.ts b/packages/medusa/src/api/routes/admin/auth/get-session.ts index dd383667f5..c317076d83 100644 --- a/packages/medusa/src/api/routes/admin/auth/get-session.ts +++ b/packages/medusa/src/api/routes/admin/auth/get-session.ts @@ -37,7 +37,7 @@ import _ from "lodash" * type: object * properties: * user: - * $ref: "#/components/schemas/user" + * $ref: "#/components/schemas/User" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/batch/cancel-batch-job.ts b/packages/medusa/src/api/routes/admin/batch/cancel-batch-job.ts index 7dfac999d1..20aa04559e 100644 --- a/packages/medusa/src/api/routes/admin/batch/cancel-batch-job.ts +++ b/packages/medusa/src/api/routes/admin/batch/cancel-batch-job.ts @@ -39,7 +39,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * batch_job: - * $ref: "#/components/schemas/batch_job" + * $ref: "#/components/schemas/BatchJob" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/batch/confirm-batch-job.ts b/packages/medusa/src/api/routes/admin/batch/confirm-batch-job.ts index d5810e08f6..c39295e6e8 100644 --- a/packages/medusa/src/api/routes/admin/batch/confirm-batch-job.ts +++ b/packages/medusa/src/api/routes/admin/batch/confirm-batch-job.ts @@ -39,7 +39,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * batch_job: - * $ref: "#/components/schemas/batch_job" + * $ref: "#/components/schemas/BatchJob" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/batch/create-batch-job.ts b/packages/medusa/src/api/routes/admin/batch/create-batch-job.ts index 73545349ee..42400caf74 100644 --- a/packages/medusa/src/api/routes/admin/batch/create-batch-job.ts +++ b/packages/medusa/src/api/routes/admin/batch/create-batch-job.ts @@ -85,7 +85,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * batch_job: - * $ref: "#/components/schemas/batch_job" + * $ref: "#/components/schemas/BatchJob" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/batch/get-batch-job.ts b/packages/medusa/src/api/routes/admin/batch/get-batch-job.ts index 3938c0b20b..06ae5e3015 100644 --- a/packages/medusa/src/api/routes/admin/batch/get-batch-job.ts +++ b/packages/medusa/src/api/routes/admin/batch/get-batch-job.ts @@ -36,7 +36,7 @@ * type: object * properties: * batch_job: - * $ref: "#/components/schemas/batch_job" + * $ref: "#/components/schemas/BatchJob" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/batch/list-batch-jobs.ts b/packages/medusa/src/api/routes/admin/batch/list-batch-jobs.ts index 3461b71a03..32094e4de4 100644 --- a/packages/medusa/src/api/routes/admin/batch/list-batch-jobs.ts +++ b/packages/medusa/src/api/routes/admin/batch/list-batch-jobs.ts @@ -242,7 +242,7 @@ import { isDefined } from "medusa-core-utils" * batch_jobs: * type: array * items: - * $ref: "#/components/schemas/batch_job" + * $ref: "#/components/schemas/BatchJob" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/collections/add-products.ts b/packages/medusa/src/api/routes/admin/collections/add-products.ts index 095ed60539..104a8d61c7 100644 --- a/packages/medusa/src/api/routes/admin/collections/add-products.ts +++ b/packages/medusa/src/api/routes/admin/collections/add-products.ts @@ -52,7 +52,7 @@ import ProductCollectionService from "../../../../services/product-collection" * type: object * properties: * collection: - * $ref: "#/components/schemas/product_collection" + * $ref: "#/components/schemas/ProductCollection" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/collections/create-collection.ts b/packages/medusa/src/api/routes/admin/collections/create-collection.ts index 4c4af4cb4b..c24be158b8 100644 --- a/packages/medusa/src/api/routes/admin/collections/create-collection.ts +++ b/packages/medusa/src/api/routes/admin/collections/create-collection.ts @@ -62,7 +62,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * collection: - * $ref: "#/components/schemas/product_collection" + * $ref: "#/components/schemas/ProductCollection" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/collections/get-collection.ts b/packages/medusa/src/api/routes/admin/collections/get-collection.ts index f781e1ac73..300928f025 100644 --- a/packages/medusa/src/api/routes/admin/collections/get-collection.ts +++ b/packages/medusa/src/api/routes/admin/collections/get-collection.ts @@ -2,6 +2,7 @@ import { Request, Response } from "express" import ProductCollectionService from "../../../../services/product-collection" import { defaultAdminCollectionsRelations } from "." + /** * @oas [get] /collections/{id} * operationId: "GetCollectionsCollection" @@ -40,7 +41,7 @@ import { defaultAdminCollectionsRelations } from "." * type: object * properties: * collection: - * $ref: "#/components/schemas/product_collection" + * $ref: "#/components/schemas/ProductCollection" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/collections/list-collections.ts b/packages/medusa/src/api/routes/admin/collections/list-collections.ts index c9e11021e0..a44ae23df1 100644 --- a/packages/medusa/src/api/routes/admin/collections/list-collections.ts +++ b/packages/medusa/src/api/routes/admin/collections/list-collections.ts @@ -116,7 +116,7 @@ import { Type } from "class-transformer" * collections: * type: array * items: - * $ref: "#/components/schemas/product_collection" + * $ref: "#/components/schemas/ProductCollection" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/collections/update-collection.ts b/packages/medusa/src/api/routes/admin/collections/update-collection.ts index 85c1141687..105ae7e1a5 100644 --- a/packages/medusa/src/api/routes/admin/collections/update-collection.ts +++ b/packages/medusa/src/api/routes/admin/collections/update-collection.ts @@ -62,7 +62,7 @@ import ProductCollectionService from "../../../../services/product-collection" * type: object * properties: * collection: - * $ref: "#/components/schemas/product_collection" + * $ref: "#/components/schemas/ProductCollection" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/currencies/list-currencies.ts b/packages/medusa/src/api/routes/admin/currencies/list-currencies.ts index adf6180113..2921525879 100644 --- a/packages/medusa/src/api/routes/admin/currencies/list-currencies.ts +++ b/packages/medusa/src/api/routes/admin/currencies/list-currencies.ts @@ -47,7 +47,7 @@ import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators * currencies: * type: array * items: - * $ref: "#/components/schemas/currency" + * $ref: "#/components/schemas/Currency" * count: * type: integer * description: The total number of items available 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 e052db3066..fd9e2ab34b 100644 --- a/packages/medusa/src/api/routes/admin/currencies/update-currency.ts +++ b/packages/medusa/src/api/routes/admin/currencies/update-currency.ts @@ -55,7 +55,7 @@ import TaxInclusivePricingFeatureFlag from "../../../../loaders/feature-flags/ta * type: object * properties: * currency: - * $ref: "#/components/schemas/currency" + * $ref: "#/components/schemas/Currency" */ export default async (req: ExtendedRequest, res) => { const code = req.params.code as string diff --git a/packages/medusa/src/api/routes/admin/customer-groups/add-customers-batch.ts b/packages/medusa/src/api/routes/admin/customer-groups/add-customers-batch.ts index 07d423b9bf..ff0c06de89 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/add-customers-batch.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/add-customers-batch.ts @@ -77,7 +77,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * customer_group: - * $ref: "#/components/schemas/customer_group" + * $ref: "#/components/schemas/CustomerGroup" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts index 323a1028bd..2f4c488d84 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/create-customer-group.ts @@ -50,7 +50,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * customer_group: - * $ref: "#/components/schemas/customer_group" + * $ref: "#/components/schemas/CustomerGroup" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/customer-groups/delete-customers-batch.ts b/packages/medusa/src/api/routes/admin/customer-groups/delete-customers-batch.ts index cdfd0938df..7f9aede0a6 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/delete-customers-batch.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/delete-customers-batch.ts @@ -77,7 +77,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * customer_group: - * $ref: "#/components/schemas/customer_group" + * $ref: "#/components/schemas/CustomerGroup" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group-customers.ts b/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group-customers.ts index 9f3c69ea62..f387093871 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group-customers.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group-customers.ts @@ -42,7 +42,7 @@ import CustomerController from "../../../../controllers/customers" * customers: * type: array * items: - * $ref: "#/components/schemas/customer" + * $ref: "#/components/schemas/Customer" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group.ts index 1c6e8f7f1d..ba379a83e9 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/get-customer-group.ts @@ -43,7 +43,7 @@ import { FindParams } from "../../../../types/common" * type: object * properties: * customer_group: - * $ref: "#/components/schemas/customer_group" + * $ref: "#/components/schemas/CustomerGroup" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts b/packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts index b999e6c0a0..f4693bd165 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/list-customer-groups.ts @@ -132,7 +132,7 @@ import { Type } from "class-transformer" * customer_groups: * type: array * items: - * $ref: "#/components/schemas/customer_group" + * $ref: "#/components/schemas/CustomerGroup" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts index 5e33dc2b61..e8ff1924f6 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/update-customer-group.ts @@ -63,7 +63,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * customer_group: - * $ref: "#/components/schemas/customer_group" + * $ref: "#/components/schemas/CustomerGroup" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/customers/create-customer.ts b/packages/medusa/src/api/routes/admin/customers/create-customer.ts index fabbb00e1f..ecaf2eadc7 100644 --- a/packages/medusa/src/api/routes/admin/customers/create-customer.ts +++ b/packages/medusa/src/api/routes/admin/customers/create-customer.ts @@ -83,7 +83,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * customer: - * $ref: "#/components/schemas/customer" + * $ref: "#/components/schemas/Customer" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/customers/get-customer.ts b/packages/medusa/src/api/routes/admin/customers/get-customer.ts index 8f15e8ff7a..0f32df245e 100644 --- a/packages/medusa/src/api/routes/admin/customers/get-customer.ts +++ b/packages/medusa/src/api/routes/admin/customers/get-customer.ts @@ -43,7 +43,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * customer: - * $ref: "#/components/schemas/customer" + * $ref: "#/components/schemas/Customer" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/customers/list-customers.ts b/packages/medusa/src/api/routes/admin/customers/list-customers.ts index b8ac03c625..bcc3438970 100644 --- a/packages/medusa/src/api/routes/admin/customers/list-customers.ts +++ b/packages/medusa/src/api/routes/admin/customers/list-customers.ts @@ -48,7 +48,7 @@ import customerController from "../../../../controllers/customers" * customers: * type: array * items: - * $ref: "#/components/schemas/customer" + * $ref: "#/components/schemas/Customer" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/customers/update-customer.ts b/packages/medusa/src/api/routes/admin/customers/update-customer.ts index 6521afa317..105c73401b 100644 --- a/packages/medusa/src/api/routes/admin/customers/update-customer.ts +++ b/packages/medusa/src/api/routes/admin/customers/update-customer.ts @@ -97,7 +97,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * customer: - * $ref: "#/components/schemas/customer" + * $ref: "#/components/schemas/Customer" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/discounts/add-region.ts b/packages/medusa/src/api/routes/admin/discounts/add-region.ts index 752a14edc8..2a2ba418ee 100644 --- a/packages/medusa/src/api/routes/admin/discounts/add-region.ts +++ b/packages/medusa/src/api/routes/admin/discounts/add-region.ts @@ -43,7 +43,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * discount: - * $ref: "#/components/schemas/discount" + * $ref: "#/components/schemas/Discount" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/discounts/add-resources-to-condition-batch.ts b/packages/medusa/src/api/routes/admin/discounts/add-resources-to-condition-batch.ts index c6932b1d6d..bdd3093a1c 100644 --- a/packages/medusa/src/api/routes/admin/discounts/add-resources-to-condition-batch.ts +++ b/packages/medusa/src/api/routes/admin/discounts/add-resources-to-condition-batch.ts @@ -74,7 +74,7 @@ import { FindParams } from "../../../../types/common" * type: object * properties: * discount: - * $ref: "#/components/schemas/discount" + * $ref: "#/components/schemas/Discount" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/discounts/create-condition.ts b/packages/medusa/src/api/routes/admin/discounts/create-condition.ts index 615d385fb2..41c90dd8e4 100644 --- a/packages/medusa/src/api/routes/admin/discounts/create-condition.ts +++ b/packages/medusa/src/api/routes/admin/discounts/create-condition.ts @@ -92,7 +92,7 @@ import { FindParams } from "../../../../types/common" * type: object * properties: * discount: - * $ref: "#/components/schemas/discount" + * $ref: "#/components/schemas/Discount" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/discounts/create-discount.ts b/packages/medusa/src/api/routes/admin/discounts/create-discount.ts index 37da3037a2..f55f0ef039 100644 --- a/packages/medusa/src/api/routes/admin/discounts/create-discount.ts +++ b/packages/medusa/src/api/routes/admin/discounts/create-discount.ts @@ -152,7 +152,7 @@ import { FindParams } from "../../../../types/common" * value: 10, * allocation: AllocationType.ITEM * }, - * regions: ['reg_XXXXXXXX'], + * regions: ["reg_XXXXXXXX"], * is_dynamic: false, * is_disabled: false * }) @@ -172,7 +172,7 @@ import { FindParams } from "../../../../types/common" * "value": 10, * "allocation": "item" * }, - * "regions": ['reg_XXXXXXXX'] + * "regions": ["reg_XXXXXXXX"] * }' * security: * - api_token: [] @@ -188,7 +188,7 @@ import { FindParams } from "../../../../types/common" * type: object * properties: * discount: - * $ref: "#/components/schemas/discount" + * $ref: "#/components/schemas/Discount" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/discounts/create-dynamic-code.ts b/packages/medusa/src/api/routes/admin/discounts/create-dynamic-code.ts index 8fa535273d..8ddd5d5df8 100644 --- a/packages/medusa/src/api/routes/admin/discounts/create-dynamic-code.ts +++ b/packages/medusa/src/api/routes/admin/discounts/create-dynamic-code.ts @@ -59,7 +59,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * discount: - * $ref: "#/components/schemas/discount" + * $ref: "#/components/schemas/Discount" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/discounts/delete-condition.ts b/packages/medusa/src/api/routes/admin/discounts/delete-condition.ts index 394154f0be..1877be1fb2 100644 --- a/packages/medusa/src/api/routes/admin/discounts/delete-condition.ts +++ b/packages/medusa/src/api/routes/admin/discounts/delete-condition.ts @@ -57,7 +57,7 @@ import { FindParams } from "../../../../types/common" * default: true * discount: * description: The Discount to which the condition used to belong - * $ref: "#/components/schemas/discount" + * $ref: "#/components/schemas/Discount" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/discounts/delete-dynamic-code.ts b/packages/medusa/src/api/routes/admin/discounts/delete-dynamic-code.ts index 29cd7b962c..798fa81b0e 100644 --- a/packages/medusa/src/api/routes/admin/discounts/delete-dynamic-code.ts +++ b/packages/medusa/src/api/routes/admin/discounts/delete-dynamic-code.ts @@ -42,7 +42,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * discount: - * $ref: "#/components/schemas/discount" + * $ref: "#/components/schemas/Discount" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/discounts/delete-resources-from-condition-batch.ts b/packages/medusa/src/api/routes/admin/discounts/delete-resources-from-condition-batch.ts index 8187e86cce..1ca06d4662 100644 --- a/packages/medusa/src/api/routes/admin/discounts/delete-resources-from-condition-batch.ts +++ b/packages/medusa/src/api/routes/admin/discounts/delete-resources-from-condition-batch.ts @@ -73,7 +73,7 @@ import { FindParams } from "../../../../types/common" * type: object * properties: * discount: - * $ref: "#/components/schemas/discount" + * $ref: "#/components/schemas/Discount" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/discounts/get-condition.ts b/packages/medusa/src/api/routes/admin/discounts/get-condition.ts index 8cef30f943..b16837e066 100644 --- a/packages/medusa/src/api/routes/admin/discounts/get-condition.ts +++ b/packages/medusa/src/api/routes/admin/discounts/get-condition.ts @@ -43,7 +43,7 @@ import { FindParams } from "../../../../types/common" * type: object * properties: * discount_condition: - * $ref: "#/components/schemas/discount_condition" + * $ref: "#/components/schemas/DiscountCondition" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/discounts/get-discount-by-code.ts b/packages/medusa/src/api/routes/admin/discounts/get-discount-by-code.ts index 4380fa6edc..244fdef28a 100644 --- a/packages/medusa/src/api/routes/admin/discounts/get-discount-by-code.ts +++ b/packages/medusa/src/api/routes/admin/discounts/get-discount-by-code.ts @@ -42,7 +42,7 @@ import { FindParams } from "../../../../types/common" * type: object * properties: * discount: - * $ref: "#/components/schemas/discount" + * $ref: "#/components/schemas/Discount" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/discounts/get-discount.ts b/packages/medusa/src/api/routes/admin/discounts/get-discount.ts index eaecb21c11..410d8154cf 100644 --- a/packages/medusa/src/api/routes/admin/discounts/get-discount.ts +++ b/packages/medusa/src/api/routes/admin/discounts/get-discount.ts @@ -42,7 +42,7 @@ import { FindParams } from "../../../../types/common" * type: object * properties: * discount: - * $ref: "#/components/schemas/discount" + * $ref: "#/components/schemas/Discount" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/discounts/list-discounts.ts b/packages/medusa/src/api/routes/admin/discounts/list-discounts.ts index 236d6cd804..3dba4001db 100644 --- a/packages/medusa/src/api/routes/admin/discounts/list-discounts.ts +++ b/packages/medusa/src/api/routes/admin/discounts/list-discounts.ts @@ -71,7 +71,7 @@ import { optionalBooleanMapper } from "../../../../utils/validators/is-boolean" * discounts: * type: array * items: - * $ref: "#/components/schemas/discount" + * $ref: "#/components/schemas/Discount" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/discounts/remove-region.ts b/packages/medusa/src/api/routes/admin/discounts/remove-region.ts index eda47ddc1b..15b5b2ca78 100644 --- a/packages/medusa/src/api/routes/admin/discounts/remove-region.ts +++ b/packages/medusa/src/api/routes/admin/discounts/remove-region.ts @@ -42,7 +42,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * discount: - * $ref: "#/components/schemas/discount" + * $ref: "#/components/schemas/Discount" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/discounts/update-condition.ts b/packages/medusa/src/api/routes/admin/discounts/update-condition.ts index 8f58c0d979..83c5e8831d 100644 --- a/packages/medusa/src/api/routes/admin/discounts/update-condition.ts +++ b/packages/medusa/src/api/routes/admin/discounts/update-condition.ts @@ -87,7 +87,7 @@ import { FindParams } from "../../../../types/common" * type: object * properties: * discount: - * $ref: "#/components/schemas/discount" + * $ref: "#/components/schemas/Discount" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/discounts/update-discount.ts b/packages/medusa/src/api/routes/admin/discounts/update-discount.ts index 4b9d2bad48..36ee4f9983 100644 --- a/packages/medusa/src/api/routes/admin/discounts/update-discount.ts +++ b/packages/medusa/src/api/routes/admin/discounts/update-discount.ts @@ -162,7 +162,7 @@ import { FindParams } from "../../../../types/common" * type: object * properties: * discount: - * $ref: "#/components/schemas/discount" + * $ref: "#/components/schemas/Discount" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts b/packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts index 88e8600adc..faa7489f13 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts @@ -25,6 +25,7 @@ import { AddressPayload } from "../../../../types/common" import { DraftOrderCreateProps } from "../../../../types/draft-orders" import { validator } from "../../../../utils/validator" import { IsType } from "../../../../utils/validators/is-type" + /** * @oas [post] /draft-orders * operationId: "PostDraftOrders" @@ -53,12 +54,12 @@ import { IsType } from "../../../../utils/validators/is-type" * billing_address: * description: "The Address to be used for billing purposes." * anyOf: - * - $ref: "#/components/schemas/address_fields" + * - $ref: "#/components/schemas/AddressFields" * - type: string * shipping_address: * description: "The Address to be used for shipping." * anyOf: - * - $ref: "#/components/schemas/address_fields" + * - $ref: "#/components/schemas/AddressFields" * - type: string * items: * description: The Line Items that have been received. @@ -181,7 +182,7 @@ import { IsType } from "../../../../utils/validators/is-type" * type: object * properties: * draft_order: - * $ref: "#/components/schemas/draft-order" + * $ref: "#/components/schemas/DraftOrder" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/draft-orders/create-line-item.ts b/packages/medusa/src/api/routes/admin/draft-orders/create-line-item.ts index 4cb292b58a..d3f538f5fb 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/create-line-item.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/create-line-item.ts @@ -82,7 +82,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * draft_order: - * $ref: "#/components/schemas/draft-order" + * $ref: "#/components/schemas/DraftOrder" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/draft-orders/delete-line-item.ts b/packages/medusa/src/api/routes/admin/draft-orders/delete-line-item.ts index 3ae9c82e9d..aa9dc5dc59 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/delete-line-item.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/delete-line-item.ts @@ -48,7 +48,7 @@ import { MedusaError } from "medusa-core-utils" * type: object * properties: * draft_order: - * $ref: "#/components/schemas/draft-order" + * $ref: "#/components/schemas/DraftOrder" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/draft-orders/get-draft-order.ts b/packages/medusa/src/api/routes/admin/draft-orders/get-draft-order.ts index ea94bbba67..f4936f4d7c 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/get-draft-order.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/get-draft-order.ts @@ -46,7 +46,7 @@ import { DraftOrder } from "../../../.." * type: object * properties: * draft_order: - * $ref: "#/components/schemas/draft-order" + * $ref: "#/components/schemas/DraftOrder" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/draft-orders/list-draft-orders.ts b/packages/medusa/src/api/routes/admin/draft-orders/list-draft-orders.ts index 32b3c9368d..c3e5d194de 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/list-draft-orders.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/list-draft-orders.ts @@ -53,7 +53,7 @@ import { validator } from "../../../../utils/validator" * draft_orders: * type: array * items: - * $ref: "#/components/schemas/draft-order" + * $ref: "#/components/schemas/DraftOrder" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/draft-orders/register-payment.ts b/packages/medusa/src/api/routes/admin/draft-orders/register-payment.ts index b9bb2e7a79..bbf6f95150 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/register-payment.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/register-payment.ts @@ -49,7 +49,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * order: - * $ref: "#/components/schemas/draft-order" + * $ref: "#/components/schemas/DraftOrder" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts b/packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts index fe99ee6378..eefd2e1c66 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts @@ -19,6 +19,7 @@ import { CartUpdateProps } from "../../../../types/cart" import { AddressPayload } from "../../../../types/common" import { validator } from "../../../../utils/validator" import { IsType } from "../../../../utils/validators/is-type" + /** * @oas [post] /admin/draft-orders/{id} * operationId: PostDraftOrdersDraftOrder @@ -49,12 +50,12 @@ import { IsType } from "../../../../utils/validators/is-type" * billing_address: * description: "The Address to be used for billing purposes." * anyOf: - * - $ref: "#/components/schemas/address_fields" + * - $ref: "#/components/schemas/AddressFields" * - type: string * shipping_address: * description: "The Address to be used for shipping." * anyOf: - * - $ref: "#/components/schemas/address_fields" + * - $ref: "#/components/schemas/AddressFields" * - type: string * discounts: * description: "An array of Discount codes to add to the Draft Order." @@ -109,7 +110,7 @@ import { IsType } from "../../../../utils/validators/is-type" * type: object * properties: * draft_order: - * $ref: "#/components/schemas/draft-order" + * $ref: "#/components/schemas/DraftOrder" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/draft-orders/update-line-item.ts b/packages/medusa/src/api/routes/admin/draft-orders/update-line-item.ts index 7fc8f9c781..d678d0d235 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/update-line-item.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/update-line-item.ts @@ -75,7 +75,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * draft_order: - * $ref: "#/components/schemas/draft-order" + * $ref: "#/components/schemas/DraftOrder" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/gift-cards/create-gift-card.ts b/packages/medusa/src/api/routes/admin/gift-cards/create-gift-card.ts index 4a8cb53d22..fc4a53ea6a 100644 --- a/packages/medusa/src/api/routes/admin/gift-cards/create-gift-card.ts +++ b/packages/medusa/src/api/routes/admin/gift-cards/create-gift-card.ts @@ -72,7 +72,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * gift_card: - * $ref: "#/components/schemas/gift_card" + * $ref: "#/components/schemas/GiftCard" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/gift-cards/get-gift-card.ts b/packages/medusa/src/api/routes/admin/gift-cards/get-gift-card.ts index 0fd4ce68b3..356fdb5761 100644 --- a/packages/medusa/src/api/routes/admin/gift-cards/get-gift-card.ts +++ b/packages/medusa/src/api/routes/admin/gift-cards/get-gift-card.ts @@ -38,7 +38,7 @@ import { defaultAdminGiftCardFields, defaultAdminGiftCardRelations } from "./" * type: object * properties: * gift_card: - * $ref: "#/components/schemas/gift_card" + * $ref: "#/components/schemas/GiftCard" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/gift-cards/list-gift-cards.ts b/packages/medusa/src/api/routes/admin/gift-cards/list-gift-cards.ts index 626edd548b..0d057b120c 100644 --- a/packages/medusa/src/api/routes/admin/gift-cards/list-gift-cards.ts +++ b/packages/medusa/src/api/routes/admin/gift-cards/list-gift-cards.ts @@ -48,7 +48,7 @@ import { isDefined } from "medusa-core-utils" * gift_cards: * type: array * items: - * $ref: "#/components/schemas/gift_card" + * $ref: "#/components/schemas/GiftCard" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/gift-cards/update-gift-card.ts b/packages/medusa/src/api/routes/admin/gift-cards/update-gift-card.ts index 0ee0f85f2c..f56bb33152 100644 --- a/packages/medusa/src/api/routes/admin/gift-cards/update-gift-card.ts +++ b/packages/medusa/src/api/routes/admin/gift-cards/update-gift-card.ts @@ -72,7 +72,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * gift_card: - * $ref: "#/components/schemas/gift_card" + * $ref: "#/components/schemas/GiftCard" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/invites/list-invites.ts b/packages/medusa/src/api/routes/admin/invites/list-invites.ts index 1f2ad322de..572e65e657 100644 --- a/packages/medusa/src/api/routes/admin/invites/list-invites.ts +++ b/packages/medusa/src/api/routes/admin/invites/list-invites.ts @@ -38,7 +38,7 @@ import InviteService from "../../../../services/invite" * invites: * type: array * items: - * $ref: "#/components/schemas/invite" + * $ref: "#/components/schemas/Invite" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/notes/create-note.ts b/packages/medusa/src/api/routes/admin/notes/create-note.ts index 41a4281d88..b57f4405a3 100644 --- a/packages/medusa/src/api/routes/admin/notes/create-note.ts +++ b/packages/medusa/src/api/routes/admin/notes/create-note.ts @@ -69,7 +69,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * note: - * $ref: "#/components/schemas/note" + * $ref: "#/components/schemas/Note" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/notes/get-note.ts b/packages/medusa/src/api/routes/admin/notes/get-note.ts index a2cd391ce8..4705a62a8c 100644 --- a/packages/medusa/src/api/routes/admin/notes/get-note.ts +++ b/packages/medusa/src/api/routes/admin/notes/get-note.ts @@ -38,7 +38,7 @@ import NoteService from "../../../../services/note" * type: object * properties: * note: - * $ref: "#/components/schemas/note" + * $ref: "#/components/schemas/Note" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/notes/list-notes.ts b/packages/medusa/src/api/routes/admin/notes/list-notes.ts index fc12d5c5a8..ea77cfa9d1 100644 --- a/packages/medusa/src/api/routes/admin/notes/list-notes.ts +++ b/packages/medusa/src/api/routes/admin/notes/list-notes.ts @@ -47,7 +47,7 @@ import { validator } from "../../../../utils/validator" * notes: * type: array * items: - * $ref: "#/components/schemas/note" + * $ref: "#/components/schemas/Note" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/notes/update-note.ts b/packages/medusa/src/api/routes/admin/notes/update-note.ts index 4c2ecc0863..584dbf363e 100644 --- a/packages/medusa/src/api/routes/admin/notes/update-note.ts +++ b/packages/medusa/src/api/routes/admin/notes/update-note.ts @@ -58,7 +58,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * note: - * $ref: "#/components/schemas/note" + * $ref: "#/components/schemas/Note" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/notifications/list-notifications.ts b/packages/medusa/src/api/routes/admin/notifications/list-notifications.ts index bb8b066e7d..01cf9f925a 100644 --- a/packages/medusa/src/api/routes/admin/notifications/list-notifications.ts +++ b/packages/medusa/src/api/routes/admin/notifications/list-notifications.ts @@ -59,7 +59,7 @@ import { validator } from "../../../../utils/validator" * notifications: * type: array * items: - * $ref: "#/components/schemas/notification" + * $ref: "#/components/schemas/Notification" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/notifications/resend-notification.ts b/packages/medusa/src/api/routes/admin/notifications/resend-notification.ts index 338c122498..bfb5e1a3b5 100644 --- a/packages/medusa/src/api/routes/admin/notifications/resend-notification.ts +++ b/packages/medusa/src/api/routes/admin/notifications/resend-notification.ts @@ -4,8 +4,7 @@ import { } from "." import { EntityManager } from "typeorm" -import { IsOptional } from "class-validator" -import { IsString } from "class-validator" +import { IsOptional, IsString } from "class-validator" import { Notification } from "../../../../models" import { NotificationService } from "../../../../services" import { validator } from "../../../../utils/validator" @@ -57,7 +56,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * notification: - * $ref: "#/components/schemas/notification" + * $ref: "#/components/schemas/Notification" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/order-edits/add-line-item.ts b/packages/medusa/src/api/routes/admin/order-edits/add-line-item.ts index 9fdef8168c..27cb045566 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/add-line-item.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/add-line-item.ts @@ -42,8 +42,8 @@ import { * const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 }) * // must be previously logged in or use api token * medusa.admin.orderEdits.addLineItem(order_edit_id, { - * variant_id, - * quantity + * variant_id, + * quantity * }) * .then(({ order_edit }) => { * console.log(order_edit.id) @@ -69,7 +69,7 @@ import { * type: object * properties: * order_edit: - * $ref: "#/components/schemas/order_edit" + * $ref: "#/components/schemas/OrderEdit" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/order-edits/cancel-order-edit.ts b/packages/medusa/src/api/routes/admin/order-edits/cancel-order-edit.ts index 896aaa54a4..b6a917cf00 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/cancel-order-edit.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/cancel-order-edit.ts @@ -44,7 +44,7 @@ import { * type: object * properties: * order_edit: - * $ref: "#/components/schemas/order_edit" + * $ref: "#/components/schemas/OrderEdit" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/order-edits/confirm-order-edit.ts b/packages/medusa/src/api/routes/admin/order-edits/confirm-order-edit.ts index e7897a64f7..dda908f0e5 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/confirm-order-edit.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/confirm-order-edit.ts @@ -44,7 +44,7 @@ import { * type: object * properties: * order_edit: - * $ref: "#/components/schemas/order_edit" + * $ref: "#/components/schemas/OrderEdit" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/order-edits/create-order-edit.ts b/packages/medusa/src/api/routes/admin/order-edits/create-order-edit.ts index 77d0b19c04..e1e1749361 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/create-order-edit.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/create-order-edit.ts @@ -59,7 +59,7 @@ import { * type: object * properties: * order_edit: - * $ref: "#/components/schemas/order_edit" + * $ref: "#/components/schemas/OrderEdit" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/order-edits/delete-line-item.ts b/packages/medusa/src/api/routes/admin/order-edits/delete-line-item.ts index b0f6cc409a..faad5d8096 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/delete-line-item.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/delete-line-item.ts @@ -1,7 +1,6 @@ import { EntityManager } from "typeorm" import { OrderEditService } from "../../../../services" import { Request, Response } from "express" -import { IsNumber } from "class-validator" import { defaultOrderEditFields, defaultOrderEditRelations, @@ -46,7 +45,7 @@ import { * type: object * properties: * order_edit: - * $ref: "#/components/schemas/order_edit" + * $ref: "#/components/schemas/OrderEdit" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/order-edits/get-order-edit.ts b/packages/medusa/src/api/routes/admin/order-edits/get-order-edit.ts index aa76d8bf84..458230490a 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/get-order-edit.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/get-order-edit.ts @@ -42,7 +42,7 @@ import { FindParams } from "../../../../types/common" * type: object * properties: * order_edit: - * $ref: "#/components/schemas/order_edit" + * $ref: "#/components/schemas/OrderEdit" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/order-edits/list-order-edit.ts b/packages/medusa/src/api/routes/admin/order-edits/list-order-edit.ts index 25d69316ee..bfc6679819 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/list-order-edit.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/list-order-edit.ts @@ -47,7 +47,7 @@ import { IsOptional, IsString } from "class-validator" * properties: * order_edits: * type: array - * $ref: "#/components/schemas/order_edit" + * $ref: "#/components/schemas/OrderEdit" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/order-edits/request-confirmation.ts b/packages/medusa/src/api/routes/admin/order-edits/request-confirmation.ts index 52e77c0868..1715895a73 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/request-confirmation.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/request-confirmation.ts @@ -1,5 +1,5 @@ import { EntityManager } from "typeorm" -import { IsOptional, IsString, IsObject } from "class-validator" +import { IsOptional, IsString } from "class-validator" import { OrderEditService, OrderService, @@ -49,7 +49,7 @@ import { PaymentCollectionType } from "../../../../models" * type: object * properties: * order_edit: - * $ref: "#/components/schemas/order_edit" + * $ref: "#/components/schemas/OrderEdit" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/order-edits/update-order-edit-line-item.ts b/packages/medusa/src/api/routes/admin/order-edits/update-order-edit-line-item.ts index 387a030769..02126d71e9 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/update-order-edit-line-item.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/update-order-edit-line-item.ts @@ -61,7 +61,7 @@ import { * type: object * properties: * order_edit: - * $ref: "#/components/schemas/order_edit" + * $ref: "#/components/schemas/OrderEdit" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/order-edits/update-order-edit.ts b/packages/medusa/src/api/routes/admin/order-edits/update-order-edit.ts index 5d30063d44..70cd0c457a 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/update-order-edit.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/update-order-edit.ts @@ -61,7 +61,7 @@ import { * type: object * properties: * order_edit: - * $ref: "#/components/schemas/order_edit" + * $ref: "#/components/schemas/OrderEdit" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/add-shipping-method.ts b/packages/medusa/src/api/routes/admin/orders/add-shipping-method.ts index acbf929e3a..de474e7b33 100644 --- a/packages/medusa/src/api/routes/admin/orders/add-shipping-method.ts +++ b/packages/medusa/src/api/routes/admin/orders/add-shipping-method.ts @@ -60,7 +60,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/archive-order.ts b/packages/medusa/src/api/routes/admin/orders/archive-order.ts index 87815a9dea..c6ed1c18cc 100644 --- a/packages/medusa/src/api/routes/admin/orders/archive-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/archive-order.ts @@ -39,7 +39,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-claim.ts b/packages/medusa/src/api/routes/admin/orders/cancel-claim.ts index 02e89add99..a345c11996 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-claim.ts @@ -43,7 +43,7 @@ import { MedusaError } from "medusa-core-utils" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.ts b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.ts index 97f0f87c17..d71073d5bc 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-claim.ts @@ -48,7 +48,7 @@ import { MedusaError } from "medusa-core-utils" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-swap.ts b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-swap.ts index 1b9c712865..114092727f 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-swap.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment-swap.ts @@ -48,7 +48,7 @@ import { MedusaError } from "medusa-core-utils" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts index d9f83eacaf..f8d877c789 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts @@ -43,7 +43,7 @@ import { MedusaError } from "medusa-core-utils" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-order.ts b/packages/medusa/src/api/routes/admin/orders/cancel-order.ts index b5244c3652..bac87b93c9 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-order.ts @@ -41,7 +41,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/cancel-swap.ts b/packages/medusa/src/api/routes/admin/orders/cancel-swap.ts index 1f7874d409..b12b3a817a 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-swap.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-swap.ts @@ -43,7 +43,7 @@ import { MedusaError } from "medusa-core-utils" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/capture-payment.ts b/packages/medusa/src/api/routes/admin/orders/capture-payment.ts index ce4ea47ad9..49cf07e5c9 100644 --- a/packages/medusa/src/api/routes/admin/orders/capture-payment.ts +++ b/packages/medusa/src/api/routes/admin/orders/capture-payment.ts @@ -41,7 +41,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/complete-order.ts b/packages/medusa/src/api/routes/admin/orders/complete-order.ts index da1c62b1ba..a51cf7ac91 100644 --- a/packages/medusa/src/api/routes/admin/orders/complete-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/complete-order.ts @@ -39,7 +39,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/create-claim-shipment.ts b/packages/medusa/src/api/routes/admin/orders/create-claim-shipment.ts index 1462f2c414..1f1f45990e 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-claim-shipment.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-claim-shipment.ts @@ -66,7 +66,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/create-claim.ts b/packages/medusa/src/api/routes/admin/orders/create-claim.ts index 73e6bbed5f..c44e7ecc6e 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-claim.ts @@ -117,7 +117,7 @@ import { validator } from "../../../../utils/validator" * shipping_address: * type: object * description: "An optional shipping address to send the claim to. Defaults to the parent order's shipping address" - * $ref: "#/components/schemas/address" + * $ref: "#/components/schemas/Address" * refund_amount: * description: The amount to refund the Customer when the Claim type is `refund`. * type: integer @@ -175,7 +175,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts b/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts index 28a783f0db..2feb371d79 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts @@ -98,7 +98,7 @@ import { optionalBooleanMapper } from "../../../../utils/validators/is-boolean" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/create-shipment.ts b/packages/medusa/src/api/routes/admin/orders/create-shipment.ts index d7f87561fb..5e037ac51f 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-shipment.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-shipment.ts @@ -75,7 +75,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/create-swap-shipment.ts b/packages/medusa/src/api/routes/admin/orders/create-swap-shipment.ts index bd7aaed6ee..f8f6f80b4b 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-swap-shipment.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-swap-shipment.ts @@ -75,7 +75,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/create-swap.ts b/packages/medusa/src/api/routes/admin/orders/create-swap.ts index 28e72b2fa5..cea46c2ce0 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-swap.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-swap.ts @@ -152,7 +152,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts b/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts index 3a473debcf..0536b1a1da 100644 --- a/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts @@ -56,7 +56,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts b/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts index 20b781f1d2..57b150fc5e 100644 --- a/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts +++ b/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts @@ -56,7 +56,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/get-order.ts b/packages/medusa/src/api/routes/admin/orders/get-order.ts index 6b2b2461ec..e17ef53a98 100644 --- a/packages/medusa/src/api/routes/admin/orders/get-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/get-order.ts @@ -38,7 +38,7 @@ import { OrderService } from "../../../../services" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/list-orders.ts b/packages/medusa/src/api/routes/admin/orders/list-orders.ts index 6ef0436e0d..1568d396ac 100644 --- a/packages/medusa/src/api/routes/admin/orders/list-orders.ts +++ b/packages/medusa/src/api/routes/admin/orders/list-orders.ts @@ -185,7 +185,7 @@ import { pick } from "lodash" * orders: * type: array * items: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/orders/process-swap-payment.ts b/packages/medusa/src/api/routes/admin/orders/process-swap-payment.ts index 9207d61b20..1efdb8b2e4 100644 --- a/packages/medusa/src/api/routes/admin/orders/process-swap-payment.ts +++ b/packages/medusa/src/api/routes/admin/orders/process-swap-payment.ts @@ -42,7 +42,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/refund-payment.ts b/packages/medusa/src/api/routes/admin/orders/refund-payment.ts index 13e3320142..8c1e57e398 100644 --- a/packages/medusa/src/api/routes/admin/orders/refund-payment.ts +++ b/packages/medusa/src/api/routes/admin/orders/refund-payment.ts @@ -78,7 +78,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/request-return.ts b/packages/medusa/src/api/routes/admin/orders/request-return.ts index 36ea080e74..6cc76e22e1 100644 --- a/packages/medusa/src/api/routes/admin/orders/request-return.ts +++ b/packages/medusa/src/api/routes/admin/orders/request-return.ts @@ -126,7 +126,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/update-claim.ts b/packages/medusa/src/api/routes/admin/orders/update-claim.ts index acb035012c..daf277db6a 100644 --- a/packages/medusa/src/api/routes/admin/orders/update-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/update-claim.ts @@ -142,7 +142,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/orders/update-order.ts b/packages/medusa/src/api/routes/admin/orders/update-order.ts index f2c4ac454b..56f45e72e1 100644 --- a/packages/medusa/src/api/routes/admin/orders/update-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/update-order.ts @@ -36,16 +36,16 @@ import { validator } from "../../../../utils/validator" * billing_address: * description: Billing address * anyOf: - * - $ref: "#/components/schemas/address_fields" + * - $ref: "#/components/schemas/AddressFields" * shipping_address: * description: Shipping address * anyOf: - * - $ref: "#/components/schemas/address_fields" + * - $ref: "#/components/schemas/AddressFields" * items: * description: The Line Items for the order * type: array * items: - * $ref: "#/components/schemas/line_item" + * $ref: "#/components/schemas/LineItem" * region: * description: ID of the region where the order belongs * type: string @@ -53,7 +53,7 @@ import { validator } from "../../../../utils/validator" * description: Discounts applied to the order * type: array * items: - * $ref: "#/components/schemas/discount" + * $ref: "#/components/schemas/Discount" * customer_id: * description: ID of the customer * type: string @@ -86,7 +86,7 @@ import { validator } from "../../../../utils/validator" * items: * type: array * items: - * $ref: "#/components/schemas/line_item" + * $ref: "#/components/schemas/LineItem" * description: Items to ship * no_notification: * description: A flag to indicate if no notifications should be emitted related to the updated order. @@ -127,7 +127,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/payment-collections/get-payment-collection.ts b/packages/medusa/src/api/routes/admin/payment-collections/get-payment-collection.ts index 4e417296f6..6710b2c8f3 100644 --- a/packages/medusa/src/api/routes/admin/payment-collections/get-payment-collection.ts +++ b/packages/medusa/src/api/routes/admin/payment-collections/get-payment-collection.ts @@ -41,7 +41,7 @@ import { FindParams } from "../../../../types/common" * type: object * properties: * payment_collection: - * $ref: "#/components/schemas/payment_collection" + * $ref: "#/components/schemas/PaymentCollection" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/payment-collections/mark-authorized-payment-collection.ts b/packages/medusa/src/api/routes/admin/payment-collections/mark-authorized-payment-collection.ts index 9ebe66054b..8e8a0fbfb3 100644 --- a/packages/medusa/src/api/routes/admin/payment-collections/mark-authorized-payment-collection.ts +++ b/packages/medusa/src/api/routes/admin/payment-collections/mark-authorized-payment-collection.ts @@ -39,7 +39,7 @@ import { PaymentCollectionService } from "../../../../services" * type: object * properties: * payment_collection: - * $ref: "#/components/schemas/payment_collection" + * $ref: "#/components/schemas/PaymentCollection" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/payment-collections/update-payment-collection.ts b/packages/medusa/src/api/routes/admin/payment-collections/update-payment-collection.ts index b86d601330..6a6c8eefc9 100644 --- a/packages/medusa/src/api/routes/admin/payment-collections/update-payment-collection.ts +++ b/packages/medusa/src/api/routes/admin/payment-collections/update-payment-collection.ts @@ -59,7 +59,7 @@ import { PaymentCollectionService } from "../../../../services" * type: object * properties: * payment_collection: - * $ref: "#/components/schemas/payment_collection" + * $ref: "#/components/schemas/PaymentCollection" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/payments/capture-payment.ts b/packages/medusa/src/api/routes/admin/payments/capture-payment.ts index 98dc9bdb8c..c2b1a4cdf9 100644 --- a/packages/medusa/src/api/routes/admin/payments/capture-payment.ts +++ b/packages/medusa/src/api/routes/admin/payments/capture-payment.ts @@ -38,7 +38,7 @@ import { PaymentService } from "../../../../services" * type: object * properties: * payment: - * $ref: "#/components/schemas/payment" + * $ref: "#/components/schemas/Payment" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/payments/get-payment.ts b/packages/medusa/src/api/routes/admin/payments/get-payment.ts index 032e1fa1c3..0808e08001 100644 --- a/packages/medusa/src/api/routes/admin/payments/get-payment.ts +++ b/packages/medusa/src/api/routes/admin/payments/get-payment.ts @@ -39,7 +39,7 @@ import { FindParams } from "../../../../types/common" * type: object * properties: * payment: - * $ref: "#/components/schemas/payment" + * $ref: "#/components/schemas/Payment" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/payments/refund-payment.ts b/packages/medusa/src/api/routes/admin/payments/refund-payment.ts index bed1912607..3439ab8abf 100644 --- a/packages/medusa/src/api/routes/admin/payments/refund-payment.ts +++ b/packages/medusa/src/api/routes/admin/payments/refund-payment.ts @@ -75,7 +75,7 @@ import { PaymentService } from "../../../../services" * type: object * properties: * refund: - * $ref: "#/components/schemas/refund" + * $ref: "#/components/schemas/Refund" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/price-lists/add-prices-batch.ts b/packages/medusa/src/api/routes/admin/price-lists/add-prices-batch.ts index 06a0c0eeb8..25eda69b3e 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/add-prices-batch.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/add-prices-batch.ts @@ -105,7 +105,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * price_list: - * $ref: "#/components/schemas/price_list" + * $ref: "#/components/schemas/PriceList" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/price-lists/create-price-list.ts b/packages/medusa/src/api/routes/admin/price-lists/create-price-list.ts index cfaba8bdc9..6e5c6cae95 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/create-price-list.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/create-price-list.ts @@ -160,7 +160,7 @@ import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators * type: object * properties: * price_list: - * $ref: "#/components/schemas/price_list" + * $ref: "#/components/schemas/PriceList" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/price-lists/get-price-list.ts b/packages/medusa/src/api/routes/admin/price-lists/get-price-list.ts index 9ffc82df82..9e2e1d0cd0 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/get-price-list.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/get-price-list.ts @@ -41,7 +41,7 @@ import PriceListService from "../../../../services/price-list" * type: object * properties: * price_list: - * $ref: "#/components/schemas/price_list" + * $ref: "#/components/schemas/PriceList" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts b/packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts index 3980af7875..5ece8ef4e4 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/list-price-list-products.ts @@ -165,7 +165,7 @@ import { isDefined } from "medusa-core-utils" * products: * type: array * items: - * $ref: "#/components/schemas/product" + * $ref: "#/components/schemas/Product" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/price-lists/list-price-lists.ts b/packages/medusa/src/api/routes/admin/price-lists/list-price-lists.ts index 1f1d58c53b..21e882e45a 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/list-price-lists.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/list-price-lists.ts @@ -146,7 +146,7 @@ import { Type } from "class-transformer" * price_lists: * type: array * items: - * $ref: "#/components/schemas/price_list" + * $ref: "#/components/schemas/PriceList" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/price-lists/update-price-list.ts b/packages/medusa/src/api/routes/admin/price-lists/update-price-list.ts index 4b46ff91b4..b5140b4448 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/update-price-list.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/update-price-list.ts @@ -142,7 +142,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * price_list: - * $ref: "#/components/schemas/price_list" + * $ref: "#/components/schemas/PriceList" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/product-tags/list-product-tags.ts b/packages/medusa/src/api/routes/admin/product-tags/list-product-tags.ts index e0cee92a22..af3cd4e63b 100644 --- a/packages/medusa/src/api/routes/admin/product-tags/list-product-tags.ts +++ b/packages/medusa/src/api/routes/admin/product-tags/list-product-tags.ts @@ -113,7 +113,7 @@ import { Request, Response } from "express" * type: object * properties: * product_tags: - * $ref: "#/components/schemas/product_tag" + * $ref: "#/components/schemas/ProductTag" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/product-types/list-product-types.ts b/packages/medusa/src/api/routes/admin/product-types/list-product-types.ts index 2b0c3bb010..a848bb63d9 100644 --- a/packages/medusa/src/api/routes/admin/product-types/list-product-types.ts +++ b/packages/medusa/src/api/routes/admin/product-types/list-product-types.ts @@ -112,7 +112,7 @@ import ProductTypeService from "../../../../services/product-type" * type: object * properties: * product_types: - * $ref: "#/components/schemas/product_type" + * $ref: "#/components/schemas/ProductType" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/products/add-option.ts b/packages/medusa/src/api/routes/admin/products/add-option.ts index 9521f0a4bb..f734392b66 100644 --- a/packages/medusa/src/api/routes/admin/products/add-option.ts +++ b/packages/medusa/src/api/routes/admin/products/add-option.ts @@ -60,7 +60,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * product: - * $ref: "#/components/schemas/product" + * $ref: "#/components/schemas/Product" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/products/create-product.ts b/packages/medusa/src/api/routes/admin/products/create-product.ts index ca48df7c0a..6f261faac9 100644 --- a/packages/medusa/src/api/routes/admin/products/create-product.ts +++ b/packages/medusa/src/api/routes/admin/products/create-product.ts @@ -284,7 +284,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * product: - * $ref: "#/components/schemas/product" + * $ref: "#/components/schemas/Product" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/products/create-variant.ts b/packages/medusa/src/api/routes/admin/products/create-variant.ts index ac2ee5e156..66baa3c6bb 100644 --- a/packages/medusa/src/api/routes/admin/products/create-variant.ts +++ b/packages/medusa/src/api/routes/admin/products/create-variant.ts @@ -189,7 +189,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * product: - * $ref: "#/components/schemas/product" + * $ref: "#/components/schemas/Product" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/products/delete-option.ts b/packages/medusa/src/api/routes/admin/products/delete-option.ts index 893cbe971e..be19383dba 100644 --- a/packages/medusa/src/api/routes/admin/products/delete-option.ts +++ b/packages/medusa/src/api/routes/admin/products/delete-option.ts @@ -53,7 +53,7 @@ import { ProductService } from "../../../../services" * description: Whether or not the items were deleted. * default: true * product: - * $ref: "#/components/schemas/product" + * $ref: "#/components/schemas/Product" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/products/delete-variant.ts b/packages/medusa/src/api/routes/admin/products/delete-variant.ts index 22866d6589..766667219c 100644 --- a/packages/medusa/src/api/routes/admin/products/delete-variant.ts +++ b/packages/medusa/src/api/routes/admin/products/delete-variant.ts @@ -57,7 +57,7 @@ import { EntityManager } from "typeorm" * description: Whether or not the items were deleted. * default: true * product: - * $ref: "#/components/schemas/product" + * $ref: "#/components/schemas/Product" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/products/get-product.ts b/packages/medusa/src/api/routes/admin/products/get-product.ts index 0fafe7783a..9e62723392 100644 --- a/packages/medusa/src/api/routes/admin/products/get-product.ts +++ b/packages/medusa/src/api/routes/admin/products/get-product.ts @@ -38,7 +38,7 @@ import { PricingService, ProductService } from "../../../../services" * type: object * properties: * product: - * $ref: "#/components/schemas/product" + * $ref: "#/components/schemas/Product" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/products/list-products.ts b/packages/medusa/src/api/routes/admin/products/list-products.ts index 2801ffbc9a..83a8a4f3a1 100644 --- a/packages/medusa/src/api/routes/admin/products/list-products.ts +++ b/packages/medusa/src/api/routes/admin/products/list-products.ts @@ -189,7 +189,7 @@ import { FilterableProductProps } from "../../../../types/product" * products: * type: array * items: - * $ref: "#/components/schemas/product" + * $ref: "#/components/schemas/Product" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/products/list-types.ts b/packages/medusa/src/api/routes/admin/products/list-types.ts index d7227067a9..23b267ce63 100644 --- a/packages/medusa/src/api/routes/admin/products/list-types.ts +++ b/packages/medusa/src/api/routes/admin/products/list-types.ts @@ -39,7 +39,7 @@ import { ProductService } from "../../../../services" * types: * type: array * items: - * $ref: "#/components/schemas/product_type" + * $ref: "#/components/schemas/ProductType" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/products/list-variants.ts b/packages/medusa/src/api/routes/admin/products/list-variants.ts index 68ccbb0054..7615f48c27 100644 --- a/packages/medusa/src/api/routes/admin/products/list-variants.ts +++ b/packages/medusa/src/api/routes/admin/products/list-variants.ts @@ -42,7 +42,7 @@ import { validator } from "../../../../utils/validator" * variants: * type: array * items: - * $ref: "#/components/schemas/product_variant" + * $ref: "#/components/schemas/ProductVariant" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/products/set-metadata.ts b/packages/medusa/src/api/routes/admin/products/set-metadata.ts index d2ec57cc56..4db9859bc6 100644 --- a/packages/medusa/src/api/routes/admin/products/set-metadata.ts +++ b/packages/medusa/src/api/routes/admin/products/set-metadata.ts @@ -65,7 +65,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * product: - * $ref: "#/components/schemas/product" + * $ref: "#/components/schemas/Product" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/products/update-option.ts b/packages/medusa/src/api/routes/admin/products/update-option.ts index c88bc03b7b..a92ad184e8 100644 --- a/packages/medusa/src/api/routes/admin/products/update-option.ts +++ b/packages/medusa/src/api/routes/admin/products/update-option.ts @@ -61,7 +61,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * product: - * $ref: "#/components/schemas/product" + * $ref: "#/components/schemas/Product" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/products/update-product.ts b/packages/medusa/src/api/routes/admin/products/update-product.ts index 1c92138477..c5dccabc92 100644 --- a/packages/medusa/src/api/routes/admin/products/update-product.ts +++ b/packages/medusa/src/api/routes/admin/products/update-product.ts @@ -266,7 +266,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * product: - * $ref: "#/components/schemas/product" + * $ref: "#/components/schemas/Product" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/products/update-variant.ts b/packages/medusa/src/api/routes/admin/products/update-variant.ts index e396d1b02d..0ef7c14ec3 100644 --- a/packages/medusa/src/api/routes/admin/products/update-variant.ts +++ b/packages/medusa/src/api/routes/admin/products/update-variant.ts @@ -183,7 +183,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * product: - * $ref: "#/components/schemas/product" + * $ref: "#/components/schemas/Product" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/add-channels-batch.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/add-channels-batch.ts index b86b73cc09..02576c5f3b 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/add-channels-batch.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/add-channels-batch.ts @@ -75,7 +75,7 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * schema: * properties: * publishable_api_key: - * $ref: "#/components/schemas/publishable_api_key" + * $ref: "#/components/schemas/PublishableApiKey" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/create-publishable-api-key.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/create-publishable-api-key.ts index 07b5651c0f..715ecd0d3d 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/create-publishable-api-key.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/create-publishable-api-key.ts @@ -52,7 +52,7 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * type: object * properties: * publishable_api_key: - * $ref: "#/components/schemas/publishable_api_key" + * $ref: "#/components/schemas/PublishableApiKey" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-channels-batch.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-channels-batch.ts index 00950441e2..c8e5a87c2b 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-channels-batch.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-channels-batch.ts @@ -75,7 +75,7 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * schema: * properties: * publishable_api_key: - * $ref: "#/components/schemas/publishable_api_key" + * $ref: "#/components/schemas/PublishableApiKey" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/get-publishable-api-key.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/get-publishable-api-key.ts index baa8fd59f7..eda1667d77 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/get-publishable-api-key.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/get-publishable-api-key.ts @@ -41,7 +41,7 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * type: object * properties: * publishable_api_key: - * $ref: "#/components/schemas/publishable_api_key" + * $ref: "#/components/schemas/PublishableApiKey" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.ts index 9a6d03be09..b9ac340377 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-key-sales-channels.ts @@ -44,7 +44,7 @@ import { extendedFindParamsMixin } from "../../../../types/common" * sales_channels: * type: array * items: - * $ref: "#/components/schemas/sales_channel" + * $ref: "#/components/schemas/SalesChannel" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-keys.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-keys.ts index e5d1a78b76..e943b1643d 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-keys.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/list-publishable-api-keys.ts @@ -47,7 +47,7 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * properties: * publishable_api_keys: * type: array - * $ref: "#/components/schemas/publishable_api_key" + * $ref: "#/components/schemas/PublishableApiKey" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/revoke-publishable-api-key.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/revoke-publishable-api-key.ts index 8c76035f68..6afe33e0b7 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/revoke-publishable-api-key.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/revoke-publishable-api-key.ts @@ -42,7 +42,7 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * type: object * properties: * publishable_api_key: - * $ref: "#/components/schemas/publishable_api_key" + * $ref: "#/components/schemas/PublishableApiKey" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/update-publishable-api-key.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/update-publishable-api-key.ts index 4d7a03546f..724d87ae2d 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/update-publishable-api-key.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/update-publishable-api-key.ts @@ -57,7 +57,7 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" * type: object * properties: * publishable_api_key: - * $ref: "#/components/schemas/publishable_api_key" + * $ref: "#/components/schemas/PublishableApiKey" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/regions/add-country.ts b/packages/medusa/src/api/routes/admin/regions/add-country.ts index aa9c684ed4..cfaf4f13a3 100644 --- a/packages/medusa/src/api/routes/admin/regions/add-country.ts +++ b/packages/medusa/src/api/routes/admin/regions/add-country.ts @@ -64,7 +64,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * region: - * $ref: "#/components/schemas/region" + * $ref: "#/components/schemas/Region" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/regions/add-fulfillment-provider.ts b/packages/medusa/src/api/routes/admin/regions/add-fulfillment-provider.ts index 3c35da9f14..6a3408245a 100644 --- a/packages/medusa/src/api/routes/admin/regions/add-fulfillment-provider.ts +++ b/packages/medusa/src/api/routes/admin/regions/add-fulfillment-provider.ts @@ -61,7 +61,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * region: - * $ref: "#/components/schemas/region" + * $ref: "#/components/schemas/Region" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/regions/add-payment-provider.ts b/packages/medusa/src/api/routes/admin/regions/add-payment-provider.ts index 56caac41d9..fb98d424b9 100644 --- a/packages/medusa/src/api/routes/admin/regions/add-payment-provider.ts +++ b/packages/medusa/src/api/routes/admin/regions/add-payment-provider.ts @@ -61,7 +61,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * region: - * $ref: "#/components/schemas/region" + * $ref: "#/components/schemas/Region" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/regions/create-region.ts b/packages/medusa/src/api/routes/admin/regions/create-region.ts index ef08b04ca6..a509928f37 100644 --- a/packages/medusa/src/api/routes/admin/regions/create-region.ts +++ b/packages/medusa/src/api/routes/admin/regions/create-region.ts @@ -125,7 +125,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * region: - * $ref: "#/components/schemas/region" + * $ref: "#/components/schemas/Region" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/regions/get-region.ts b/packages/medusa/src/api/routes/admin/regions/get-region.ts index a51155784b..2838f6b06c 100644 --- a/packages/medusa/src/api/routes/admin/regions/get-region.ts +++ b/packages/medusa/src/api/routes/admin/regions/get-region.ts @@ -40,7 +40,7 @@ import RegionService from "../../../../services/region" * type: object * properties: * region: - * $ref: "#/components/schemas/region" + * $ref: "#/components/schemas/Region" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/regions/list-regions.ts b/packages/medusa/src/api/routes/admin/regions/list-regions.ts index 67574e23a5..23cdcc799d 100644 --- a/packages/medusa/src/api/routes/admin/regions/list-regions.ts +++ b/packages/medusa/src/api/routes/admin/regions/list-regions.ts @@ -79,7 +79,7 @@ import { validator } from "../../../../utils/validator" * regions: * type: array * items: - * $ref: "#/components/schemas/region" + * $ref: "#/components/schemas/Region" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/regions/remove-country.ts b/packages/medusa/src/api/routes/admin/regions/remove-country.ts index abe3ddad70..4c599334a5 100644 --- a/packages/medusa/src/api/routes/admin/regions/remove-country.ts +++ b/packages/medusa/src/api/routes/admin/regions/remove-country.ts @@ -50,7 +50,7 @@ import RegionService from "../../../../services/region" * type: object * properties: * region: - * $ref: "#/components/schemas/region" + * $ref: "#/components/schemas/Region" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/regions/remove-fulfillment-provider.ts b/packages/medusa/src/api/routes/admin/regions/remove-fulfillment-provider.ts index 47e31e9bfa..821e9a5b56 100644 --- a/packages/medusa/src/api/routes/admin/regions/remove-fulfillment-provider.ts +++ b/packages/medusa/src/api/routes/admin/regions/remove-fulfillment-provider.ts @@ -42,7 +42,7 @@ import RegionService from "../../../../services/region" * type: object * properties: * region: - * $ref: "#/components/schemas/region" + * $ref: "#/components/schemas/Region" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/regions/remove-payment-provider.ts b/packages/medusa/src/api/routes/admin/regions/remove-payment-provider.ts index 42ffb548d4..96266cb7b8 100644 --- a/packages/medusa/src/api/routes/admin/regions/remove-payment-provider.ts +++ b/packages/medusa/src/api/routes/admin/regions/remove-payment-provider.ts @@ -42,7 +42,7 @@ import RegionService from "../../../../services/region" * type: object * properties: * region: - * $ref: "#/components/schemas/region" + * $ref: "#/components/schemas/Region" * "400": * $ref: "#/components/responses/400_error" * "401": 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 3a1acc437f..b8c4e3d477 100644 --- a/packages/medusa/src/api/routes/admin/regions/update-region.ts +++ b/packages/medusa/src/api/routes/admin/regions/update-region.ts @@ -106,7 +106,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * region: - * $ref: "#/components/schemas/region" + * $ref: "#/components/schemas/Region" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/return-reasons/create-reason.ts b/packages/medusa/src/api/routes/admin/return-reasons/create-reason.ts index f87e588794..a14915bae2 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/create-reason.ts +++ b/packages/medusa/src/api/routes/admin/return-reasons/create-reason.ts @@ -76,7 +76,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * return_reason: - * $ref: "#/components/schemas/return_reason" + * $ref: "#/components/schemas/ReturnReason" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/return-reasons/get-reason.ts b/packages/medusa/src/api/routes/admin/return-reasons/get-reason.ts index 6be87fa633..d317a065fe 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/get-reason.ts +++ b/packages/medusa/src/api/routes/admin/return-reasons/get-reason.ts @@ -43,7 +43,7 @@ import { ReturnReasonService } from "../../../../services" * type: object * properties: * return_reason: - * $ref: "#/components/schemas/return_reason" + * $ref: "#/components/schemas/ReturnReason" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/return-reasons/list-reasons.ts b/packages/medusa/src/api/routes/admin/return-reasons/list-reasons.ts index 55b9493ea1..ac2ac445bc 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/list-reasons.ts +++ b/packages/medusa/src/api/routes/admin/return-reasons/list-reasons.ts @@ -4,7 +4,7 @@ import { } from "." import { ReturnReason } from "../../../../models" import { ReturnReasonService } from "../../../../services" -import { FindConfig, Selector } from "../../../../types/common" +import { Selector } from "../../../../types/common" /** * @oas [get] /return-reasons @@ -44,7 +44,7 @@ import { FindConfig, Selector } from "../../../../types/common" * return_reasons: * type: array * items: - * $ref: "#/components/schemas/return_reason" + * $ref: "#/components/schemas/ReturnReason" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/return-reasons/update-reason.ts b/packages/medusa/src/api/routes/admin/return-reasons/update-reason.ts index 2e19a83e4a..059528eadf 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/update-reason.ts +++ b/packages/medusa/src/api/routes/admin/return-reasons/update-reason.ts @@ -70,7 +70,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * return_reason: - * $ref: "#/components/schemas/return_reason" + * $ref: "#/components/schemas/ReturnReason" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/returns/cancel-return.ts b/packages/medusa/src/api/routes/admin/returns/cancel-return.ts index 9b08d3cb32..c443ad014a 100644 --- a/packages/medusa/src/api/routes/admin/returns/cancel-return.ts +++ b/packages/medusa/src/api/routes/admin/returns/cancel-return.ts @@ -42,7 +42,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/returns/list-returns.ts b/packages/medusa/src/api/routes/admin/returns/list-returns.ts index 0973159b76..b965751c81 100644 --- a/packages/medusa/src/api/routes/admin/returns/list-returns.ts +++ b/packages/medusa/src/api/routes/admin/returns/list-returns.ts @@ -46,7 +46,7 @@ import { Return } from "../../../../models" * returns: * type: array * items: - * $ref: "#/components/schemas/return" + * $ref: "#/components/schemas/Return" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/returns/receive-return.ts b/packages/medusa/src/api/routes/admin/returns/receive-return.ts index 09084a73bd..22c2a26c24 100644 --- a/packages/medusa/src/api/routes/admin/returns/receive-return.ts +++ b/packages/medusa/src/api/routes/admin/returns/receive-return.ts @@ -90,7 +90,7 @@ import { isDefined } from "medusa-core-utils" * type: object * properties: * return: - * $ref: "#/components/schemas/return" + * $ref: "#/components/schemas/Return" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/sales-channels/add-product-batch.ts b/packages/medusa/src/api/routes/admin/sales-channels/add-product-batch.ts index 56457ecbb0..1e5c866985 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/add-product-batch.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/add-product-batch.ts @@ -77,7 +77,7 @@ import { Type } from "class-transformer" * type: object * properties: * sales_channel: - * $ref: "#/components/schemas/sales_channel" + * $ref: "#/components/schemas/SalesChannel" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/sales-channels/create-sales-channel.ts b/packages/medusa/src/api/routes/admin/sales-channels/create-sales-channel.ts index 3c1e94d9dd..b83ce78c4a 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/create-sales-channel.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/create-sales-channel.ts @@ -65,7 +65,7 @@ import SalesChannelService from "../../../../services/sales-channel" * type: object * properties: * sales_channel: - * $ref: "#/components/schemas/sales_channel" + * $ref: "#/components/schemas/SalesChannel" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/sales-channels/delete-products-batch.ts b/packages/medusa/src/api/routes/admin/sales-channels/delete-products-batch.ts index bdcc8c5540..a586c51814 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/delete-products-batch.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/delete-products-batch.ts @@ -77,7 +77,7 @@ import { Type } from "class-transformer" * type: object * properties: * sales_channel: - * $ref: "#/components/schemas/sales_channel" + * $ref: "#/components/schemas/SalesChannel" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/sales-channels/get-sales-channel.ts b/packages/medusa/src/api/routes/admin/sales-channels/get-sales-channel.ts index 94bf92f8c7..12f7efa232 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/get-sales-channel.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/get-sales-channel.ts @@ -40,7 +40,7 @@ import { SalesChannelService } from "../../../../services" * type: object * properties: * sales_channel: - * $ref: "#/components/schemas/sales_channel" + * $ref: "#/components/schemas/SalesChannel" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/sales-channels/list-sales-channels.ts b/packages/medusa/src/api/routes/admin/sales-channels/list-sales-channels.ts index be7310befc..ce089e9896 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/list-sales-channels.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/list-sales-channels.ts @@ -122,7 +122,7 @@ import { Type } from "class-transformer" * sales_channels: * type: array * items: - * $ref: "#/components/schemas/sales_channel" + * $ref: "#/components/schemas/SalesChannel" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/sales-channels/update-sales-channel.ts b/packages/medusa/src/api/routes/admin/sales-channels/update-sales-channel.ts index cf744fba8b..da1ae7ae73 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/update-sales-channel.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/update-sales-channel.ts @@ -63,7 +63,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * sales_channel: - * $ref: "#/components/schemas/sales_channel" + * $ref: "#/components/schemas/SalesChannel" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/shipping-options/create-shipping-option.ts b/packages/medusa/src/api/routes/admin/shipping-options/create-shipping-option.ts index cec928dcf4..ce57ac396c 100644 --- a/packages/medusa/src/api/routes/admin/shipping-options/create-shipping-option.ts +++ b/packages/medusa/src/api/routes/admin/shipping-options/create-shipping-option.ts @@ -133,7 +133,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * shipping_option: - * $ref: "#/components/schemas/shipping_option" + * $ref: "#/components/schemas/ShippingOption" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/shipping-options/get-shipping-option.ts b/packages/medusa/src/api/routes/admin/shipping-options/get-shipping-option.ts index 617685e8ac..876f6b4a66 100644 --- a/packages/medusa/src/api/routes/admin/shipping-options/get-shipping-option.ts +++ b/packages/medusa/src/api/routes/admin/shipping-options/get-shipping-option.ts @@ -36,7 +36,7 @@ * type: object * properties: * shipping_option: - * $ref: "#/components/schemas/shipping_option" + * $ref: "#/components/schemas/ShippingOption" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/shipping-options/list-shipping-options.ts b/packages/medusa/src/api/routes/admin/shipping-options/list-shipping-options.ts index 4225e0dedb..ade87c8c80 100644 --- a/packages/medusa/src/api/routes/admin/shipping-options/list-shipping-options.ts +++ b/packages/medusa/src/api/routes/admin/shipping-options/list-shipping-options.ts @@ -60,7 +60,7 @@ import { validator } from "../../../../utils/validator" * shipping_options: * type: array * items: - * $ref: "#/components/schemas/shipping_option" + * $ref: "#/components/schemas/ShippingOption" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/shipping-options/update-shipping-option.ts b/packages/medusa/src/api/routes/admin/shipping-options/update-shipping-option.ts index ab61326d8f..9b0426b77d 100644 --- a/packages/medusa/src/api/routes/admin/shipping-options/update-shipping-option.ts +++ b/packages/medusa/src/api/routes/admin/shipping-options/update-shipping-option.ts @@ -114,7 +114,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * shipping_option: - * $ref: "#/components/schemas/shipping_option" + * $ref: "#/components/schemas/ShippingOption" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/shipping-profiles/create-shipping-profile.ts b/packages/medusa/src/api/routes/admin/shipping-profiles/create-shipping-profile.ts index c908a3eac9..de6d7718bd 100644 --- a/packages/medusa/src/api/routes/admin/shipping-profiles/create-shipping-profile.ts +++ b/packages/medusa/src/api/routes/admin/shipping-profiles/create-shipping-profile.ts @@ -56,7 +56,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * shipping_profile: - * $ref: "#/components/schemas/shipping_profile" + * $ref: "#/components/schemas/ShippingProfile" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/shipping-profiles/get-shipping-profile.ts b/packages/medusa/src/api/routes/admin/shipping-profiles/get-shipping-profile.ts index fc5005e9a7..74f7edde97 100644 --- a/packages/medusa/src/api/routes/admin/shipping-profiles/get-shipping-profile.ts +++ b/packages/medusa/src/api/routes/admin/shipping-profiles/get-shipping-profile.ts @@ -43,7 +43,7 @@ import { ShippingProfileService } from "../../../../services" * type: object * properties: * shipping_profile: - * $ref: "#/components/schemas/shipping_profile" + * $ref: "#/components/schemas/ShippingProfile" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/shipping-profiles/list-shipping-profiles.ts b/packages/medusa/src/api/routes/admin/shipping-profiles/list-shipping-profiles.ts index 7c00d91d95..cc16e82a12 100644 --- a/packages/medusa/src/api/routes/admin/shipping-profiles/list-shipping-profiles.ts +++ b/packages/medusa/src/api/routes/admin/shipping-profiles/list-shipping-profiles.ts @@ -38,7 +38,7 @@ import { ShippingProfileService } from "../../../../services" * shipping_profiles: * type: array * items: - * $ref: "#/components/schemas/shipping_profile" + * $ref: "#/components/schemas/ShippingProfile" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/shipping-profiles/update-shipping-profile.ts b/packages/medusa/src/api/routes/admin/shipping-profiles/update-shipping-profile.ts index 9e33e03833..9a352a6b2b 100644 --- a/packages/medusa/src/api/routes/admin/shipping-profiles/update-shipping-profile.ts +++ b/packages/medusa/src/api/routes/admin/shipping-profiles/update-shipping-profile.ts @@ -56,7 +56,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * shipping_profile: - * $ref: "#/components/schemas/shipping_profile" + * $ref: "#/components/schemas/ShippingProfile" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/store/add-currency.ts b/packages/medusa/src/api/routes/admin/store/add-currency.ts index 98b9ed2ec3..5b448ed3c7 100644 --- a/packages/medusa/src/api/routes/admin/store/add-currency.ts +++ b/packages/medusa/src/api/routes/admin/store/add-currency.ts @@ -1,5 +1,6 @@ import { StoreService } from "../../../../services" import { EntityManager } from "typeorm" + /** * @oas [post] /store/currencies/{code} * operationId: "PostStoreCurrenciesCode" @@ -46,7 +47,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * store: - * $ref: "#/components/schemas/store" + * $ref: "#/components/schemas/Store" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/store/get-store.ts b/packages/medusa/src/api/routes/admin/store/get-store.ts index b94c2c2ee4..6a7cba06bc 100644 --- a/packages/medusa/src/api/routes/admin/store/get-store.ts +++ b/packages/medusa/src/api/routes/admin/store/get-store.ts @@ -45,7 +45,7 @@ import { ModulesHelper } from "../../../../utils/module-helper" * type: object * properties: * store: - * $ref: "#/components/schemas/store" + * $ref: "#/components/schemas/Store" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/store/list-payment-providers.ts b/packages/medusa/src/api/routes/admin/store/list-payment-providers.ts index 712e13ae6d..9faa07e579 100644 --- a/packages/medusa/src/api/routes/admin/store/list-payment-providers.ts +++ b/packages/medusa/src/api/routes/admin/store/list-payment-providers.ts @@ -1,4 +1,5 @@ import { PaymentProviderService } from "../../../../services" + /** * @oas [get] /store/payment-providers * operationId: "GetStorePaymentProviders" @@ -37,7 +38,7 @@ import { PaymentProviderService } from "../../../../services" * payment_providers: * type: array * items: - * $ref: "#/components/schemas/payment_provider" + * $ref: "#/components/schemas/PaymentProvider" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/store/list-tax-providers.ts b/packages/medusa/src/api/routes/admin/store/list-tax-providers.ts index eed2384400..bb5cdf61b2 100644 --- a/packages/medusa/src/api/routes/admin/store/list-tax-providers.ts +++ b/packages/medusa/src/api/routes/admin/store/list-tax-providers.ts @@ -38,7 +38,7 @@ import { TaxProviderService } from "../../../../services" * tax_providers: * type: array * items: - * $ref: "#/components/schemas/tax_provider" + * $ref: "#/components/schemas/TaxProvider" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/store/remove-currency.ts b/packages/medusa/src/api/routes/admin/store/remove-currency.ts index 7bea006204..5d39607da9 100644 --- a/packages/medusa/src/api/routes/admin/store/remove-currency.ts +++ b/packages/medusa/src/api/routes/admin/store/remove-currency.ts @@ -47,7 +47,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * store: - * $ref: "#/components/schemas/store" + * $ref: "#/components/schemas/Store" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/store/update-store.ts b/packages/medusa/src/api/routes/admin/store/update-store.ts index c6c868b337..fd959f5cce 100644 --- a/packages/medusa/src/api/routes/admin/store/update-store.ts +++ b/packages/medusa/src/api/routes/admin/store/update-store.ts @@ -78,7 +78,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * store: - * $ref: "#/components/schemas/store" + * $ref: "#/components/schemas/Store" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/swaps/get-swap.ts b/packages/medusa/src/api/routes/admin/swaps/get-swap.ts index debed6058a..8e47f0e789 100644 --- a/packages/medusa/src/api/routes/admin/swaps/get-swap.ts +++ b/packages/medusa/src/api/routes/admin/swaps/get-swap.ts @@ -40,7 +40,7 @@ import { SwapService } from "../../../../services" * type: object * properties: * swap: - * $ref: "#/components/schemas/swap" + * $ref: "#/components/schemas/Swap" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/swaps/list-swaps.ts b/packages/medusa/src/api/routes/admin/swaps/list-swaps.ts index 227fa3785a..2533d48a34 100644 --- a/packages/medusa/src/api/routes/admin/swaps/list-swaps.ts +++ b/packages/medusa/src/api/routes/admin/swaps/list-swaps.ts @@ -47,7 +47,7 @@ import { Swap } from "../../../../models" * swaps: * type: array * items: - * $ref: "#/components/schemas/swap" + * $ref: "#/components/schemas/Swap" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/tax-rates/add-to-product-types.ts b/packages/medusa/src/api/routes/admin/tax-rates/add-to-product-types.ts index a81a33d002..916ad9854e 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/add-to-product-types.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/add-to-product-types.ts @@ -85,7 +85,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * tax_rate: - * $ref: "#/components/schemas/tax_rate" + * $ref: "#/components/schemas/TaxRate" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/tax-rates/add-to-products.ts b/packages/medusa/src/api/routes/admin/tax-rates/add-to-products.ts index 0f865b5a5a..8d7d68d127 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/add-to-products.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/add-to-products.ts @@ -85,7 +85,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * tax_rate: - * $ref: "#/components/schemas/tax_rate" + * $ref: "#/components/schemas/TaxRate" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/tax-rates/add-to-shipping-options.ts b/packages/medusa/src/api/routes/admin/tax-rates/add-to-shipping-options.ts index e00040cc98..711d34817f 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/add-to-shipping-options.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/add-to-shipping-options.ts @@ -85,7 +85,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * tax_rate: - * $ref: "#/components/schemas/tax_rate" + * $ref: "#/components/schemas/TaxRate" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/tax-rates/create-tax-rate.ts b/packages/medusa/src/api/routes/admin/tax-rates/create-tax-rate.ts index f3b435d067..ca5651946b 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/create-tax-rate.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/create-tax-rate.ts @@ -111,7 +111,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * tax_rate: - * $ref: "#/components/schemas/tax_rate" + * $ref: "#/components/schemas/TaxRate" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts b/packages/medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts index 10a97f5cad..3fc0efc649 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts @@ -61,7 +61,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * tax_rate: - * $ref: "#/components/schemas/tax_rate" + * $ref: "#/components/schemas/TaxRate" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/tax-rates/list-tax-rates.ts b/packages/medusa/src/api/routes/admin/tax-rates/list-tax-rates.ts index d4808d9c69..49103a3072 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/list-tax-rates.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/list-tax-rates.ts @@ -103,7 +103,7 @@ import { validator } from "../../../../utils/validator" * tax_rates: * type: array * items: - * $ref: "#/components/schemas/tax_rate" + * $ref: "#/components/schemas/TaxRate" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-product-types.ts b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-product-types.ts index 6399e154ab..194490e9ef 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-product-types.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-product-types.ts @@ -85,7 +85,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * tax_rate: - * $ref: "#/components/schemas/tax_rate" + * $ref: "#/components/schemas/TaxRate" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-products.ts b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-products.ts index 87a7035f8b..71a59a4230 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-products.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-products.ts @@ -85,7 +85,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * tax_rate: - * $ref: "#/components/schemas/tax_rate" + * $ref: "#/components/schemas/TaxRate" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-shipping-options.ts b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-shipping-options.ts index 4cce265d2a..e754198511 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/remove-from-shipping-options.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/remove-from-shipping-options.ts @@ -85,7 +85,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * tax_rate: - * $ref: "#/components/schemas/tax_rate" + * $ref: "#/components/schemas/TaxRate" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/tax-rates/update-tax-rate.ts b/packages/medusa/src/api/routes/admin/tax-rates/update-tax-rate.ts index be11f888ce..cc1863679c 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/update-tax-rate.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/update-tax-rate.ts @@ -104,7 +104,7 @@ import { isDefined } from "medusa-core-utils" * type: object * properties: * tax_rate: - * $ref: "#/components/schemas/tax_rate" + * $ref: "#/components/schemas/TaxRate" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/users/create-user.ts b/packages/medusa/src/api/routes/admin/users/create-user.ts index 507f7a8a72..ca9410d988 100644 --- a/packages/medusa/src/api/routes/admin/users/create-user.ts +++ b/packages/medusa/src/api/routes/admin/users/create-user.ts @@ -77,7 +77,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * user: - * $ref: "#/components/schemas/user" + * $ref: "#/components/schemas/User" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/users/get-user.ts b/packages/medusa/src/api/routes/admin/users/get-user.ts index f491812dae..c6c1842f76 100644 --- a/packages/medusa/src/api/routes/admin/users/get-user.ts +++ b/packages/medusa/src/api/routes/admin/users/get-user.ts @@ -38,7 +38,7 @@ import UserService from "../../../../services/user" * type: object * properties: * user: - * $ref: "#/components/schemas/user" + * $ref: "#/components/schemas/User" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/users/list-users.ts b/packages/medusa/src/api/routes/admin/users/list-users.ts index 8f98c44352..7a7d0fabff 100644 --- a/packages/medusa/src/api/routes/admin/users/list-users.ts +++ b/packages/medusa/src/api/routes/admin/users/list-users.ts @@ -38,7 +38,7 @@ import UserService from "../../../../services/user" * users: * type: array * items: - * $ref: "#/components/schemas/user" + * $ref: "#/components/schemas/User" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/users/reset-password.ts b/packages/medusa/src/api/routes/admin/users/reset-password.ts index 4a92d99d01..b1bbcac646 100644 --- a/packages/medusa/src/api/routes/admin/users/reset-password.ts +++ b/packages/medusa/src/api/routes/admin/users/reset-password.ts @@ -72,7 +72,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * user: - * $ref: "#/components/schemas/user" + * $ref: "#/components/schemas/User" * "400": * $ref: "#/components/responses/400_error" * "401": @@ -136,6 +136,7 @@ export type payload = { user_id: string password: string } + export class AdminResetPasswordRequest { @IsEmail() @IsOptional() diff --git a/packages/medusa/src/api/routes/admin/users/update-user.ts b/packages/medusa/src/api/routes/admin/users/update-user.ts index 8bf7567fdb..a34e2c04ee 100644 --- a/packages/medusa/src/api/routes/admin/users/update-user.ts +++ b/packages/medusa/src/api/routes/admin/users/update-user.ts @@ -71,7 +71,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * user: - * $ref: "#/components/schemas/user" + * $ref: "#/components/schemas/User" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/admin/variants/list-variants.ts b/packages/medusa/src/api/routes/admin/variants/list-variants.ts index a62ff2b39e..30d44c97a1 100644 --- a/packages/medusa/src/api/routes/admin/variants/list-variants.ts +++ b/packages/medusa/src/api/routes/admin/variants/list-variants.ts @@ -96,7 +96,7 @@ import { IsType } from "../../../../utils/validators/is-type" * variants: * type: array * items: - * $ref: "#/components/schemas/product_variant" + * $ref: "#/components/schemas/ProductVariant" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/store/auth/create-session.ts b/packages/medusa/src/api/routes/store/auth/create-session.ts index 4566c27c31..c84f2fbdb1 100644 --- a/packages/medusa/src/api/routes/store/auth/create-session.ts +++ b/packages/medusa/src/api/routes/store/auth/create-session.ts @@ -46,7 +46,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * customer: - * $ref: "#/components/schemas/customer" + * $ref: "#/components/schemas/Customer" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/store/auth/get-session.ts b/packages/medusa/src/api/routes/store/auth/get-session.ts index 07e9f41107..9458bd140c 100644 --- a/packages/medusa/src/api/routes/store/auth/get-session.ts +++ b/packages/medusa/src/api/routes/store/auth/get-session.ts @@ -35,7 +35,7 @@ import CustomerService from "../../../../services/customer" * type: object * properties: * customer: - * $ref: "#/components/schemas/customer" + * $ref: "#/components/schemas/Customer" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/store/carts/add-shipping-method.ts b/packages/medusa/src/api/routes/store/carts/add-shipping-method.ts index ae914bec9e..b500719c3d 100644 --- a/packages/medusa/src/api/routes/store/carts/add-shipping-method.ts +++ b/packages/medusa/src/api/routes/store/carts/add-shipping-method.ts @@ -45,7 +45,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * cart: - * $ref: "#/components/schemas/cart" + * $ref: "#/components/schemas/Cart" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/carts/calculate-taxes.ts b/packages/medusa/src/api/routes/store/carts/calculate-taxes.ts index 1d5a268570..39b9759dcd 100644 --- a/packages/medusa/src/api/routes/store/carts/calculate-taxes.ts +++ b/packages/medusa/src/api/routes/store/carts/calculate-taxes.ts @@ -27,7 +27,7 @@ import { IdempotencyKey } from "../../../../models/idempotency-key" * type: object * properties: * cart: - * $ref: "#/components/schemas/cart" + * $ref: "#/components/schemas/Cart" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/carts/complete-cart.ts b/packages/medusa/src/api/routes/store/carts/complete-cart.ts index f8bdf10cd0..cf3ea3e747 100644 --- a/packages/medusa/src/api/routes/store/carts/complete-cart.ts +++ b/packages/medusa/src/api/routes/store/carts/complete-cart.ts @@ -54,17 +54,17 @@ import { IdempotencyKeyService } from "../../../../services" * description: Cart was successfully authorized and order was placed successfully. * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * - type: object * description: Cart was successfully authorized but requires further actions. * properties: * cart: - * $ref: "#/components/schemas/cart" + * $ref: "#/components/schemas/Cart" * - type: object * description: When cart is used for a swap and it has been completed successfully. * properties: * cart: - * $ref: "#/components/schemas/swap" + * $ref: "#/components/schemas/Swap" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/carts/create-cart.ts b/packages/medusa/src/api/routes/store/carts/create-cart.ts index 383f5dffc0..f38196e38c 100644 --- a/packages/medusa/src/api/routes/store/carts/create-cart.ts +++ b/packages/medusa/src/api/routes/store/carts/create-cart.ts @@ -95,7 +95,7 @@ import PublishableAPIKeysFeatureFlag from "../../../../loaders/feature-flags/pub * type: object * properties: * cart: - * $ref: "#/components/schemas/cart" + * $ref: "#/components/schemas/Cart" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/carts/create-line-item/index.ts b/packages/medusa/src/api/routes/store/carts/create-line-item/index.ts index c7fcf7b054..d3fd9b0627 100644 --- a/packages/medusa/src/api/routes/store/carts/create-line-item/index.ts +++ b/packages/medusa/src/api/routes/store/carts/create-line-item/index.ts @@ -56,7 +56,7 @@ import { * type: object * properties: * cart: - * $ref: "#/components/schemas/cart" + * $ref: "#/components/schemas/Cart" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/carts/create-payment-sessions.ts b/packages/medusa/src/api/routes/store/carts/create-payment-sessions.ts index b533249ed2..a0c8388269 100644 --- a/packages/medusa/src/api/routes/store/carts/create-payment-sessions.ts +++ b/packages/medusa/src/api/routes/store/carts/create-payment-sessions.ts @@ -35,7 +35,7 @@ import IdempotencyKeyService from "../../../../services/idempotency-key" * type: object * properties: * cart: - * $ref: "#/components/schemas/cart" + * $ref: "#/components/schemas/Cart" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/carts/delete-discount.ts b/packages/medusa/src/api/routes/store/carts/delete-discount.ts index 7c7bb579de..004665c95d 100644 --- a/packages/medusa/src/api/routes/store/carts/delete-discount.ts +++ b/packages/medusa/src/api/routes/store/carts/delete-discount.ts @@ -35,7 +35,7 @@ import { CartService } from "../../../../services" * type: object * properties: * cart: - * $ref: "#/components/schemas/cart" + * $ref: "#/components/schemas/Cart" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/carts/delete-line-item.ts b/packages/medusa/src/api/routes/store/carts/delete-line-item.ts index 23d41383f1..97c6caa2a0 100644 --- a/packages/medusa/src/api/routes/store/carts/delete-line-item.ts +++ b/packages/medusa/src/api/routes/store/carts/delete-line-item.ts @@ -35,7 +35,7 @@ import { CartService } from "../../../../services" * type: object * properties: * cart: - * $ref: "#/components/schemas/cart" + * $ref: "#/components/schemas/Cart" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/carts/delete-payment-session.ts b/packages/medusa/src/api/routes/store/carts/delete-payment-session.ts index 0fda903680..d207733e14 100644 --- a/packages/medusa/src/api/routes/store/carts/delete-payment-session.ts +++ b/packages/medusa/src/api/routes/store/carts/delete-payment-session.ts @@ -35,7 +35,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * cart: - * $ref: "#/components/schemas/cart" + * $ref: "#/components/schemas/Cart" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/carts/get-cart.ts b/packages/medusa/src/api/routes/store/carts/get-cart.ts index 838c234d18..141825f1b0 100644 --- a/packages/medusa/src/api/routes/store/carts/get-cart.ts +++ b/packages/medusa/src/api/routes/store/carts/get-cart.ts @@ -32,7 +32,7 @@ import { CartService } from "../../../../services" * type: object * properties: * cart: - * $ref: "#/components/schemas/cart" + * $ref: "#/components/schemas/Cart" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/carts/refresh-payment-session.ts b/packages/medusa/src/api/routes/store/carts/refresh-payment-session.ts index 1df499db46..ad85829fc0 100644 --- a/packages/medusa/src/api/routes/store/carts/refresh-payment-session.ts +++ b/packages/medusa/src/api/routes/store/carts/refresh-payment-session.ts @@ -34,7 +34,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * cart: - * $ref: "#/components/schemas/cart" + * $ref: "#/components/schemas/Cart" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/carts/set-payment-session.ts b/packages/medusa/src/api/routes/store/carts/set-payment-session.ts index 997d6091e5..abd6da0c21 100644 --- a/packages/medusa/src/api/routes/store/carts/set-payment-session.ts +++ b/packages/medusa/src/api/routes/store/carts/set-payment-session.ts @@ -44,7 +44,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * cart: - * $ref: "#/components/schemas/cart" + * $ref: "#/components/schemas/Cart" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/carts/update-cart.ts b/packages/medusa/src/api/routes/store/carts/update-cart.ts index 96ba3771a1..6a43fe0761 100644 --- a/packages/medusa/src/api/routes/store/carts/update-cart.ts +++ b/packages/medusa/src/api/routes/store/carts/update-cart.ts @@ -47,14 +47,14 @@ import { IsType } from "../../../../utils/validators/is-type" * billing_address: * description: "The Address to be used for billing purposes." * anyOf: - * - $ref: "#/components/schemas/address" + * - $ref: "#/components/schemas/Address" * description: A full billing address object. * - type: string * description: The billing address ID * shipping_address: * description: "The Address to be used for shipping." * anyOf: - * - $ref: "#/components/schemas/address" + * - $ref: "#/components/schemas/Address" * description: A full shipping address object. * - type: string * description: The shipping address ID @@ -118,7 +118,7 @@ import { IsType } from "../../../../utils/validators/is-type" * type: object * properties: * cart: - * $ref: "#/components/schemas/cart" + * $ref: "#/components/schemas/Cart" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/carts/update-line-item.ts b/packages/medusa/src/api/routes/store/carts/update-line-item.ts index 82d3acdafc..3ff5913b03 100644 --- a/packages/medusa/src/api/routes/store/carts/update-line-item.ts +++ b/packages/medusa/src/api/routes/store/carts/update-line-item.ts @@ -45,7 +45,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * cart: - * $ref: "#/components/schemas/cart" + * $ref: "#/components/schemas/Cart" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/carts/update-payment-session.ts b/packages/medusa/src/api/routes/store/carts/update-payment-session.ts index 760c430252..439dcec7a6 100644 --- a/packages/medusa/src/api/routes/store/carts/update-payment-session.ts +++ b/packages/medusa/src/api/routes/store/carts/update-payment-session.ts @@ -46,7 +46,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * cart: - * $ref: "#/components/schemas/cart" + * $ref: "#/components/schemas/Cart" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/collections/get-collection.ts b/packages/medusa/src/api/routes/store/collections/get-collection.ts index f886f74ac8..7612346290 100644 --- a/packages/medusa/src/api/routes/store/collections/get-collection.ts +++ b/packages/medusa/src/api/routes/store/collections/get-collection.ts @@ -1,4 +1,5 @@ import ProductCollectionService from "../../../../services/product-collection" + /** * @oas [get] /collections/{id} * operationId: "GetCollectionsCollection" @@ -31,7 +32,7 @@ import ProductCollectionService from "../../../../services/product-collection" * type: object * properties: * collection: - * $ref: "#/components/schemas/product_collection" + * $ref: "#/components/schemas/ProductCollection" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/collections/list-collections.ts b/packages/medusa/src/api/routes/store/collections/list-collections.ts index 007fc4b401..2f01be536d 100644 --- a/packages/medusa/src/api/routes/store/collections/list-collections.ts +++ b/packages/medusa/src/api/routes/store/collections/list-collections.ts @@ -83,7 +83,7 @@ import { Type } from "class-transformer" * collections: * type: array * items: - * $ref: "#/components/schemas/product_collection" + * $ref: "#/components/schemas/ProductCollection" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/store/customers/create-address.ts b/packages/medusa/src/api/routes/store/customers/create-address.ts index 9049f67c27..79d2f61111 100644 --- a/packages/medusa/src/api/routes/store/customers/create-address.ts +++ b/packages/medusa/src/api/routes/store/customers/create-address.ts @@ -23,7 +23,7 @@ import { validator } from "../../../../utils/validator" * address: * description: "The Address to add to the Customer." * allOf: - * - $ref: "#/components/schemas/address_fields" + * - $ref: "#/components/schemas/AddressFields" * - type: object * required: * - first_name @@ -86,7 +86,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * customer: - * $ref: "#/components/schemas/customer" + * $ref: "#/components/schemas/Customer" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/store/customers/create-customer.ts b/packages/medusa/src/api/routes/store/customers/create-customer.ts index b3fb9d2446..50426677fa 100644 --- a/packages/medusa/src/api/routes/store/customers/create-customer.ts +++ b/packages/medusa/src/api/routes/store/customers/create-customer.ts @@ -77,7 +77,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * customer: - * $ref: "#/components/schemas/customer" + * $ref: "#/components/schemas/Customer" * 422: * description: A customer with the same email exists * content: diff --git a/packages/medusa/src/api/routes/store/customers/delete-address.ts b/packages/medusa/src/api/routes/store/customers/delete-address.ts index 6171161e23..c23dbde489 100644 --- a/packages/medusa/src/api/routes/store/customers/delete-address.ts +++ b/packages/medusa/src/api/routes/store/customers/delete-address.ts @@ -40,7 +40,7 @@ import CustomerService from "../../../../services/customer" * type: object * properties: * customer: - * $ref: "#/components/schemas/customer" + * $ref: "#/components/schemas/Customer" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/store/customers/get-customer.ts b/packages/medusa/src/api/routes/store/customers/get-customer.ts index 5d61fc04b5..9c89a9152c 100644 --- a/packages/medusa/src/api/routes/store/customers/get-customer.ts +++ b/packages/medusa/src/api/routes/store/customers/get-customer.ts @@ -36,7 +36,7 @@ import CustomerService from "../../../../services/customer" * type: object * properties: * customer: - * $ref: "#/components/schemas/customer" + * $ref: "#/components/schemas/Customer" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/store/customers/list-orders.ts b/packages/medusa/src/api/routes/store/customers/list-orders.ts index 88335ccd69..0bbe7afe38 100644 --- a/packages/medusa/src/api/routes/store/customers/list-orders.ts +++ b/packages/medusa/src/api/routes/store/customers/list-orders.ts @@ -168,7 +168,7 @@ import { DateComparisonOperator } from "../../../../types/common" * orders: * type: array * items: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/store/customers/reset-password.ts b/packages/medusa/src/api/routes/store/customers/reset-password.ts index a8b8e5ee15..d11ef59a2c 100644 --- a/packages/medusa/src/api/routes/store/customers/reset-password.ts +++ b/packages/medusa/src/api/routes/store/customers/reset-password.ts @@ -66,7 +66,7 @@ import { EntityManager } from "typeorm" * type: object * properties: * customer: - * $ref: "#/components/schemas/customer" + * $ref: "#/components/schemas/Customer" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/store/customers/update-address.ts b/packages/medusa/src/api/routes/store/customers/update-address.ts index 2ccae29468..4cd01f7887 100644 --- a/packages/medusa/src/api/routes/store/customers/update-address.ts +++ b/packages/medusa/src/api/routes/store/customers/update-address.ts @@ -18,7 +18,7 @@ import { validator } from "../../../../utils/validator" * application/json: * schema: * anyOf: - * - $ref: "#/components/schemas/address_fields" + * - $ref: "#/components/schemas/AddressFields" * x-codeSamples: * - lang: JavaScript * label: JS Client @@ -54,7 +54,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * customer: - * $ref: "#/components/schemas/customer" + * $ref: "#/components/schemas/Customer" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/store/customers/update-customer.ts b/packages/medusa/src/api/routes/store/customers/update-customer.ts index 38ad570d5a..0d396a6d0a 100644 --- a/packages/medusa/src/api/routes/store/customers/update-customer.ts +++ b/packages/medusa/src/api/routes/store/customers/update-customer.ts @@ -28,7 +28,7 @@ import { IsType } from "../../../../utils/validators/is-type" * billing_address: * description: "The Address to be used for billing purposes." * anyOf: - * - $ref: "#/components/schemas/address_fields" + * - $ref: "#/components/schemas/AddressFields" * description: The full billing address object * - type: string * description: The ID of an existing billing address @@ -79,7 +79,7 @@ import { IsType } from "../../../../utils/validators/is-type" * type: object * properties: * customer: - * $ref: "#/components/schemas/customer" + * $ref: "#/components/schemas/Customer" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/store/gift-cards/get-gift-card.ts b/packages/medusa/src/api/routes/store/gift-cards/get-gift-card.ts index 31f93dbc87..d1b18cb1c4 100644 --- a/packages/medusa/src/api/routes/store/gift-cards/get-gift-card.ts +++ b/packages/medusa/src/api/routes/store/gift-cards/get-gift-card.ts @@ -34,7 +34,7 @@ import GiftCardService from "../../../../services/gift-card" * type: object * properties: * gift_card: - * $ref: "#/components/schemas/gift_card" + * $ref: "#/components/schemas/GiftCard" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/order-edits/complete-order-edit.ts b/packages/medusa/src/api/routes/store/order-edits/complete-order-edit.ts index bd2faaf340..0908ebc1e8 100644 --- a/packages/medusa/src/api/routes/store/order-edits/complete-order-edit.ts +++ b/packages/medusa/src/api/routes/store/order-edits/complete-order-edit.ts @@ -44,7 +44,7 @@ import { MedusaError } from "medusa-core-utils" * type: object * properties: * order_edit: - * $ref: "#/components/schemas/order_edit" + * $ref: "#/components/schemas/OrderEdit" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/store/order-edits/decline-order-edit.ts b/packages/medusa/src/api/routes/store/order-edits/decline-order-edit.ts index c98969100b..2da914c89b 100644 --- a/packages/medusa/src/api/routes/store/order-edits/decline-order-edit.ts +++ b/packages/medusa/src/api/routes/store/order-edits/decline-order-edit.ts @@ -48,7 +48,7 @@ import { * type: object * properties: * order_edit: - * $ref: "#/components/schemas/order_edit" + * $ref: "#/components/schemas/OrderEdit" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/store/order-edits/get-order-edit.ts b/packages/medusa/src/api/routes/store/order-edits/get-order-edit.ts index c65a2dc8c9..a53d76d1d6 100644 --- a/packages/medusa/src/api/routes/store/order-edits/get-order-edit.ts +++ b/packages/medusa/src/api/routes/store/order-edits/get-order-edit.ts @@ -33,7 +33,7 @@ import { OrderEditService } from "../../../../services" * type: object * properties: * order_edit: - * $ref: "#/components/schemas/order_edit" + * $ref: "#/components/schemas/OrderEdit" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/store/orders/get-order-by-cart.ts b/packages/medusa/src/api/routes/store/orders/get-order-by-cart.ts index 6133aaffd6..dc73c8bb65 100644 --- a/packages/medusa/src/api/routes/store/orders/get-order-by-cart.ts +++ b/packages/medusa/src/api/routes/store/orders/get-order-by-cart.ts @@ -34,7 +34,7 @@ import { OrderService } from "../../../../services" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/orders/get-order.ts b/packages/medusa/src/api/routes/store/orders/get-order.ts index 703d3b4f41..77432c2997 100644 --- a/packages/medusa/src/api/routes/store/orders/get-order.ts +++ b/packages/medusa/src/api/routes/store/orders/get-order.ts @@ -34,7 +34,7 @@ import { OrderService } from "../../../../services" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/orders/lookup-order.ts b/packages/medusa/src/api/routes/store/orders/lookup-order.ts index 6acafcf68c..8457b4ff83 100644 --- a/packages/medusa/src/api/routes/store/orders/lookup-order.ts +++ b/packages/medusa/src/api/routes/store/orders/lookup-order.ts @@ -66,7 +66,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * order: - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/payment-collections/authorize-batch-payment-sessions.ts b/packages/medusa/src/api/routes/store/payment-collections/authorize-batch-payment-sessions.ts index 3d026929e2..d379f8ab24 100644 --- a/packages/medusa/src/api/routes/store/payment-collections/authorize-batch-payment-sessions.ts +++ b/packages/medusa/src/api/routes/store/payment-collections/authorize-batch-payment-sessions.ts @@ -47,7 +47,7 @@ import { PaymentCollectionService } from "../../../../services" * schema: * properties: * payment_collection: - * $ref: "#/components/schemas/payment_collection" + * $ref: "#/components/schemas/PaymentCollection" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/store/payment-collections/authorize-payment-session.ts b/packages/medusa/src/api/routes/store/payment-collections/authorize-payment-session.ts index 66004ef61d..b2d580b3c0 100644 --- a/packages/medusa/src/api/routes/store/payment-collections/authorize-payment-session.ts +++ b/packages/medusa/src/api/routes/store/payment-collections/authorize-payment-session.ts @@ -39,7 +39,7 @@ import { PaymentCollectionService } from "../../../../services" * schema: * properties: * payment_session: - * $ref: "#/components/schemas/payment_session" + * $ref: "#/components/schemas/PaymentSession" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/store/payment-collections/get-payment-collection.ts b/packages/medusa/src/api/routes/store/payment-collections/get-payment-collection.ts index c5e39a1ee2..b6402497b3 100644 --- a/packages/medusa/src/api/routes/store/payment-collections/get-payment-collection.ts +++ b/packages/medusa/src/api/routes/store/payment-collections/get-payment-collection.ts @@ -40,7 +40,7 @@ import { FindParams } from "../../../../types/common" * type: object * properties: * payment_collection: - * $ref: "#/components/schemas/payment_collection" + * $ref: "#/components/schemas/PaymentCollection" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/store/payment-collections/manage-batch-payment-sessions.ts b/packages/medusa/src/api/routes/store/payment-collections/manage-batch-payment-sessions.ts index 560d4f641e..b7d13850be 100644 --- a/packages/medusa/src/api/routes/store/payment-collections/manage-batch-payment-sessions.ts +++ b/packages/medusa/src/api/routes/store/payment-collections/manage-batch-payment-sessions.ts @@ -87,7 +87,7 @@ import { PaymentCollectionService } from "../../../../services" * schema: * properties: * payment_collection: - * $ref: "#/components/schemas/payment_collection" + * $ref: "#/components/schemas/PaymentCollection" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/store/payment-collections/manage-payment-session.ts b/packages/medusa/src/api/routes/store/payment-collections/manage-payment-session.ts index 115cd0a283..380c002443 100644 --- a/packages/medusa/src/api/routes/store/payment-collections/manage-payment-session.ts +++ b/packages/medusa/src/api/routes/store/payment-collections/manage-payment-session.ts @@ -54,7 +54,7 @@ import { PaymentCollectionService } from "../../../../services" * schema: * properties: * payment_collection: - * $ref: "#/components/schemas/payment_collection" + * $ref: "#/components/schemas/PaymentCollection" * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/packages/medusa/src/api/routes/store/payment-collections/refresh-payment-session.ts b/packages/medusa/src/api/routes/store/payment-collections/refresh-payment-session.ts index 5e61af151e..ee2d771e37 100644 --- a/packages/medusa/src/api/routes/store/payment-collections/refresh-payment-session.ts +++ b/packages/medusa/src/api/routes/store/payment-collections/refresh-payment-session.ts @@ -1,5 +1,3 @@ -import { IsInt, IsNotEmpty, IsString } from "class-validator" - import { EntityManager } from "typeorm" import { PaymentCollectionService } from "../../../../services" @@ -52,7 +50,7 @@ import { PaymentCollectionService } from "../../../../services" * type: object * properties: * payment_session: - * $ref: "#/components/schemas/payment_session" + * $ref: "#/components/schemas/PaymentSession" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/product-types/list-product-types.ts b/packages/medusa/src/api/routes/store/product-types/list-product-types.ts index b326fc5230..6a760cad7a 100644 --- a/packages/medusa/src/api/routes/store/product-types/list-product-types.ts +++ b/packages/medusa/src/api/routes/store/product-types/list-product-types.ts @@ -112,7 +112,7 @@ import ProductTypeService from "../../../../services/product-type" * type: object * properties: * product_types: - * $ref: "#/components/schemas/product_type" + * $ref: "#/components/schemas/ProductType" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/store/products/get-product.ts b/packages/medusa/src/api/routes/store/products/get-product.ts index b44b79a3fc..65acdd6bb4 100644 --- a/packages/medusa/src/api/routes/store/products/get-product.ts +++ b/packages/medusa/src/api/routes/store/products/get-product.ts @@ -1,8 +1,8 @@ import { defaultStoreProductsRelations } from "." import { - ProductService, - PricingService, CartService, + PricingService, + ProductService, RegionService, } from "../../../../services" import { PriceSelectionParams } from "../../../../types/price-selection" @@ -53,15 +53,15 @@ import { validator } from "../../../../utils/validator" * properties: * product: * allOf: - * - $ref: "#/components/schemas/product" + * - $ref: "#/components/schemas/Product" * - type: object * properties: * variants: * type: array * items: * allOf: - * - $ref: "#/components/schemas/product_variant" - * - $ref: "#/components/schemas/product_variant_prices_fields" + * - $ref: "#/components/schemas/ProductVariant" + * - $ref: "#/components/schemas/ProductVariantPricesFields" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/products/list-products.ts b/packages/medusa/src/api/routes/store/products/list-products.ts index 2ea7ad9b60..cc5511c91f 100644 --- a/packages/medusa/src/api/routes/store/products/list-products.ts +++ b/packages/medusa/src/api/routes/store/products/list-products.ts @@ -161,15 +161,15 @@ import PublishableAPIKeysFeatureFlag from "../../../../loaders/feature-flags/pub * type: array * items: * allOf: - * - $ref: "#/components/schemas/product" + * - $ref: "#/components/schemas/Product" * - type: object * properties: * variants: * type: array * items: * allOf: - * - $ref: "#/components/schemas/product_variant" - * - $ref: "#/components/schemas/product_variant_prices_fields" + * - $ref: "#/components/schemas/ProductVariant" + * - $ref: "#/components/schemas/ProductVariantPricesFields" * count: * type: integer * description: The total number of items available diff --git a/packages/medusa/src/api/routes/store/regions/get-region.ts b/packages/medusa/src/api/routes/store/regions/get-region.ts index 5652d9ce46..65f869be2a 100644 --- a/packages/medusa/src/api/routes/store/regions/get-region.ts +++ b/packages/medusa/src/api/routes/store/regions/get-region.ts @@ -1,4 +1,5 @@ import RegionService from "../../../../services/region" + /** * @oas [get] /regions/{id} * operationId: GetRegionsRegion @@ -31,7 +32,7 @@ import RegionService from "../../../../services/region" * type: object * properties: * region: - * $ref: "#/components/schemas/region" + * $ref: "#/components/schemas/Region" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/regions/list-regions.ts b/packages/medusa/src/api/routes/store/regions/list-regions.ts index bba10296ea..fc7d48121c 100644 --- a/packages/medusa/src/api/routes/store/regions/list-regions.ts +++ b/packages/medusa/src/api/routes/store/regions/list-regions.ts @@ -85,7 +85,7 @@ import { validator } from "../../../../utils/validator" * regions: * type: array * items: - * $ref: "#/components/schemas/region" + * $ref: "#/components/schemas/Region" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/return-reasons/get-reason.ts b/packages/medusa/src/api/routes/store/return-reasons/get-reason.ts index 6179d57199..dd93b41566 100644 --- a/packages/medusa/src/api/routes/store/return-reasons/get-reason.ts +++ b/packages/medusa/src/api/routes/store/return-reasons/get-reason.ts @@ -36,7 +36,7 @@ import ReturnReasonService from "../../../../services/return-reason" * type: object * properties: * return_reason: - * $ref: "#/components/schemas/return_reason" + * $ref: "#/components/schemas/ReturnReason" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/return-reasons/list-reasons.ts b/packages/medusa/src/api/routes/store/return-reasons/list-reasons.ts index 79902bf55f..4b65031d96 100644 --- a/packages/medusa/src/api/routes/store/return-reasons/list-reasons.ts +++ b/packages/medusa/src/api/routes/store/return-reasons/list-reasons.ts @@ -36,7 +36,7 @@ import ReturnReasonService from "../../../../services/return-reason" * return_reasons: * type: array * items: - * $ref: "#/components/schemas/return_reason" + * $ref: "#/components/schemas/ReturnReason" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/returns/create-return.ts b/packages/medusa/src/api/routes/store/returns/create-return.ts index a083e11eb0..0f9152f61f 100644 --- a/packages/medusa/src/api/routes/store/returns/create-return.ts +++ b/packages/medusa/src/api/routes/store/returns/create-return.ts @@ -105,7 +105,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * return: - * $ref: "#/components/schemas/return" + * $ref: "#/components/schemas/Return" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/shipping-options/list-options.ts b/packages/medusa/src/api/routes/store/shipping-options/list-options.ts index 7f64cb2083..2a6a0e17a6 100644 --- a/packages/medusa/src/api/routes/store/shipping-options/list-options.ts +++ b/packages/medusa/src/api/routes/store/shipping-options/list-options.ts @@ -39,7 +39,7 @@ import { validator } from "../../../../utils/validator" * shipping_options: * type: array * items: - * $ref: "#/components/schemas/shipping_option" + * $ref: "#/components/schemas/ShippingOption" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/shipping-options/list-shipping-options.ts b/packages/medusa/src/api/routes/store/shipping-options/list-shipping-options.ts index 44a20dc375..8ee27bde09 100644 --- a/packages/medusa/src/api/routes/store/shipping-options/list-shipping-options.ts +++ b/packages/medusa/src/api/routes/store/shipping-options/list-shipping-options.ts @@ -35,7 +35,7 @@ import ShippingProfileService from "../../../../services/shipping-profile" * shipping_options: * type: array * items: - * $ref: "#/components/schemas/shipping_option" + * $ref: "#/components/schemas/ShippingOption" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/swaps/create-swap.ts b/packages/medusa/src/api/routes/store/swaps/create-swap.ts index 7ac466acae..847572900c 100644 --- a/packages/medusa/src/api/routes/store/swaps/create-swap.ts +++ b/packages/medusa/src/api/routes/store/swaps/create-swap.ts @@ -128,7 +128,7 @@ import { validator } from "../../../../utils/validator" * type: object * properties: * swap: - * $ref: "#/components/schemas/swap" + * $ref: "#/components/schemas/Swap" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/swaps/get-swap-by-cart.ts b/packages/medusa/src/api/routes/store/swaps/get-swap-by-cart.ts index e87b1cb0b0..1544acdde0 100644 --- a/packages/medusa/src/api/routes/store/swaps/get-swap-by-cart.ts +++ b/packages/medusa/src/api/routes/store/swaps/get-swap-by-cart.ts @@ -1,4 +1,5 @@ import SwapService from "../../../../services/swap" + /** * @oas [get] /swaps/{cart_id} * operationId: GetSwapsSwapCartId @@ -31,7 +32,7 @@ import SwapService from "../../../../services/swap" * type: object * properties: * swap: - * $ref: "#/components/schemas/swap" + * $ref: "#/components/schemas/Swap" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/variants/get-variant.ts b/packages/medusa/src/api/routes/store/variants/get-variant.ts index 2f16da49ac..d5414559fb 100644 --- a/packages/medusa/src/api/routes/store/variants/get-variant.ts +++ b/packages/medusa/src/api/routes/store/variants/get-variant.ts @@ -45,8 +45,8 @@ import { validator } from "../../../../utils/validator" * properties: * variant: * allOf: - * - $ref: "#/components/schemas/product_variant" - * - $ref: "#/components/schemas/product_variant_prices_fields" + * - $ref: "#/components/schemas/ProductVariant" + * - $ref: "#/components/schemas/ProductVariantPricesFields" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/api/routes/store/variants/list-variants.ts b/packages/medusa/src/api/routes/store/variants/list-variants.ts index f9268adcf7..0e271e2f56 100644 --- a/packages/medusa/src/api/routes/store/variants/list-variants.ts +++ b/packages/medusa/src/api/routes/store/variants/list-variants.ts @@ -79,8 +79,8 @@ import { IsType } from "../../../../utils/validators/is-type" * type: array * items: * allOf: - * - $ref: "#/components/schemas/product_variant" - * - $ref: "#/components/schemas/product_variant_prices_fields" + * - $ref: "#/components/schemas/ProductVariant" + * - $ref: "#/components/schemas/ProductVariantPricesFields" * "400": * $ref: "#/components/responses/400_error" * "404": diff --git a/packages/medusa/src/models/address.ts b/packages/medusa/src/models/address.ts index 68a812aa09..7e360c9169 100644 --- a/packages/medusa/src/models/address.ts +++ b/packages/medusa/src/models/address.ts @@ -67,10 +67,9 @@ export class Address extends SoftDeletableEntity { } /** - * @schema address_fields + * @schema AddressFields * title: "Address Fields" * description: "Address fields used when creating/updating an address." - * x-resourceId: address * type: object * properties: * company: @@ -123,10 +122,9 @@ export class Address extends SoftDeletableEntity { */ /** - * @schema address + * @schema Address * title: "Address" * description: "An address." - * x-resourceId: address * type: object * properties: * id: @@ -205,4 +203,4 @@ export class Address extends SoftDeletableEntity { * type: object * description: An optional key-value map with additional details * example: {car: "white"} - */ \ No newline at end of file + */ diff --git a/packages/medusa/src/models/batch-job.ts b/packages/medusa/src/models/batch-job.ts index 1c23a76fb0..6ba0687011 100644 --- a/packages/medusa/src/models/batch-job.ts +++ b/packages/medusa/src/models/batch-job.ts @@ -1,5 +1,16 @@ -import { AfterLoad, BeforeInsert, Column, Entity, JoinColumn, ManyToOne, } from "typeorm" -import { BatchJobResultError, BatchJobResultStatDescriptor, BatchJobStatus, } from "../types/batch-job" +import { + AfterLoad, + BeforeInsert, + Column, + Entity, + JoinColumn, + ManyToOne, +} from "typeorm" +import { + BatchJobResultError, + BatchJobResultStatDescriptor, + BatchJobStatus, +} from "../types/batch-job" import { DbAwareColumn, resolveDbType } from "../utils/db-aware-column" import { SoftDeletableEntity } from "../interfaces/models/soft-deletable-entity" @@ -92,10 +103,9 @@ export class BatchJob extends SoftDeletableEntity { } /** - * @schema batch_job + * @schema BatchJob * title: "Batch Job" * description: "A Batch Job." - * x-resourceId: batch_job * type: object * required: * - type diff --git a/packages/medusa/src/models/cart.ts b/packages/medusa/src/models/cart.ts index 9cca175ca6..5c46f04712 100644 --- a/packages/medusa/src/models/cart.ts +++ b/packages/medusa/src/models/cart.ts @@ -1,8 +1,7 @@ /** - * @schema cart + * @schema Cart * title: "Cart" * description: "Represents a user cart" - * x-resourceId: cart * type: object * properties: * id: @@ -19,19 +18,19 @@ * example: addr_01G8ZH853YPY9B94857DY91YGW * billing_address: * description: Available if the relation `billing_address` is expanded. - * $ref: "#/components/schemas/address" + * $ref: "#/components/schemas/Address" * shipping_address_id: * type: string * description: The shipping address's ID * example: addr_01G8ZH853YPY9B94857DY91YGW * shipping_address: * description: Available if the relation `shipping_address` is expanded. - * $ref: "#/components/schemas/address" + * $ref: "#/components/schemas/Address" * items: * description: Available if the relation `items` is expanded. * type: array * items: - * $ref: "#/components/schemas/line_item" + * $ref: "#/components/schemas/LineItem" * region_id: * type: string * description: The region's ID @@ -60,24 +59,24 @@ * type: object * payment_session: * description: The selected payment session in the cart. - * $ref: "#/components/schemas/payment_session" + * $ref: "#/components/schemas/PaymentSession" * payment_sessions: * type: array * description: The payment sessions created on the cart. * items: - * $ref: "#/components/schemas/payment_session" + * $ref: "#/components/schemas/PaymentSession" * payment_id: * type: string * description: The payment's ID if available * example: pay_01G8ZCC5W42ZNY842124G7P5R9 * payment: * description: Available if the relation `payment` is expanded. - * $ref: "#/components/schemas/payment" + * $ref: "#/components/schemas/Payment" * shipping_methods: * type: array * description: The shipping methods added to the cart. * items: - * $ref: "#/components/schemas/shipping_method" + * $ref: "#/components/schemas/ShippingMethod" * type: * type: string * description: The cart's type. diff --git a/packages/medusa/src/models/claim-image.ts b/packages/medusa/src/models/claim-image.ts index 4510ae38f7..d8d20da1d3 100644 --- a/packages/medusa/src/models/claim-image.ts +++ b/packages/medusa/src/models/claim-image.ts @@ -35,10 +35,9 @@ export class ClaimImage extends SoftDeletableEntity { } /** - * @schema claim_image + * @schema ClaimImage * title: "Claim Image" * description: "Represents photo documentation of a claim." - * x-resourceId: claim_image * type: object * required: * - claim_item_id diff --git a/packages/medusa/src/models/claim-item.ts b/packages/medusa/src/models/claim-item.ts index 27dc49324f..cb7fe27e41 100644 --- a/packages/medusa/src/models/claim-item.ts +++ b/packages/medusa/src/models/claim-item.ts @@ -90,10 +90,9 @@ export class ClaimItem extends SoftDeletableEntity { } /** - * @schema claim_item + * @schema ClaimItem * title: "Claim Item" * description: "Represents a claimed item along with information about the reasons for the claim." - * x-resourceId: claim_item * type: object * required: * - claim_order_id @@ -110,7 +109,7 @@ export class ClaimItem extends SoftDeletableEntity { * type: array * description: Available if the relation `images` is expanded. * items: - * $ref: "#/components/schemas/claim_image" + * $ref: "#/components/schemas/ClaimImage" * claim_order_id: * description: The ID of the claim this item is associated with. * type: string @@ -123,7 +122,7 @@ export class ClaimItem extends SoftDeletableEntity { * example: item_01G8ZM25TN49YV9EQBE2NC27KC * item: * description: Available if the relation `item` is expanded. - * $ref: "#/components/schemas/line_item" + * $ref: "#/components/schemas/LineItem" * variant_id: * description: "The ID of the product variant that is claimed." * type: string @@ -151,7 +150,7 @@ export class ClaimItem extends SoftDeletableEntity { * description: "User defined tags for easy filtering and grouping. Available if the relation 'tags' is expanded." * type: array * items: - * $ref: "#/components/schemas/claim_tag" + * $ref: "#/components/schemas/ClaimTag" * created_at: * type: string * description: "The date with timezone at which the resource was created." diff --git a/packages/medusa/src/models/claim-order.ts b/packages/medusa/src/models/claim-order.ts index d0d83e9ca8..0efc509079 100644 --- a/packages/medusa/src/models/claim-order.ts +++ b/packages/medusa/src/models/claim-order.ts @@ -131,10 +131,9 @@ export class ClaimOrder extends SoftDeletableEntity { } /** - * @schema claim_order + * @schema ClaimOrder * title: "Claim Order" * description: "Claim Orders represent a group of faulty or missing items. Each claim order consists of a subset of items associated with an original order, and can contain additional information about fulfillments and returns." - * x-resourceId: claim_order * type: object * required: * - type @@ -174,12 +173,12 @@ export class ClaimOrder extends SoftDeletableEntity { * description: "The items that have been claimed" * type: array * items: - * $ref: "#/components/schemas/claim_item" + * $ref: "#/components/schemas/ClaimItem" * additional_items: * description: "Refers to the new items to be shipped when the claim order has the type `replace`" * type: array * items: - * $ref: "#/components/schemas/line_item" + * $ref: "#/components/schemas/LineItem" * order_id: * description: "The ID of the order that the claim comes from." * type: string @@ -196,17 +195,17 @@ export class ClaimOrder extends SoftDeletableEntity { * example: addr_01G8ZH853YPY9B94857DY91YGW * shipping_address: * description: Available if the relation `shipping_address` is expanded. - * $ref: "#/components/schemas/address" + * $ref: "#/components/schemas/Address" * shipping_methods: * description: "The shipping methods that the claim order will be shipped with." * type: array * items: - * $ref: "#/components/schemas/shipping_method" + * $ref: "#/components/schemas/ShippingMethod" * fulfillments: * description: "The fulfillments of the new items to be shipped" * type: array * items: - * $ref: "#/components/schemas/fulfillment" + * $ref: "#/components/schemas/Fulfillment" * refund_amount: * description: "The amount that will be refunded in conjunction with the claim" * type: integer diff --git a/packages/medusa/src/models/claim-tag.ts b/packages/medusa/src/models/claim-tag.ts index c88b26318f..e2e7ae6045 100644 --- a/packages/medusa/src/models/claim-tag.ts +++ b/packages/medusa/src/models/claim-tag.ts @@ -20,10 +20,9 @@ export class ClaimTag extends SoftDeletableEntity { } /** - * @schema claim_tag + * @schema ClaimTag * title: "Claim Tag" * description: "Claim Tags are user defined tags that can be assigned to claim items for easy filtering and grouping." - * x-resourceId: claim_tag * type: object * required: * - value diff --git a/packages/medusa/src/models/country.ts b/packages/medusa/src/models/country.ts index a33f2a8642..4b6861d09e 100644 --- a/packages/medusa/src/models/country.ts +++ b/packages/medusa/src/models/country.ts @@ -40,10 +40,9 @@ export class Country { } /** - * @schema country + * @schema Country * title: "Country" * description: "Country details" - * x-resourceId: country * type: object * required: * - iso_2 diff --git a/packages/medusa/src/models/currency.ts b/packages/medusa/src/models/currency.ts index c5b0a9ca1b..564a193a4c 100644 --- a/packages/medusa/src/models/currency.ts +++ b/packages/medusa/src/models/currency.ts @@ -21,10 +21,9 @@ export class Currency { } /** - * @schema currency + * @schema Currency * title: "Currency" * description: "Currency" - * x-resourceId: currency * type: object * required: * - code diff --git a/packages/medusa/src/models/custom-shipping-option.ts b/packages/medusa/src/models/custom-shipping-option.ts index 7975db9d4f..b5c6d3ae77 100644 --- a/packages/medusa/src/models/custom-shipping-option.ts +++ b/packages/medusa/src/models/custom-shipping-option.ts @@ -46,10 +46,9 @@ export class CustomShippingOption extends SoftDeletableEntity { } /** - * @schema custom_shipping_option + * @schema CustomShippingOption * title: "Custom Shipping Option" * description: "Custom Shipping Options are 'overriden' Shipping Options. Store managers can attach a Custom Shipping Option to a cart in order to set a custom price for a particular Shipping Option" - * x-resourceId: custom_shipping_option * type: object * required: * - price diff --git a/packages/medusa/src/models/customer-group.ts b/packages/medusa/src/models/customer-group.ts index c03448fedc..7a197b78f2 100644 --- a/packages/medusa/src/models/customer-group.ts +++ b/packages/medusa/src/models/customer-group.ts @@ -30,11 +30,11 @@ export class CustomerGroup extends SoftDeletableEntity { this.id = generateEntityId(this.id, "cgrp") } } + /** - * @schema customer_group + * @schema CustomerGroup * title: "Customer Group" * description: "Represents a customer group" - * x-resourceId: customer_group * type: object * required: * - name @@ -57,7 +57,7 @@ export class CustomerGroup extends SoftDeletableEntity { * type: array * description: The price lists that are associated with the customer group. Available if the relation `price_lists` is expanded. * items: - * $ref: "#/components/schemas/price_list" + * $ref: "#/components/schemas/PriceList" * created_at: * type: string * description: "The date with timezone at which the resource was created." @@ -75,4 +75,3 @@ export class CustomerGroup extends SoftDeletableEntity { * description: An optional key-value map with additional details * example: {car: "white"} */ - diff --git a/packages/medusa/src/models/customer.ts b/packages/medusa/src/models/customer.ts index 016a895134..b64147a7e1 100644 --- a/packages/medusa/src/models/customer.ts +++ b/packages/medusa/src/models/customer.ts @@ -80,10 +80,9 @@ export class Customer extends SoftDeletableEntity { } /** - * @schema customer + * @schema Customer * title: "Customer" * description: "Represents a customer" - * x-resourceId: customer * type: object * required: * - email @@ -110,12 +109,12 @@ export class Customer extends SoftDeletableEntity { * example: addr_01G8ZH853YPY9B94857DY91YGW * billing_address: * description: Available if the relation `billing_address` is expanded. - * $ref: "#/components/schemas/address" + * $ref: "#/components/schemas/Address" * shipping_addresses: * description: Available if the relation `shipping_addresses` is expanded. * type: array * items: - * $ref: "#/components/schemas/address" + * $ref: "#/components/schemas/Address" * phone: * type: string * description: The customer's phone number @@ -134,7 +133,7 @@ export class Customer extends SoftDeletableEntity { * description: The customer groups the customer belongs to. Available if the relation `groups` is expanded. * type: array * items: - * $ref: "#/components/schemas/customer_group" + * $ref: "#/components/schemas/CustomerGroup" * created_at: * type: string * description: "The date with timezone at which the resource was created." diff --git a/packages/medusa/src/models/discount-condition-customer-group.ts b/packages/medusa/src/models/discount-condition-customer-group.ts index 9e570fac31..b0e23b2609 100644 --- a/packages/medusa/src/models/discount-condition-customer-group.ts +++ b/packages/medusa/src/models/discount-condition-customer-group.ts @@ -38,10 +38,9 @@ export class DiscountConditionCustomerGroup { } /** - * @schema discount_condition_customer_group + * @schema DiscountConditionCustomerGroup * title: "Product Tag Discount Condition" * description: "Associates a discount condition with a customer group" - * x-resourceId: discount_condition_customer_group * type: object * required: * - customer_group_id @@ -57,10 +56,10 @@ export class DiscountConditionCustomerGroup { * example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A * customer_group: * description: Available if the relation `customer_group` is expanded. - * $ref: "#/components/schemas/customer_group" + * $ref: "#/components/schemas/CustomerGroup" * discount_condition: * description: Available if the relation `discount_condition` is expanded. - * $ref: "#/components/schemas/discount_condition" + * $ref: "#/components/schemas/DiscountCondition" * created_at: * type: string * description: "The date with timezone at which the resource was created." diff --git a/packages/medusa/src/models/discount-condition-product-collection.ts b/packages/medusa/src/models/discount-condition-product-collection.ts index deefc192b8..ad1f7c72ff 100644 --- a/packages/medusa/src/models/discount-condition-product-collection.ts +++ b/packages/medusa/src/models/discount-condition-product-collection.ts @@ -38,10 +38,9 @@ export class DiscountConditionProductCollection { } /** - * @schema discount_condition_product_collection + * @schema DiscountConditionProductCollection * title: "Product Collection Discount Condition" * description: "Associates a discount condition with a product collection" - * x-resourceId: discount_condition_product_collection * type: object * required: * - product_collection_id @@ -57,10 +56,10 @@ export class DiscountConditionProductCollection { * example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A * product_collection: * description: Available if the relation `product_collection` is expanded. - * $ref: "#/components/schemas/product_collection" + * $ref: "#/components/schemas/ProductCollection" * discount_condition: * description: Available if the relation `discount_condition` is expanded. - * $ref: "#/components/schemas/discount_condition" + * $ref: "#/components/schemas/DiscountCondition" * created_at: * type: string * description: "The date with timezone at which the resource was created." diff --git a/packages/medusa/src/models/discount-condition-product-tag.ts b/packages/medusa/src/models/discount-condition-product-tag.ts index c45c641e87..87af09659b 100644 --- a/packages/medusa/src/models/discount-condition-product-tag.ts +++ b/packages/medusa/src/models/discount-condition-product-tag.ts @@ -38,10 +38,9 @@ export class DiscountConditionProductTag { } /** - * @schema discount_condition_product_tag + * @schema DiscountConditionProductTag * title: "Product Tag Discount Condition" * description: "Associates a discount condition with a product tag" - * x-resourceId: discount_condition_product_tag * type: object * required: * - product_tag_id @@ -57,10 +56,10 @@ export class DiscountConditionProductTag { * example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A * product_tag: * description: Available if the relation `product_tag` is expanded. - * $ref: "#/components/schemas/product_tag" + * $ref: "#/components/schemas/ProductTag" * discount_condition: * description: Available if the relation `discount_condition` is expanded. - * $ref: "#/components/schemas/discount_condition" + * $ref: "#/components/schemas/DiscountCondition" * created_at: * type: string * description: "The date with timezone at which the resource was created." diff --git a/packages/medusa/src/models/discount-condition-product-type.ts b/packages/medusa/src/models/discount-condition-product-type.ts index dad7657b66..57c5ebdb93 100644 --- a/packages/medusa/src/models/discount-condition-product-type.ts +++ b/packages/medusa/src/models/discount-condition-product-type.ts @@ -38,10 +38,9 @@ export class DiscountConditionProductType { } /** - * @schema discount_condition_product_type + * @schema DiscountConditionProductType * title: "Product Type Discount Condition" * description: "Associates a discount condition with a product type" - * x-resourceId: discount_condition_product * type: object * required: * - product_type_id @@ -57,10 +56,10 @@ export class DiscountConditionProductType { * example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A * product_type: * description: Available if the relation `product_type` is expanded. - * $ref: "#/components/schemas/product_type" + * $ref: "#/components/schemas/ProductType" * discount_condition: * description: Available if the relation `discount_condition` is expanded. - * $ref: "#/components/schemas/discount_condition" + * $ref: "#/components/schemas/DiscountCondition" * created_at: * type: string * description: "The date with timezone at which the resource was created." diff --git a/packages/medusa/src/models/discount-condition-product.ts b/packages/medusa/src/models/discount-condition-product.ts index 9bf1dfa0e9..579874c323 100644 --- a/packages/medusa/src/models/discount-condition-product.ts +++ b/packages/medusa/src/models/discount-condition-product.ts @@ -38,10 +38,9 @@ export class DiscountConditionProduct { } /** - * @schema discount_condition_product + * @schema DiscountConditionProduct * title: "Product Discount Condition" * description: "Associates a discount condition with a product" - * x-resourceId: discount_condition_product * type: object * required: * - product_id @@ -57,10 +56,10 @@ export class DiscountConditionProduct { * example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A * product: * description: Available if the relation `product` is expanded. - * $ref: "#/components/schemas/product" + * $ref: "#/components/schemas/Product" * discount_condition: * description: Available if the relation `discount_condition` is expanded. - * $ref: "#/components/schemas/discount_condition" + * $ref: "#/components/schemas/DiscountCondition" * created_at: * type: string * description: "The date with timezone at which the resource was created." diff --git a/packages/medusa/src/models/discount-condition.ts b/packages/medusa/src/models/discount-condition.ts index f433f020fb..21f066a482 100644 --- a/packages/medusa/src/models/discount-condition.ts +++ b/packages/medusa/src/models/discount-condition.ts @@ -136,10 +136,9 @@ export class DiscountCondition extends SoftDeletableEntity { } /** - * @schema discount_condition + * @schema DiscountCondition * title: "Discount Condition" * description: "Holds rule conditions for when a discount is applicable" - * x-resourceId: discount_condition * type: object * required: * - type @@ -171,7 +170,7 @@ export class DiscountCondition extends SoftDeletableEntity { * example: dru_01F0YESMVK96HVX7N419E3CJ7C * discount_rule: * description: Available if the relation `discount_rule` is expanded. - * $ref: "#/components/schemas/discount_rule" + * $ref: "#/components/schemas/DiscountRule" * products: * description: products associated with this condition if type = products. Available if the relation `products` is expanded. * type: array diff --git a/packages/medusa/src/models/discount-rule.ts b/packages/medusa/src/models/discount-rule.ts index 79c949545b..314db3839c 100644 --- a/packages/medusa/src/models/discount-rule.ts +++ b/packages/medusa/src/models/discount-rule.ts @@ -50,10 +50,9 @@ export class DiscountRule extends SoftDeletableEntity { } /** - * @schema discount_rule + * @schema DiscountRule * title: "Discount Rule" * description: "Holds the rules that governs how a Discount is calculated when applied to a Cart." - * x-resourceId: discount_rule * type: object * required: * - type diff --git a/packages/medusa/src/models/discount.ts b/packages/medusa/src/models/discount.ts index 0c0a62b01e..1898c1e8e5 100644 --- a/packages/medusa/src/models/discount.ts +++ b/packages/medusa/src/models/discount.ts @@ -89,10 +89,9 @@ export class Discount extends SoftDeletableEntity { } /** - * @schema discount + * @schema Discount * title: "Discount" * description: "Represents a discount that can be applied to a cart for promotional purposes." - * x-resourceId: discount * type: object * required: * - code @@ -116,7 +115,7 @@ export class Discount extends SoftDeletableEntity { * example: dru_01F0YESMVK96HVX7N419E3CJ7C * rule: * description: Available if the relation `rule` is expanded. - * $ref: "#/components/schemas/discount_rule" + * $ref: "#/components/schemas/DiscountRule" * is_disabled: * description: "Whether the Discount has been disabled. Disabled discounts cannot be applied to carts" * type: boolean @@ -127,7 +126,7 @@ export class Discount extends SoftDeletableEntity { * example: disc_01G8ZH853YPY9B94857DY91YGW * parent_discount: * description: Available if the relation `parent_discount` is expanded. - * $ref: "#/components/schemas/discount" + * $ref: "#/components/schemas/Discount" * starts_at: * description: "The time at which the discount can be used." * type: string diff --git a/packages/medusa/src/models/draft-order.ts b/packages/medusa/src/models/draft-order.ts index 24cf91ee23..cf5ee6911a 100644 --- a/packages/medusa/src/models/draft-order.ts +++ b/packages/medusa/src/models/draft-order.ts @@ -80,10 +80,9 @@ export class DraftOrder extends BaseEntity { } /** - * @schema draft-order + * @schema DraftOrder * title: "DraftOrder" * description: "Represents a draft order" - * x-resourceId: draft-order * type: object * properties: * id: diff --git a/packages/medusa/src/models/fulfillment-item.ts b/packages/medusa/src/models/fulfillment-item.ts index 8a0392739b..9d63423deb 100644 --- a/packages/medusa/src/models/fulfillment-item.ts +++ b/packages/medusa/src/models/fulfillment-item.ts @@ -24,10 +24,9 @@ export class FulfillmentItem { } /** - * @schema fulfillment_item + * @schema FulfillmentItem * title: "Fulfillment Item" * description: "Correlates a Line Item with a Fulfillment, keeping track of the quantity of the Line Item." - * x-resourceId: fulfillment_item * type: object * required: * - fulfillment_id @@ -47,7 +46,7 @@ export class FulfillmentItem { * type: object * item: * description: Available if the relation `item` is expanded. - * $ref: "#/components/schemas/line_item" + * $ref: "#/components/schemas/LineItem" * quantity: * description: "The quantity of the Line Item that is included in the Fulfillment." * type: integer diff --git a/packages/medusa/src/models/fulfillment-provider.ts b/packages/medusa/src/models/fulfillment-provider.ts index 3d5929ae18..65c0720313 100644 --- a/packages/medusa/src/models/fulfillment-provider.ts +++ b/packages/medusa/src/models/fulfillment-provider.ts @@ -10,10 +10,9 @@ export class FulfillmentProvider { } /** - * @schema fulfillment_provider + * @schema FulfillmentProvider * title: "Fulfillment Provider" * description: "Represents a fulfillment provider plugin and holds its installation status." - * x-resourceId: fulfillment_provider * type: object * properties: * id: diff --git a/packages/medusa/src/models/fulfillment.ts b/packages/medusa/src/models/fulfillment.ts index 37d1a1f009..be46d0e3d4 100644 --- a/packages/medusa/src/models/fulfillment.ts +++ b/packages/medusa/src/models/fulfillment.ts @@ -91,10 +91,9 @@ export class Fulfillment extends BaseEntity { } /** - * @schema fulfillment + * @schema Fulfillment * title: "Fulfillment" * description: "Fulfillments are created once store operators can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a provider, which is typically an external shipping aggregator, shipping partner og 3PL, most plugins will have asynchronous communications with these providers through webhooks in order to automatically update and synchronize the state of Fulfillments." - * x-resourceId: fulfillment * type: object * required: * - provider_id @@ -130,17 +129,17 @@ export class Fulfillment extends BaseEntity { * example: manual * provider: * description: Available if the relation `provider` is expanded. - * $ref: "#/components/schemas/fulfillment_provider" + * $ref: "#/components/schemas/FulfillmentProvider" * items: * description: The Fulfillment Items in the Fulfillment - these hold information about how many of each Line Item has been fulfilled. Available if the relation `items` is expanded. * type: array * items: - * $ref: "#/components/schemas/fulfillment_item" + * $ref: "#/components/schemas/FulfillmentItem" * tracking_links: * description: The Tracking Links that can be used to track the status of the Fulfillment, these will usually be provided by the Fulfillment Provider. Available if the relation `tracking_links` is expanded. * type: array * items: - * $ref: "#/components/schemas/tracking_link" + * $ref: "#/components/schemas/TrackingLink" * tracking_numbers: * deprecated: true * description: The tracking numbers that can be used to track the status of the fulfillment. diff --git a/packages/medusa/src/models/gift-card-transaction.ts b/packages/medusa/src/models/gift-card-transaction.ts index 4f34355f9f..5658c01f74 100644 --- a/packages/medusa/src/models/gift-card-transaction.ts +++ b/packages/medusa/src/models/gift-card-transaction.ts @@ -55,10 +55,9 @@ export class GiftCardTransaction { } /** - * @schema gift_card_transaction + * @schema GiftCardTransaction * title: "Gift Card Transaction" * description: "Gift Card Transactions are created once a Customer uses a Gift Card to pay for their Order" - * x-resourceId: gift_card_transaction * type: object * required: * - gift_card_id diff --git a/packages/medusa/src/models/gift-card.ts b/packages/medusa/src/models/gift-card.ts index c5afb46deb..21bed5ed65 100644 --- a/packages/medusa/src/models/gift-card.ts +++ b/packages/medusa/src/models/gift-card.ts @@ -60,10 +60,9 @@ export class GiftCard extends SoftDeletableEntity { } /** - * @schema gift_card + * @schema GiftCard * title: "Gift Card" * description: "Gift Cards are redeemable and represent a value that can be used towards the payment of an Order." - * x-resourceId: gift_card * type: object * required: * - code diff --git a/packages/medusa/src/models/idempotency-key.ts b/packages/medusa/src/models/idempotency-key.ts index c7e841b485..6ef2dba500 100644 --- a/packages/medusa/src/models/idempotency-key.ts +++ b/packages/medusa/src/models/idempotency-key.ts @@ -50,10 +50,9 @@ export class IdempotencyKey { } /** - * @schema idempotency_key + * @schema IdempotencyKey * title: "Idempotency Key" * description: "Idempotency Key is used to continue a process in case of any failure that might occur." - * x-resourceId: idempotency_key * type: object * required: * - idempotency_key @@ -102,4 +101,4 @@ export class IdempotencyKey { * type: string * description: "Where to continue from." * default: started - */ \ No newline at end of file + */ diff --git a/packages/medusa/src/models/image.ts b/packages/medusa/src/models/image.ts index bf247724f5..f558160daa 100644 --- a/packages/medusa/src/models/image.ts +++ b/packages/medusa/src/models/image.ts @@ -19,10 +19,9 @@ export class Image extends SoftDeletableEntity { } /** - * @schema image + * @schema Image * title: "Image" * description: "Images holds a reference to a URL at which the image file can be found." - * x-resourceId: image * type: object * required: * - url diff --git a/packages/medusa/src/models/invite.ts b/packages/medusa/src/models/invite.ts index b6152e0fe7..9258e67abc 100644 --- a/packages/medusa/src/models/invite.ts +++ b/packages/medusa/src/models/invite.ts @@ -38,10 +38,9 @@ export class Invite extends SoftDeletableEntity { } /** - * @schema invite + * @schema Invite * title: "Invite" * description: "Represents an invite" - * x-resourceId: invite * type: object * required: * - user_email diff --git a/packages/medusa/src/models/line-item-adjustment.ts b/packages/medusa/src/models/line-item-adjustment.ts index d9b6e4a2cb..b793672fbf 100644 --- a/packages/medusa/src/models/line-item-adjustment.ts +++ b/packages/medusa/src/models/line-item-adjustment.ts @@ -54,10 +54,9 @@ export class LineItemAdjustment { } /** - * @schema line_item_adjustment + * @schema LineItemAdjustment * title: "Line Item Adjustment" - * description: "Represents an Line Item Adjustment" - * x-resourceId: line_item_adjustment + * description: "Represents a Line Item Adjustment" * type: object * required: * - item_id @@ -74,7 +73,7 @@ export class LineItemAdjustment { * example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN * item: * description: Available if the relation `item` is expanded. - * $ref: "#/components/schemas/line_item" + * $ref: "#/components/schemas/LineItem" * description: * type: string * description: The line item's adjustment description @@ -85,7 +84,7 @@ export class LineItemAdjustment { * example: disc_01F0YESMW10MGHWJKZSDDMN0VN * discount: * description: Available if the relation `discount` is expanded. - * $ref: "#/components/schemas/discount" + * $ref: "#/components/schemas/Discount" * amount: * type: number * description: The adjustment amount diff --git a/packages/medusa/src/models/line-item-tax-line.ts b/packages/medusa/src/models/line-item-tax-line.ts index 7833cc9958..ab6fb374d2 100644 --- a/packages/medusa/src/models/line-item-tax-line.ts +++ b/packages/medusa/src/models/line-item-tax-line.ts @@ -30,10 +30,9 @@ export class LineItemTaxLine extends TaxLine { } /** - * @schema line_item_tax_line + * @schema LineItemTaxLine * title: "Line Item Tax Line" - * description: "Represents an Line Item Tax Line" - * x-resourceId: line_item_tax_line + * description: "Represents a Line Item Tax Line" * type: object * required: * - item_id @@ -50,7 +49,7 @@ export class LineItemTaxLine extends TaxLine { * example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN * item: * description: Available if the relation `item` is expanded. - * $ref: "#/components/schemas/line_item" + * $ref: "#/components/schemas/LineItem" * code: * description: "A code to identify the tax type by" * type: string diff --git a/packages/medusa/src/models/line-item.ts b/packages/medusa/src/models/line-item.ts index 2913401a8e..9de9997fd5 100644 --- a/packages/medusa/src/models/line-item.ts +++ b/packages/medusa/src/models/line-item.ts @@ -174,10 +174,9 @@ export class LineItem extends BaseEntity { } /** - * @schema line_item + * @schema LineItem * title: "Line Item" * description: "Line Items represent purchasable units that can be added to a Cart for checkout. When Line Items are purchased they will get copied to the resulting order and can eventually be referenced in Fulfillments and Returns. Line Items may also be created when processing Swaps and Claims." - * x-resourceId: line_item * type: object * required: * - title @@ -220,12 +219,12 @@ export class LineItem extends BaseEntity { * description: Available if the relation `tax_lines` is expanded. * type: array * items: - * $ref: "#/components/schemas/line_item_tax_line" + * $ref: "#/components/schemas/LineItemTaxLine" * adjustments: * description: Available if the relation `adjustments` is expanded. * type: array * items: - * $ref: "#/components/schemas/line_item_adjustment" + * $ref: "#/components/schemas/LineItemAdjustment" * title: * description: "The title of the Line Item, this should be easily identifiable by the Customer." * type: string diff --git a/packages/medusa/src/models/money-amount.ts b/packages/medusa/src/models/money-amount.ts index 63ae492a22..2f5285b1e3 100644 --- a/packages/medusa/src/models/money-amount.ts +++ b/packages/medusa/src/models/money-amount.ts @@ -68,10 +68,9 @@ export class MoneyAmount extends SoftDeletableEntity { } /** - * @schema money_amount + * @schema MoneyAmount * title: "Money Amount" * description: "Money Amounts represents an amount that a given Product Variant can be purcased for. Each Money Amount either has a Currency or Region associated with it to indicate the pricing in a given Currency or, for fully region-based pricing, the given price in a specific Region. If region-based pricing is used the amount will be in the currency defined for the Reigon." - * x-resourceId: money_amount * type: object * required: * - currency_code @@ -90,7 +89,7 @@ export class MoneyAmount extends SoftDeletableEntity { * description: See a list of codes. * currency: * description: Available if the relation `currency` is expanded. - * $ref: "#/components/schemas/currency" + * $ref: "#/components/schemas/Currency" * amount: * description: "The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost." * type: integer @@ -109,7 +108,7 @@ export class MoneyAmount extends SoftDeletableEntity { * example: pl_01G8X3CKJXCG5VXVZ87H9KC09W * price_list: * description: Available if the relation `price_list` is expanded. - * $ref: "#/components/schemas/price_list" + * $ref: "#/components/schemas/PriceList" * variant_id: * description: "The id of the Product Variant contained in the Line Item." * type: string diff --git a/packages/medusa/src/models/note.ts b/packages/medusa/src/models/note.ts index fe0ab4fbc7..aea563c7d2 100644 --- a/packages/medusa/src/models/note.ts +++ b/packages/medusa/src/models/note.ts @@ -42,10 +42,9 @@ export class Note extends SoftDeletableEntity { } /** - * @schema note + * @schema Note * title: "Note" * description: "Notes are elements which we can use in association with different resources to allow users to describe additional information in relation to these." - * x-resourceId: note * type: object * required: * - value @@ -74,7 +73,7 @@ export class Note extends SoftDeletableEntity { * example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V * author: * description: Available if the relation `author` is expanded. - * $ref: "#/components/schemas/user" + * $ref: "#/components/schemas/User" * created_at: * type: string * description: "The date with timezone at which the resource was created." diff --git a/packages/medusa/src/models/notification-provider.ts b/packages/medusa/src/models/notification-provider.ts index 8c14602e43..5092259be1 100644 --- a/packages/medusa/src/models/notification-provider.ts +++ b/packages/medusa/src/models/notification-provider.ts @@ -10,10 +10,9 @@ export class NotificationProvider { } /** - * @schema notification_provider + * @schema NotificationProvider * title: "Notification Provider" * description: "Represents a notification provider plugin and holds its installation status." - * x-resourceId: notification_provider * type: object * required: * - id diff --git a/packages/medusa/src/models/notification.ts b/packages/medusa/src/models/notification.ts index fc3dfbe717..1b2210004b 100644 --- a/packages/medusa/src/models/notification.ts +++ b/packages/medusa/src/models/notification.ts @@ -65,10 +65,9 @@ export class Notification extends BaseEntity { } /** - * @schema notification + * @schema Notification * title: "Notification" * description: "Notifications a communications sent via Notification Providers as a reaction to internal events such as `order.placed`. Notifications can be used to show a chronological timeline for communications sent to a Customer regarding an Order, and enables resends." - * x-resourceId: notification * type: object * required: * - resource_type @@ -110,14 +109,14 @@ export class Notification extends BaseEntity { * description: "The resends that have been completed after the original Notification." * type: array * items: - * $ref: "#/components/schemas/notification_resend" + * $ref: "#/components/schemas/NotificationResend" * provider_id: * description: "The id of the Notification Provider that handles the Notification." * type: string * example: sengrid * provider: * description: Available if the relation `provider` is expanded. - * $ref: "#/components/schemas/notification_provider" + * $ref: "#/components/schemas/NotificationProvider" * created_at: * type: string * description: "The date with timezone at which the resource was created." @@ -129,10 +128,9 @@ export class Notification extends BaseEntity { */ /** - * @schema notification_resend + * @schema NotificationResend * title: "Notification Resend" * description: "A resend of a Notification." - * x-resourceId: notification_resend * type: object * properties: * id: @@ -172,14 +170,14 @@ export class Notification extends BaseEntity { * example: noti_01G53V9Y6CKMCGBM1P0X7C28RX * parent_notification: * description: Available if the relation `parent_notification` is expanded. - * $ref: "#/components/schemas/notification" + * $ref: "#/components/schemas/Notification" * provider_id: * description: "The ID of the Notification Provider that handles the Notification." * type: string * example: sengrid * provider: * description: Available if the relation `provider` is expanded. - * $ref: "#/components/schemas/notification_provider" + * $ref: "#/components/schemas/NotificationProvider" * created_at: * type: string * description: "The date with timezone at which the resource was created." diff --git a/packages/medusa/src/models/oauth.ts b/packages/medusa/src/models/oauth.ts index 79e73838ab..3c67c3ab54 100644 --- a/packages/medusa/src/models/oauth.ts +++ b/packages/medusa/src/models/oauth.ts @@ -34,7 +34,6 @@ export class Oauth { * @schema OAuth * title: "OAuth" * description: "Represent an OAuth app" - * x-resourceId: OAuth * type: object * required: * - id diff --git a/packages/medusa/src/models/order-edit.ts b/packages/medusa/src/models/order-edit.ts index 7b3331b929..5a05006a87 100644 --- a/packages/medusa/src/models/order-edit.ts +++ b/packages/medusa/src/models/order-edit.ts @@ -122,10 +122,9 @@ export class OrderEdit extends BaseEntity { } /** - * @schema order_edit + * @schema OrderEdit * title: "Order Edit" * description: "Order edit keeps track of order items changes." - * x-resourceId: order_edit * type: object * required: * - order_id @@ -143,12 +142,12 @@ export class OrderEdit extends BaseEntity { * example: order_01G2SG30J8C85S4A5CHM2S1NS2 * order: * description: Available if the relation `order` is expanded. - * $ref: "#/components/schemas/order" + * $ref: "#/components/schemas/Order" * changes: * type: array * description: Available if the relation `changes` is expanded. * items: - * $ref: "#/components/schemas/order_item_change" + * $ref: "#/components/schemas/OrderItemChange" * internal_note: * description: "An optional note with additional details about the order edit." * type: string @@ -225,14 +224,14 @@ export class OrderEdit extends BaseEntity { * type: array * description: Available if the relation `items` is expanded. * items: - * $ref: "#/components/schemas/line_item" + * $ref: "#/components/schemas/LineItem" * payment_collection_id: * type: string * description: The ID of the payment collection * example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK * payment_collection: * description: Available if the relation `payment_collection` is expanded. - * $ref: "#/components/schemas/payment_collection" + * $ref: "#/components/schemas/PaymentCollection" * created_at: * type: string * description: "The date with timezone at which the resource was created." diff --git a/packages/medusa/src/models/order-item-change.ts b/packages/medusa/src/models/order-item-change.ts index b5492575c7..06b007b6b0 100644 --- a/packages/medusa/src/models/order-item-change.ts +++ b/packages/medusa/src/models/order-item-change.ts @@ -59,10 +59,9 @@ export class OrderItemChange extends SoftDeletableEntity { } /** - * @schema order_item_change + * @schema OrderItemChange * title: "Order Item Change" * description: "Represents an order edit item change" - * x-resourceId: order_item_change * type: object * required: * - type @@ -85,21 +84,21 @@ export class OrderItemChange extends SoftDeletableEntity { * example: oe_01G2SG30J8C85S4A5CHM2S1NS2 * order_edit: * description: Available if the relation `order_edit` is expanded. - * $ref: "#/components/schemas/order_edit" + * $ref: "#/components/schemas/OrderEdit" * original_line_item_id: * type: string * description: The ID of the original line item in the order * example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN * original_line_item: * description: Available if the relation `original_line_item` is expanded. - * $ref: "#/components/schemas/line_item" + * $ref: "#/components/schemas/LineItem" * line_item_id: * type: string * description: The ID of the cloned line item. * example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN * line_item: * description: Available if the relation `line_item` is expanded. - * $ref: "#/components/schemas/line_item" + * $ref: "#/components/schemas/LineItem" * created_at: * type: string * description: "The date with timezone at which the resource was created." diff --git a/packages/medusa/src/models/order.ts b/packages/medusa/src/models/order.ts index 06edcc0cec..a1b9ba74ae 100644 --- a/packages/medusa/src/models/order.ts +++ b/packages/medusa/src/models/order.ts @@ -278,10 +278,9 @@ export class Order extends BaseEntity { } /** - * @schema order + * @schema Order * title: "Order" * description: "Represents an order" - * x-resourceId: order * type: object * required: * - customer_id @@ -357,14 +356,14 @@ export class Order extends BaseEntity { * example: addr_01G8ZH853YPY9B94857DY91YGW * billing_address: * description: Available if the relation `billing_address` is expanded. - * $ref: "#/components/schemas/address" + * $ref: "#/components/schemas/Address" * shipping_address_id: * type: string * description: The ID of the shipping address associated with the order * example: addr_01G8ZH853YPY9B94857DY91YGW * shipping_address: * description: Available if the relation `shipping_address` is expanded. - * $ref: "#/components/schemas/address" + * $ref: "#/components/schemas/Address" * region_id: * type: string * description: The region's ID @@ -381,7 +380,7 @@ export class Order extends BaseEntity { * description: See a list of codes. * currency: * description: Available if the relation `currency` is expanded. - * $ref: "#/components/schemas/currency" + * $ref: "#/components/schemas/Currency" * tax_rate: * description: The order's tax rate * type: number @@ -402,17 +401,17 @@ export class Order extends BaseEntity { * type: array * description: The shipping methods used in the order. Available if the relation `shipping_methods` is expanded. * items: - * $ref: "#/components/schemas/shipping_method" + * $ref: "#/components/schemas/ShippingMethod" * payments: * type: array * description: The payments used in the order. Available if the relation `payments` is expanded. * items: - * $ref: "#/components/schemas/payment" + * $ref: "#/components/schemas/Payment" * fulfillments: * type: array * description: The fulfillments used in the order. Available if the relation `fulfillments` is expanded. * items: - * $ref: "#/components/schemas/fulfillment" + * $ref: "#/components/schemas/Fulfillment" * returns: * type: array * description: The returns associated with the order. Available if the relation `returns` is expanded. @@ -448,17 +447,17 @@ export class Order extends BaseEntity { * type: array * description: The line items that belong to the order. Available if the relation `items` is expanded. * items: - * $ref: "#/components/schemas/line_item" + * $ref: "#/components/schemas/LineItem" * edits: * type: array * description: "[EXPERIMENTAL] Order edits done on the order. Available if the relation `edits` is expanded." * items: - * $ref: "#/components/schemas/order_edit" + * $ref: "#/components/schemas/OrderEdit" * gift_card_transactions: * type: array * description: The gift card transactions used in the order. Available if the relation `gift_card_transactions` is expanded. * items: - * $ref: "#/components/schemas/gift_card_transaction" + * $ref: "#/components/schemas/GiftCardTransaction" * canceled_at: * type: string * description: The date the order was canceled on. diff --git a/packages/medusa/src/models/payment-collection.ts b/packages/medusa/src/models/payment-collection.ts index 0d9d253bf1..cf2dd13e26 100644 --- a/packages/medusa/src/models/payment-collection.ts +++ b/packages/medusa/src/models/payment-collection.ts @@ -102,10 +102,9 @@ export class PaymentCollection extends SoftDeletableEntity { } /** - * @schema payment_collection + * @schema PaymentCollection * title: "Payment Collection" * description: "Payment Collection" - * x-resourceId: payment_collection * type: object * required: * - type @@ -148,7 +147,7 @@ export class PaymentCollection extends SoftDeletableEntity { * example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G * region: * description: Available if the relation `region` is expanded. - * $ref: "#/components/schemas/region" + * $ref: "#/components/schemas/Region" * currency_code: * description: "The 3 character ISO code for the currency." * type: string @@ -158,17 +157,17 @@ export class PaymentCollection extends SoftDeletableEntity { * description: See a list of codes. * currency: * description: Available if the relation `currency` is expanded. - * $ref: "#/components/schemas/currency" + * $ref: "#/components/schemas/Currency" * payment_sessions: * type: array * description: Available if the relation `payment_sessions` is expanded. * items: - * $ref: "#/components/schemas/payment_session" + * $ref: "#/components/schemas/PaymentSession" * payments: * type: array * description: Available if the relation `payments` is expanded. * items: - * $ref: "#/components/schemas/payment" + * $ref: "#/components/schemas/Payment" * created_by: * type: string * description: "The ID of the user that created the payment collection." diff --git a/packages/medusa/src/models/payment-provider.ts b/packages/medusa/src/models/payment-provider.ts index 4e46454578..022a0f8dab 100644 --- a/packages/medusa/src/models/payment-provider.ts +++ b/packages/medusa/src/models/payment-provider.ts @@ -10,10 +10,9 @@ export class PaymentProvider { } /** - * @schema payment_provider + * @schema PaymentProvider * title: "Payment Provider" * description: "Represents a Payment Provider plugin and holds its installation status." - * x-resourceId: payment_provider * type: object * required: * - id diff --git a/packages/medusa/src/models/payment-session.ts b/packages/medusa/src/models/payment-session.ts index ddfaa61b0c..70d5aeb042 100644 --- a/packages/medusa/src/models/payment-session.ts +++ b/packages/medusa/src/models/payment-session.ts @@ -1,4 +1,12 @@ -import { BeforeInsert, Column, Entity, Index, JoinColumn, ManyToOne, Unique, } from "typeorm" +import { + BeforeInsert, + Column, + Entity, + Index, + JoinColumn, + ManyToOne, + Unique, +} from "typeorm" import { BaseEntity } from "../interfaces" import { Cart } from "./cart" @@ -61,10 +69,9 @@ export class PaymentSession extends BaseEntity { } /** - * @schema payment_session + * @schema PaymentSession * title: "Payment Session" * description: "Payment Sessions are created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, who is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for capture/refunds/etc." - * x-resourceId: payment_session * type: object * required: * - cart_id diff --git a/packages/medusa/src/models/payment.ts b/packages/medusa/src/models/payment.ts index 45ced9eace..12be24e60e 100644 --- a/packages/medusa/src/models/payment.ts +++ b/packages/medusa/src/models/payment.ts @@ -87,10 +87,9 @@ export class Payment extends BaseEntity { } /** - * @schema payment + * @schema Payment * title: "Payment" * description: "Payments represent an amount authorized with a given payment method, Payments can be captured, canceled or refunded." - * x-resourceId: payment * type: object * required: * - amount @@ -134,7 +133,7 @@ export class Payment extends BaseEntity { * description: See a list of codes. * currency: * description: Available if the relation `currency` is expanded. - * $ref: "#/components/schemas/currency" + * $ref: "#/components/schemas/Currency" * amount_refunded: * description: "The amount of the original Payment amount that has been refunded back to the Customer." * type: integer diff --git a/packages/medusa/src/models/price-list.ts b/packages/medusa/src/models/price-list.ts index c7b039dc40..9fe7ee07c7 100644 --- a/packages/medusa/src/models/price-list.ts +++ b/packages/medusa/src/models/price-list.ts @@ -70,10 +70,9 @@ export class PriceList extends SoftDeletableEntity { } /** - * @schema price_list + * @schema PriceList * title: "Price List" * description: "Price Lists represents a set of prices that overrides the default price for one or more product variants." - * x-resourceId: price_list * type: object * required: * - name @@ -118,14 +117,14 @@ export class PriceList extends SoftDeletableEntity { * type: array * items: * type: object - * description: A customer group object. + * description: A customer group object. * prices: * description: The Money Amounts that are associated with the Price List. Available if the relation `prices` is expanded. * type: array * items: * oneOf: - * - $ref: "#/components/schemas/money_amount" - * - $ref: "#/components/schemas/customer_group" + * - $ref: "#/components/schemas/MoneyAmount" + * - $ref: "#/components/schemas/CustomerGroup" * includes_tax: * description: "[EXPERIMENTAL] Does the price list prices include tax" * type: boolean diff --git a/packages/medusa/src/models/product-collection.ts b/packages/medusa/src/models/product-collection.ts index d7498ff7bc..e5272a9105 100644 --- a/packages/medusa/src/models/product-collection.ts +++ b/packages/medusa/src/models/product-collection.ts @@ -33,10 +33,9 @@ export class ProductCollection extends SoftDeletableEntity { } /** - * @schema product_collection + * @schema ProductCollection * title: "Product Collection" * description: "Product Collections represents a group of Products that are related." - * x-resourceId: product_collection * type: object * required: * - title diff --git a/packages/medusa/src/models/product-option-value.ts b/packages/medusa/src/models/product-option-value.ts index b859a618a0..3ef00a6b45 100644 --- a/packages/medusa/src/models/product-option-value.ts +++ b/packages/medusa/src/models/product-option-value.ts @@ -46,10 +46,9 @@ export class ProductOptionValue extends SoftDeletableEntity { } /** - * @schema product_option_value + * @schema ProductOptionValue * title: "Product Option Value" * description: "A value given to a Product Variant's option set. Product Variant have a Product Option Value for each of the Product Options defined on the Product." - * x-resourceId: product_option_value * type: object * required: * - value @@ -70,14 +69,14 @@ export class ProductOptionValue extends SoftDeletableEntity { * example: opt_01F0YESHQBZVKCEXJ24BS6PCX3 * option: * description: Available if the relation `option` is expanded. - * $ref: "#/components/schemas/product_option" + * $ref: "#/components/schemas/ProductOption" * variant_id: * description: "The ID of the Product Variant that the Product Option Value is defined for." * type: string * example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6 * variant: * description: Available if the relation `variant` is expanded. - * $ref: "#/components/schemas/product_variant" + * $ref: "#/components/schemas/ProductVariant" * created_at: * type: string * description: "The date with timezone at which the resource was created." diff --git a/packages/medusa/src/models/product-option.ts b/packages/medusa/src/models/product-option.ts index e1c2bd8e9d..d225987fd5 100644 --- a/packages/medusa/src/models/product-option.ts +++ b/packages/medusa/src/models/product-option.ts @@ -40,10 +40,9 @@ export class ProductOption extends SoftDeletableEntity { } /** - * @schema product_option + * @schema ProductOption * title: "Product Option" * description: "Product Options define properties that may vary between different variants of a Product. Common Product Options are \"Size\" and \"Color\", but Medusa doesn't limit what Product Options that can be defined." - * x-resourceId: product_option * type: object * required: * - title @@ -61,7 +60,7 @@ export class ProductOption extends SoftDeletableEntity { * description: The Product Option Values that are defined for the Product Option. Available if the relation `values` is expanded. * type: array * items: - * $ref: "#/components/schemas/product_option_value" + * $ref: "#/components/schemas/ProductOptionValue" * product_id: * description: "The ID of the Product that the Product Option is defined for." * type: string diff --git a/packages/medusa/src/models/product-tag.ts b/packages/medusa/src/models/product-tag.ts index 91aa7abf89..08d03119da 100644 --- a/packages/medusa/src/models/product-tag.ts +++ b/packages/medusa/src/models/product-tag.ts @@ -19,10 +19,9 @@ export class ProductTag extends SoftDeletableEntity { } /** - * @schema product_tag + * @schema ProductTag * title: "Product Tag" * description: "Product Tags can be added to Products for easy filtering and grouping." - * x-resourceId: product_tag * type: object * required: * - value diff --git a/packages/medusa/src/models/product-tax-rate.ts b/packages/medusa/src/models/product-tax-rate.ts index bae8ab37ed..d3b2c44c27 100644 --- a/packages/medusa/src/models/product-tax-rate.ts +++ b/packages/medusa/src/models/product-tax-rate.ts @@ -39,10 +39,9 @@ export class ProductTaxRate { } /** - * @schema product_tax_rate + * @schema ProductTaxRate * title: "Product Tax Rate" * description: "Associates a tax rate with a product to indicate that the product is taxed in a certain way" - * x-resourceId: product_tax_rate * type: object * required: * - product_id @@ -54,14 +53,14 @@ export class ProductTaxRate { * example: prod_01G1G5V2MBA328390B5AXJ610F * product: * description: Available if the relation `product` is expanded. - * $ref: "#/components/schemas/product" + * $ref: "#/components/schemas/Product" * rate_id: * description: "The ID of the Tax Rate" * type: string * example: txr_01G8XDBAWKBHHJRKH0AV02KXBR * tax_rate: * description: Available if the relation `tax_rate` is expanded. - * $ref: "#/components/schemas/tax_rate" + * $ref: "#/components/schemas/TaxRate" * created_at: * type: string * description: "The date with timezone at which the resource was created." diff --git a/packages/medusa/src/models/product-type-tax-rate.ts b/packages/medusa/src/models/product-type-tax-rate.ts index 40217265ab..5b5f7d5356 100644 --- a/packages/medusa/src/models/product-type-tax-rate.ts +++ b/packages/medusa/src/models/product-type-tax-rate.ts @@ -38,10 +38,9 @@ export class ProductTypeTaxRate { } /** - * @schema product_type_tax_rate + * @schema ProductTypeTaxRate * title: "Product Type Tax Rate" * description: "Associates a tax rate with a product type to indicate that the product type is taxed in a certain way" - * x-resourceId: product_type_tax_rate * type: object * required: * - product_type_id @@ -53,14 +52,14 @@ export class ProductTypeTaxRate { * example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A * product_type: * description: Available if the relation `product_type` is expanded. - * $ref: "#/components/schemas/product_type" + * $ref: "#/components/schemas/ProductType" * rate_id: * description: "The id of the Tax Rate" * type: string * example: txr_01G8XDBAWKBHHJRKH0AV02KXBR * tax_rate: * description: Available if the relation `tax_rate` is expanded. - * $ref: "#/components/schemas/tax_rate" + * $ref: "#/components/schemas/TaxRate" * created_at: * type: string * description: "The date with timezone at which the resource was created." diff --git a/packages/medusa/src/models/product-type.ts b/packages/medusa/src/models/product-type.ts index b438b18b98..d26bb0c8c6 100644 --- a/packages/medusa/src/models/product-type.ts +++ b/packages/medusa/src/models/product-type.ts @@ -19,10 +19,9 @@ export class ProductType extends SoftDeletableEntity { } /** - * @schema product_type + * @schema ProductType * title: "Product Type" * description: "Product Type can be added to Products for filtering and reporting purposes." - * x-resourceId: product_type * type: object * required: * - value diff --git a/packages/medusa/src/models/product-variant.ts b/packages/medusa/src/models/product-variant.ts index 49768f83bf..41e307166e 100644 --- a/packages/medusa/src/models/product-variant.ts +++ b/packages/medusa/src/models/product-variant.ts @@ -101,10 +101,9 @@ export class ProductVariant extends SoftDeletableEntity { } /** - * @schema product_variant + * @schema ProductVariant * title: "Product Variant" * description: "Product Variants represent a Product with a specific set of Product Option configurations. The maximum number of Product Variants that a Product can have is given by the number of available Product Option combinations." - * x-resourceId: product_variant * type: object * required: * - title @@ -130,7 +129,7 @@ export class ProductVariant extends SoftDeletableEntity { * description: The Money Amounts defined for the Product Variant. Each Money Amount represents a price in a given currency or a price in a specific Region. Available if the relation `prices` is expanded. * type: array * items: - * $ref: "#/components/schemas/money_amount" + * $ref: "#/components/schemas/MoneyAmount" * sku: * description: "The unique stock keeping unit used to identify the Product Variant. This will usually be a unqiue identifer for the item that is to be shipped, and can be referenced across multiple systems." * type: string @@ -199,7 +198,7 @@ export class ProductVariant extends SoftDeletableEntity { * description: The Product Option Values specified for the Product Variant. Available if the relation `options` is expanded. * type: array * items: - * $ref: "#/components/schemas/product_option_value" + * $ref: "#/components/schemas/ProductOptionValue" * created_at: * type: string * description: "The date with timezone at which the resource was created." @@ -219,10 +218,9 @@ export class ProductVariant extends SoftDeletableEntity { */ /** - * @schema product_variant_prices_fields + * @schema ProductVariantPricesFields * title: "Product Variant Prices Fields" * description: "Product Variants Prices Fields that are only available in some requests." - * x-resourceId: product_variant_prices_fields * type: object * properties: * original_price: @@ -231,7 +229,7 @@ export class ProductVariant extends SoftDeletableEntity { * calculated_price: * type: number * description: The calculated price of the variant. Can be a discounted price. - * original_price_incl_tax: + * original_price_incl_tax: * type: number * description: The original price of the variant including taxes. * calculated_price_incl_tax: @@ -258,4 +256,4 @@ export class ProductVariant extends SoftDeletableEntity { * code: * type: string * description: The code of the tax rate - */ \ No newline at end of file + */ diff --git a/packages/medusa/src/models/product.ts b/packages/medusa/src/models/product.ts index 28a13c85ee..be26b32791 100644 --- a/packages/medusa/src/models/product.ts +++ b/packages/medusa/src/models/product.ts @@ -174,10 +174,9 @@ export class Product extends SoftDeletableEntity { } /** - * @schema product + * @schema Product * title: "Product" * description: "Products are a grouping of Product Variants that have common properties such as images and descriptions. Products can have multiple options which define the properties that Product Variants differ by." - * x-resourceId: product * type: object * required: * - title @@ -219,7 +218,7 @@ export class Product extends SoftDeletableEntity { * description: Images of the Product. Available if the relation `images` is expanded. * type: array * items: - * $ref: "#/components/schemas/image" + * $ref: "#/components/schemas/Image" * thumbnail: * description: "A URL to an image file that can be used to identify the Product." * type: string @@ -228,19 +227,19 @@ export class Product extends SoftDeletableEntity { * description: The Product Options that are defined for the Product. Product Variants of the Product will have a unique combination of Product Option Values. Available if the relation `options` is expanded. * type: array * items: - * $ref: "#/components/schemas/product_option" + * $ref: "#/components/schemas/ProductOption" * variants: * description: The Product Variants that belong to the Product. Each will have a unique combination of Product Option Values. Available if the relation `variants` is expanded. * type: array * items: - * $ref: "#/components/schemas/product_variant" + * $ref: "#/components/schemas/ProductVariant" * profile_id: * description: "The ID of the Shipping Profile that the Product belongs to. Shipping Profiles have a set of defined Shipping Options that can be used to Fulfill a given set of Products." * type: string * example: sp_01G1G5V239ENSZ5MV4JAR737BM * profile: * description: Available if the relation `profile` is expanded. - * $ref: "#/components/schemas/shipping_profile" + * $ref: "#/components/schemas/ShippingProfile" * weight: * description: "The weight of the Product Variant. May be used in shipping rate calculations." * type: number @@ -286,12 +285,12 @@ export class Product extends SoftDeletableEntity { * example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A * type: * description: Available if the relation `type` is expanded. - * $ref: "#/components/schemas/product_type" + * $ref: "#/components/schemas/ProductType" * tags: * description: The Product Tags assigned to the Product. Available if the relation `tags` is expanded. * type: array * items: - * $ref: "#/components/schemas/product_tag" + * $ref: "#/components/schemas/ProductTag" * discountable: * description: "Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`." * type: boolean diff --git a/packages/medusa/src/models/publishable-api-key-sales-channel.ts b/packages/medusa/src/models/publishable-api-key-sales-channel.ts index 1d2147c85f..7cc910ccf7 100644 --- a/packages/medusa/src/models/publishable-api-key-sales-channel.ts +++ b/packages/medusa/src/models/publishable-api-key-sales-channel.ts @@ -13,10 +13,9 @@ export class PublishableApiKeySalesChannel { } /** - * @schema publishable_api_key_sales_channel + * @schema PublishableApiKeySalesChannel * title: "Publishable API key sales channel" * description: "Holds mapping between Publishable API keys and Sales Channels" - * x-resourceId: publishable_api_key_sales_channel * type: object * properties: * sales_channel_id: diff --git a/packages/medusa/src/models/publishable-api-key.ts b/packages/medusa/src/models/publishable-api-key.ts index e89a8483fb..293284f48c 100644 --- a/packages/medusa/src/models/publishable-api-key.ts +++ b/packages/medusa/src/models/publishable-api-key.ts @@ -27,10 +27,9 @@ export class PublishableApiKey extends BaseEntity { } /** - * @schema publishable_api_key + * @schema PublishableApiKey * title: "Publishable API key" * description: "Publishable API key defines scopes (i.e. resources) that are available within a request." - * x-resourceId: publishable_api_key * type: object * properties: * id: diff --git a/packages/medusa/src/models/refund.ts b/packages/medusa/src/models/refund.ts index b0fc4f37dc..047c1700e4 100644 --- a/packages/medusa/src/models/refund.ts +++ b/packages/medusa/src/models/refund.ts @@ -68,10 +68,9 @@ export class Refund extends BaseEntity { } /** - * @schema refund + * @schema Refund * title: "Refund" * description: "Refund represent an amount of money transfered back to the Customer for a given reason. Refunds may occur in relation to Returns, Swaps and Claims, but can also be initiated by a store operator." - * x-resourceId: refund * type: object * required: * - order_id diff --git a/packages/medusa/src/models/region.ts b/packages/medusa/src/models/region.ts index ae2ceb3808..033451155a 100644 --- a/packages/medusa/src/models/region.ts +++ b/packages/medusa/src/models/region.ts @@ -107,10 +107,9 @@ export class Region extends SoftDeletableEntity { } /** - * @schema region + * @schema Region * title: "Region" * description: "Regions hold settings for how Customers in a given geographical location shop. The is, for example, where currencies and tax rates are defined. A Region can consist of multiple countries to accomodate common shopping settings across countries." - * x-resourceId: region * type: object * required: * - name @@ -134,7 +133,7 @@ export class Region extends SoftDeletableEntity { * description: See a list of codes. * currency: * description: Available if the relation `currency` is expanded. - * $ref: "#/components/schemas/currency" + * $ref: "#/components/schemas/Currency" * tax_rate: * description: "The tax rate that should be charged on purchases in the Region." * type: number @@ -143,7 +142,7 @@ export class Region extends SoftDeletableEntity { * description: The tax rates that are included in the Region. Available if the relation `tax_rates` is expanded. * type: array * items: - * $ref: "#/components/schemas/tax_rate" + * $ref: "#/components/schemas/TaxRate" * tax_code: * description: "The tax code used on purchases in the Region. This may be used by other systems for accounting purposes." * type: string @@ -160,24 +159,24 @@ export class Region extends SoftDeletableEntity { * description: The countries that are included in the Region. Available if the relation `countries` is expanded. * type: array * items: - * $ref: "#/components/schemas/country" + * $ref: "#/components/schemas/Country" * tax_provider_id: * type: string * description: The ID of the tax provider used in this region * example: null * tax_provider: * description: Available if the relation `tax_provider` is expanded. - * $ref: "#/components/schemas/tax_provider" + * $ref: "#/components/schemas/TaxProvider" * payment_providers: * description: The Payment Providers that can be used to process Payments in the Region. Available if the relation `payment_providers` is expanded. * type: array * items: - * $ref: "#/components/schemas/payment_provider" + * $ref: "#/components/schemas/PaymentProvider" * fulfillment_providers: * description: The Fulfillment Providers that can be used to fulfill orders in the Region. Available if the relation `payment_providers` is expanded. * type: array * items: - * $ref: "#/components/schemas/fulfillment_provider" + * $ref: "#/components/schemas/FulfillmentProvider" * includes_tax: * description: "[EXPERIMENTAL] Does the prices for the region include tax" * type: boolean diff --git a/packages/medusa/src/models/return-item.ts b/packages/medusa/src/models/return-item.ts index 7a7d53046a..a1a5cf9020 100644 --- a/packages/medusa/src/models/return-item.ts +++ b/packages/medusa/src/models/return-item.ts @@ -48,10 +48,9 @@ export class ReturnItem { } /** - * @schema return_item + * @schema ReturnItem * title: "Return Item" * description: "Correlates a Line Item with a Return, keeping track of the quantity of the Line Item that will be returned." - * x-resourceId: return_item * type: object * required: * - return_id @@ -63,14 +62,14 @@ export class ReturnItem { * example: ret_01F0YET7XPCMF8RZ0Y151NZV2V * return_order: * description: Available if the relation `return_order` is expanded. - * $ref: "#/components/schemas/return" + * $ref: "#/components/schemas/Return" * item_id: * description: "The id of the Line Item that the Return Item references." * type: string * example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN * item: * description: Available if the relation `item` is expanded. - * $ref: "#/components/schemas/line_item" + * $ref: "#/components/schemas/LineItem" * quantity: * description: "The quantity of the Line Item that is included in the Return." * type: integer @@ -93,7 +92,7 @@ export class ReturnItem { * example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ * reason: * description: Available if the relation `reason` is expanded. - * $ref: "#/components/schemas/return_reason" + * $ref: "#/components/schemas/ReturnReason" * note: * description: "An optional note with additional details about the Return." * type: string diff --git a/packages/medusa/src/models/return-reason.ts b/packages/medusa/src/models/return-reason.ts index 09d9c4fbd5..eeca6b66ed 100644 --- a/packages/medusa/src/models/return-reason.ts +++ b/packages/medusa/src/models/return-reason.ts @@ -48,10 +48,9 @@ export class ReturnReason extends SoftDeletableEntity { } /** - * @schema return_reason + * @schema ReturnReason * title: "Return Reason" * description: "A Reason for why a given product is returned. A Return Reason can be used on Return Items in order to indicate why a Line Item was returned." - * x-resourceId: return_reason * type: object * required: * - value @@ -79,10 +78,10 @@ export class ReturnReason extends SoftDeletableEntity { * example: null * parent_return_reason: * description: Available if the relation `parent_return_reason` is expanded. - * $ref: "#/components/schemas/return_reason" + * $ref: "#/components/schemas/ReturnReason" * return_reason_children: * description: Available if the relation `return_reason_children` is expanded. - * $ref: "#/components/schemas/return_reason" + * $ref: "#/components/schemas/ReturnReason" * created_at: * type: string * description: "The date with timezone at which the resource was created." diff --git a/packages/medusa/src/models/return.ts b/packages/medusa/src/models/return.ts index a15781672f..4315e5b6ff 100644 --- a/packages/medusa/src/models/return.ts +++ b/packages/medusa/src/models/return.ts @@ -94,10 +94,9 @@ export class Return extends BaseEntity { } /** - * @schema return + * @schema Return * title: "Return" * description: "Return orders hold information about Line Items that a Customer wishes to send back, along with how the items will be returned. Returns can be used as part of a Swap." - * x-resourceId: return * type: object * required: * - refund_amount @@ -119,7 +118,7 @@ export class Return extends BaseEntity { * description: The Return Items that will be shipped back to the warehouse. Available if the relation `items` is expanded. * type: array * items: - * $ref: "#/components/schemas/return_item" + * $ref: "#/components/schemas/ReturnItem" * swap_id: * description: "The ID of the Swap that the Return is a part of." * type: string @@ -145,7 +144,7 @@ export class Return extends BaseEntity { * description: The Shipping Method that will be used to send the Return back. Can be null if the Customer facilitates the return shipment themselves. Available if the relation `shipping_method` is expanded. * type: array * items: - * $ref: "#/components/schemas/shipping_method" + * $ref: "#/components/schemas/ShippingMethod" * shipping_data: * description: "Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment." * type: object diff --git a/packages/medusa/src/models/sales-channel.ts b/packages/medusa/src/models/sales-channel.ts index e1820fbacd..4d9250deec 100644 --- a/packages/medusa/src/models/sales-channel.ts +++ b/packages/medusa/src/models/sales-channel.ts @@ -22,10 +22,9 @@ export class SalesChannel extends SoftDeletableEntity { } /** - * @schema sales_channel + * @schema SalesChannel * title: "Sales Channel" * description: "A Sales Channel" - * x-resourceId: sales_channel * type: object * required: * - name @@ -58,4 +57,4 @@ export class SalesChannel extends SoftDeletableEntity { * type: string * description: "The date with timezone at which the resource was deleted." * format: date-time - */ \ No newline at end of file + */ diff --git a/packages/medusa/src/models/shipping-method-tax-line.ts b/packages/medusa/src/models/shipping-method-tax-line.ts index 3da5c61b0e..d01a99fffc 100644 --- a/packages/medusa/src/models/shipping-method-tax-line.ts +++ b/packages/medusa/src/models/shipping-method-tax-line.ts @@ -30,10 +30,9 @@ export class ShippingMethodTaxLine extends TaxLine { } /** - * @schema shipping_method_tax_line + * @schema ShippingMethodTaxLine * title: "Shipping Method Tax Line" * description: "Shipping Method Tax Line" - * x-resourceId: shipping_method_tax_line * type: object * required: * - shipping_method_id @@ -50,7 +49,7 @@ export class ShippingMethodTaxLine extends TaxLine { * example: sm_01F0YET7DR2E7CYVSDHM593QG2 * shipping_method: * description: Available if the relation `shipping_method` is expanded. - * $ref: "#/components/schemas/shipping_method" + * $ref: "#/components/schemas/ShippingMethod" * code: * description: "A code to identify the tax type by" * type: string @@ -75,4 +74,4 @@ export class ShippingMethodTaxLine extends TaxLine { * type: object * description: An optional key-value map with additional details * example: {car: "white"} - */ \ No newline at end of file + */ diff --git a/packages/medusa/src/models/shipping-method.ts b/packages/medusa/src/models/shipping-method.ts index b8fd40169f..ac3227eb9b 100644 --- a/packages/medusa/src/models/shipping-method.ts +++ b/packages/medusa/src/models/shipping-method.ts @@ -105,10 +105,9 @@ export class ShippingMethod { } /** - * @schema shipping_method + * @schema ShippingMethod * title: "Shipping Method" * description: "Shipping Methods represent a way in which an Order or Return can be shipped. Shipping Methods are built from a Shipping Option, but may contain additional details, that can be necessary for the Fulfillment Provider to handle the shipment." - * x-resourceId: shipping_method * type: object * required: * - shipping_option_id @@ -124,7 +123,7 @@ export class ShippingMethod { * example: so_01G1G5V27GYX4QXNARRQCW1N8T * shipping_option: * description: Available if the relation `shipping_option` is expanded. - * $ref: "#/components/schemas/shipping_option" + * $ref: "#/components/schemas/ShippingOption" * order_id: * description: "The id of the Order that the Shipping Method is used on." * type: string @@ -164,7 +163,7 @@ export class ShippingMethod { * type: array * description: Available if the relation `tax_lines` is expanded. * items: - * $ref: "#/components/schemas/shipping_method_tax_line" + * $ref: "#/components/schemas/ShippingMethodTaxLine" * price: * description: "The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of." * type: integer diff --git a/packages/medusa/src/models/shipping-option-requirement.ts b/packages/medusa/src/models/shipping-option-requirement.ts index ec2eb0a663..a31c33f444 100644 --- a/packages/medusa/src/models/shipping-option-requirement.ts +++ b/packages/medusa/src/models/shipping-option-requirement.ts @@ -47,10 +47,9 @@ export class ShippingOptionRequirement { } /** - * @schema shipping_option_requirement + * @schema ShippingOptionRequirement * title: "Shipping Option Requirement" * description: "A requirement that a Cart must satisfy for the Shipping Option to be available to the Cart." - * x-resourceId: shipping_option_requirement * type: object * required: * - shipping_option_id @@ -67,7 +66,7 @@ export class ShippingOptionRequirement { * example: so_01G1G5V27GYX4QXNARRQCW1N8T * shipping_option: * description: Available if the relation `shipping_option` is expanded. - * $ref: "#/components/schemas/shipping_option" + * $ref: "#/components/schemas/ShippingOption" * type: * description: "The type of the requirement, this defines how the value will be compared to the Cart's total. `min_subtotal` requirements define the minimum subtotal that is needed for the Shipping Option to be available, while the `max_subtotal` defines the maximum subtotal that the Cart can have for the Shipping Option to be available." * type: string diff --git a/packages/medusa/src/models/shipping-option.ts b/packages/medusa/src/models/shipping-option.ts index 425fad1b82..367a6111c1 100644 --- a/packages/medusa/src/models/shipping-option.ts +++ b/packages/medusa/src/models/shipping-option.ts @@ -87,10 +87,9 @@ export class ShippingOption extends SoftDeletableEntity { } /** - * @schema shipping_option + * @schema ShippingOption * title: "Shipping Option" * description: "Shipping Options represent a way in which an Order or Return can be shipped. Shipping Options have an associated Fulfillment Provider that will be used when the fulfillment of an Order is initiated. Shipping Options themselves cannot be added to Carts, but serve as a template for Shipping Methods. This distinction makes it possible to customize individual Shipping Methods with additional information." - * x-resourceId: shipping_option * type: object * required: * - name @@ -120,14 +119,14 @@ export class ShippingOption extends SoftDeletableEntity { * example: sp_01G1G5V239ENSZ5MV4JAR737BM * profile: * description: Available if the relation `profile` is expanded. - * $ref: "#/components/schemas/shipping_profile" + * $ref: "#/components/schemas/ShippingProfile" * provider_id: * description: "The id of the Fulfillment Provider, that will be used to process Fulfillments from the Shipping Option." * type: string * example: manual * provider: * description: Available if the relation `provider` is expanded. - * $ref: "#/components/schemas/fulfillment_provider" + * $ref: "#/components/schemas/FulfillmentProvider" * price_type: * description: "The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations." * type: string @@ -147,7 +146,7 @@ export class ShippingOption extends SoftDeletableEntity { * description: The requirements that must be satisfied for the Shipping Option to be available for a Cart. Available if the relation `requirements` is expanded. * type: array * items: - * $ref: "#/components/schemas/shipping_option_requirement" + * $ref: "#/components/schemas/ShippingOptionRequirement" * data: * description: "The data needed for the Fulfillment Provider to identify the Shipping Option." * type: object diff --git a/packages/medusa/src/models/shipping-profile.ts b/packages/medusa/src/models/shipping-profile.ts index f6236368db..e2a14ff56e 100644 --- a/packages/medusa/src/models/shipping-profile.ts +++ b/packages/medusa/src/models/shipping-profile.ts @@ -36,10 +36,9 @@ export class ShippingProfile extends SoftDeletableEntity { } /** - * @schema shipping_profile + * @schema ShippingProfile * title: "Shipping Profile" * description: "Shipping Profiles have a set of defined Shipping Options that can be used to fulfill a given set of Products." - * x-resourceId: shipping_profile * type: object * required: * - name @@ -71,7 +70,7 @@ export class ShippingProfile extends SoftDeletableEntity { * description: The Shipping Options that can be used to fulfill the Products in the Shipping Profile. Available if the relation `shipping_options` is expanded. * type: array * items: - * $ref: "#/components/schemas/shipping_option" + * $ref: "#/components/schemas/ShippingOption" * created_at: * type: string * description: "The date with timezone at which the resource was created." diff --git a/packages/medusa/src/models/shipping-tax-rate.ts b/packages/medusa/src/models/shipping-tax-rate.ts index ef4c215a5c..59f93bfcf4 100644 --- a/packages/medusa/src/models/shipping-tax-rate.ts +++ b/packages/medusa/src/models/shipping-tax-rate.ts @@ -38,10 +38,9 @@ export class ShippingTaxRate { } /** - * @schema shipping_tax_rate + * @schema ShippingTaxRate * title: "Shipping Tax Rate" * description: "Associates a tax rate with a shipping option to indicate that the shipping option is taxed in a certain way" - * x-resourceId: shipping_tax_rate * type: object * required: * - shipping_option_id @@ -53,14 +52,14 @@ export class ShippingTaxRate { * example: so_01G1G5V27GYX4QXNARRQCW1N8T * shipping_option: * description: Available if the relation `shipping_option` is expanded. - * $ref: "#/components/schemas/shipping_option" + * $ref: "#/components/schemas/ShippingOption" * rate_id: * description: "The ID of the Tax Rate" * type: string * example: txr_01G8XDBAWKBHHJRKH0AV02KXBR * tax_rate: * description: Available if the relation `tax_rate` is expanded. - * $ref: "#/components/schemas/tax_rate" + * $ref: "#/components/schemas/TaxRate" * created_at: * type: string * description: "The date with timezone at which the resource was created." diff --git a/packages/medusa/src/models/staged-job.ts b/packages/medusa/src/models/staged-job.ts index 909044bc1b..8f657e2b90 100644 --- a/packages/medusa/src/models/staged-job.ts +++ b/packages/medusa/src/models/staged-job.ts @@ -21,10 +21,9 @@ export class StagedJob { } /** - * @schema staged_job + * @schema StagedJob * title: "Staged Job" * description: "A staged job resource" - * x-resourceId: staged_job * type: object * required: * - event_name @@ -41,4 +40,4 @@ export class StagedJob { * description: Data necessary for the job * type: object * example: {} - */ \ No newline at end of file + */ diff --git a/packages/medusa/src/models/store.ts b/packages/medusa/src/models/store.ts index 82a80131cc..8c338295aa 100644 --- a/packages/medusa/src/models/store.ts +++ b/packages/medusa/src/models/store.ts @@ -73,10 +73,9 @@ export class Store extends BaseEntity { } /** - * @schema store + * @schema Store * title: "Store" * description: "Holds settings for the Store, such as name, currencies, etc." - * x-resourceId: store * type: object * properties: * id: @@ -96,12 +95,12 @@ export class Store extends BaseEntity { * description: See a list of codes. * default_currency: * description: Available if the relation `default_currency` is expanded. - * $ref: "#/components/schemas/currency" + * $ref: "#/components/schemas/Currency" * currencies: * description: The currencies that are enabled for the Store. Available if the relation `currencies` is expanded. * type: array * items: - * $ref: "#/components/schemas/currency" + * $ref: "#/components/schemas/Currency" * swap_link_template: * description: "A template to generate Swap links from. Use {{cart_id}} to include the Swap's `cart_id` in the link." * type: string diff --git a/packages/medusa/src/models/swap.ts b/packages/medusa/src/models/swap.ts index 577b31884e..e02ef3b7ed 100644 --- a/packages/medusa/src/models/swap.ts +++ b/packages/medusa/src/models/swap.ts @@ -119,10 +119,9 @@ export class Swap extends SoftDeletableEntity { } /** - * @schema swap + * @schema Swap * title: "Swap" * description: "Swaps can be created when a Customer wishes to exchange Products that they have purchased to different Products. Swaps consist of a Return of previously purchased Products and a Fulfillment of new Products, the amount paid for the Products being returned will be used towards payment for the new Products. In the case where the amount paid for the the Products being returned exceed the amount to be paid for the new Products, a Refund will be issued for the difference." - * x-resourceId: swap * type: object * required: * - fulfillment_status @@ -168,7 +167,7 @@ export class Swap extends SoftDeletableEntity { * description: The new Line Items to ship to the Customer. Available if the relation `additional_items` is expanded. * type: array * items: - * $ref: "#/components/schemas/line_item" + * $ref: "#/components/schemas/LineItem" * return_order: * description: A return order object. The Return that is issued for the return part of the Swap. Available if the relation `return_order` is expanded. * type: object @@ -176,10 +175,10 @@ export class Swap extends SoftDeletableEntity { * description: The Fulfillments used to send the new Line Items. Available if the relation `fulfillments` is expanded. * type: array * items: - * $ref: "#/components/schemas/fulfillment" + * $ref: "#/components/schemas/Fulfillment" * payment: * description: The Payment authorized when the Swap requires an additional amount to be charged from the Customer. Available if the relation `payment` is expanded. - * $ref: "#/components/schemas/payment" + * $ref: "#/components/schemas/Payment" * difference_due: * description: "The difference that is paid or refunded as a result of the Swap. May be negative when the amount paid for the returned items exceed the total of the new Products." * type: integer @@ -190,12 +189,12 @@ export class Swap extends SoftDeletableEntity { * example: addr_01G8ZH853YPY9B94857DY91YGW * shipping_address: * description: Available if the relation `shipping_address` is expanded. - * $ref: "#/components/schemas/address" + * $ref: "#/components/schemas/Address" * shipping_methods: * description: The Shipping Methods used to fulfill the additional items purchased. Available if the relation `shipping_methods` is expanded. * type: array * items: - * $ref: "#/components/schemas/shipping_method" + * $ref: "#/components/schemas/ShippingMethod" * cart_id: * description: "The id of the Cart that the Customer will use to confirm the Swap." * type: string diff --git a/packages/medusa/src/models/tax-line.ts b/packages/medusa/src/models/tax-line.ts index 1a415b9f7f..67d7038479 100644 --- a/packages/medusa/src/models/tax-line.ts +++ b/packages/medusa/src/models/tax-line.ts @@ -17,10 +17,9 @@ export class TaxLine extends BaseEntity { } /** - * @schema tax_line + * @schema TaxLine * title: "Tax Line" * description: "Line item that specifies an amount of tax to add to a line item." - * x-resourceId: tax_line * type: object * required: * - rate diff --git a/packages/medusa/src/models/tax-provider.ts b/packages/medusa/src/models/tax-provider.ts index e7e9c21ae1..fb28032e81 100644 --- a/packages/medusa/src/models/tax-provider.ts +++ b/packages/medusa/src/models/tax-provider.ts @@ -10,10 +10,9 @@ export class TaxProvider { } /** - * @schema tax_provider + * @schema TaxProvider * title: "Tax Provider" * description: "The tax service used to calculate taxes" - * x-resourceId: tax_provider * type: object * properties: * id: diff --git a/packages/medusa/src/models/tax-rate.ts b/packages/medusa/src/models/tax-rate.ts index 29c6bb33a5..c4853602fa 100644 --- a/packages/medusa/src/models/tax-rate.ts +++ b/packages/medusa/src/models/tax-rate.ts @@ -91,10 +91,9 @@ export class TaxRate extends BaseEntity { } /** - * @schema tax_rate + * @schema TaxRate * title: "Tax Rate" * description: "A Tax Rate can be used to associate a certain rate to charge on products within a given Region" - * x-resourceId: line_item * type: object * required: * - name diff --git a/packages/medusa/src/models/tracking-link.ts b/packages/medusa/src/models/tracking-link.ts index ef03283320..ae847e1c70 100644 --- a/packages/medusa/src/models/tracking-link.ts +++ b/packages/medusa/src/models/tracking-link.ts @@ -33,10 +33,9 @@ export class TrackingLink extends SoftDeletableEntity { } /** - * @schema tracking_link + * @schema TrackingLink * title: "Tracking Link" * description: "Tracking Link holds information about tracking numbers for a Fulfillment. Tracking Links can optionally contain a URL that can be visited to see the status of the shipment." - * x-resourceId: tracking_link * type: object * required: * - tracking_number @@ -60,7 +59,7 @@ export class TrackingLink extends SoftDeletableEntity { * example: ful_01G8ZRTMQCA76TXNAT81KPJZRF * fulfillment: * description: Available if the relation `fulfillment` is expanded. - * $ref: "#/components/schemas/fulfillment" + * $ref: "#/components/schemas/Fulfillment" * idempotency_key: * type: string * description: Randomly generated key used to continue the completion of a process in case of failure. diff --git a/packages/medusa/src/models/user.ts b/packages/medusa/src/models/user.ts index ff9817bfb2..16c073b1ff 100644 --- a/packages/medusa/src/models/user.ts +++ b/packages/medusa/src/models/user.ts @@ -46,10 +46,9 @@ export class User extends SoftDeletableEntity { } /** - * @schema user + * @schema User * title: "User" * description: "Represents a User who can manage store settings." - * x-resourceId: user * type: object * required: * - email