From 287c829c9c5a9797fb8cd118b7a6066ad1935898 Mon Sep 17 00:00:00 2001 From: Patrick <116003638+patrick-medusajs@users.noreply.github.com> Date: Wed, 22 Feb 2023 10:43:41 -0500 Subject: [PATCH] feat(oas): include `/admin` and `/store` in paths URLs (#3314) ## What Include `/admin` and `/store` in OAS paths URLs ## Why Allow for generating a combined OAS that include routes for both "admin" and "store" endpoint. Fix potential issues with code generator where routes are not prefixed with "admin" and "store" leading to 404 errors. ## Test * Run `yarn build` * Run `yarn openapi:generate` * Run `yarn redocly preview-docs docs/api/admin/openapi.yaml --config=./docs-util/redocly/config.yaml` * Expect paths to be prefixed with /admin. * Run `yarn redocly preview-docs docs/api/store/openapi.yaml --config=./docs-util/redocly/config.yaml` * Expect paths to be prefixed with /store. --- .changeset/nice-dryers-search.md | 5 +++++ packages/medusa/oas/admin-spec3-base.yaml | 2 +- packages/medusa/oas/store-spec3-base.yaml | 2 +- packages/medusa/src/api/routes/admin/apps/authorize-app.ts | 2 +- packages/medusa/src/api/routes/admin/apps/list.ts | 2 +- packages/medusa/src/api/routes/admin/auth/create-session.ts | 2 +- packages/medusa/src/api/routes/admin/auth/delete-session.ts | 2 +- packages/medusa/src/api/routes/admin/auth/get-session.ts | 2 +- .../medusa/src/api/routes/admin/batch/cancel-batch-job.ts | 2 +- .../medusa/src/api/routes/admin/batch/confirm-batch-job.ts | 2 +- .../medusa/src/api/routes/admin/batch/create-batch-job.ts | 2 +- packages/medusa/src/api/routes/admin/batch/get-batch-job.ts | 2 +- .../medusa/src/api/routes/admin/batch/list-batch-jobs.ts | 2 +- .../medusa/src/api/routes/admin/collections/add-products.ts | 2 +- .../src/api/routes/admin/collections/create-collection.ts | 2 +- .../src/api/routes/admin/collections/delete-collection.ts | 2 +- .../src/api/routes/admin/collections/get-collection.ts | 2 +- .../src/api/routes/admin/collections/list-collections.ts | 2 +- .../src/api/routes/admin/collections/remove-products.ts | 2 +- .../src/api/routes/admin/collections/update-collection.ts | 2 +- .../src/api/routes/admin/currencies/list-currencies.ts | 2 +- .../src/api/routes/admin/currencies/update-currency.ts | 2 +- .../api/routes/admin/customer-groups/add-customers-batch.ts | 2 +- .../routes/admin/customer-groups/create-customer-group.ts | 2 +- .../routes/admin/customer-groups/delete-customer-group.ts | 2 +- .../routes/admin/customer-groups/delete-customers-batch.ts | 2 +- .../admin/customer-groups/get-customer-group-customers.ts | 2 +- .../api/routes/admin/customer-groups/get-customer-group.ts | 2 +- .../routes/admin/customer-groups/list-customer-groups.ts | 2 +- .../routes/admin/customer-groups/update-customer-group.ts | 2 +- .../src/api/routes/admin/customers/create-customer.ts | 2 +- .../medusa/src/api/routes/admin/customers/get-customer.ts | 2 +- .../medusa/src/api/routes/admin/customers/list-customers.ts | 2 +- .../src/api/routes/admin/customers/update-customer.ts | 2 +- .../medusa/src/api/routes/admin/discounts/add-region.ts | 2 +- .../admin/discounts/add-resources-to-condition-batch.ts | 2 +- .../src/api/routes/admin/discounts/create-condition.ts | 2 +- .../src/api/routes/admin/discounts/create-discount.ts | 2 +- .../src/api/routes/admin/discounts/create-dynamic-code.ts | 2 +- .../src/api/routes/admin/discounts/delete-condition.ts | 2 +- .../src/api/routes/admin/discounts/delete-discount.ts | 2 +- .../src/api/routes/admin/discounts/delete-dynamic-code.ts | 2 +- .../discounts/delete-resources-from-condition-batch.ts | 2 +- .../medusa/src/api/routes/admin/discounts/get-condition.ts | 2 +- .../src/api/routes/admin/discounts/get-discount-by-code.ts | 2 +- .../medusa/src/api/routes/admin/discounts/get-discount.ts | 2 +- .../medusa/src/api/routes/admin/discounts/list-discounts.ts | 2 +- .../medusa/src/api/routes/admin/discounts/remove-region.ts | 2 +- .../src/api/routes/admin/discounts/update-condition.ts | 2 +- .../src/api/routes/admin/discounts/update-discount.ts | 2 +- .../src/api/routes/admin/draft-orders/create-draft-order.ts | 2 +- .../src/api/routes/admin/draft-orders/create-line-item.ts | 2 +- .../src/api/routes/admin/draft-orders/delete-draft-order.ts | 2 +- .../src/api/routes/admin/draft-orders/delete-line-item.ts | 2 +- .../src/api/routes/admin/draft-orders/get-draft-order.ts | 2 +- .../src/api/routes/admin/draft-orders/list-draft-orders.ts | 2 +- .../src/api/routes/admin/draft-orders/register-payment.ts | 2 +- .../src/api/routes/admin/draft-orders/update-draft-order.ts | 2 +- .../src/api/routes/admin/draft-orders/update-line-item.ts | 2 +- .../src/api/routes/admin/gift-cards/create-gift-card.ts | 2 +- .../src/api/routes/admin/gift-cards/delete-gift-card.ts | 2 +- .../medusa/src/api/routes/admin/gift-cards/get-gift-card.ts | 2 +- .../src/api/routes/admin/gift-cards/list-gift-cards.ts | 2 +- .../src/api/routes/admin/gift-cards/update-gift-card.ts | 2 +- .../routes/admin/inventory-items/create-location-level.ts | 2 +- .../routes/admin/inventory-items/delete-inventory-item.ts | 2 +- .../routes/admin/inventory-items/delete-location-level.ts | 2 +- .../api/routes/admin/inventory-items/get-inventory-item.ts | 2 +- .../routes/admin/inventory-items/list-inventory-items.ts | 6 +++--- .../routes/admin/inventory-items/list-location-levels.ts | 2 +- .../routes/admin/inventory-items/update-inventory-item.ts | 2 +- .../routes/admin/inventory-items/update-location-level.ts | 4 ++-- .../medusa/src/api/routes/admin/invites/accept-invite.ts | 2 +- .../medusa/src/api/routes/admin/invites/create-invite.ts | 2 +- .../medusa/src/api/routes/admin/invites/delete-invite.ts | 2 +- .../medusa/src/api/routes/admin/invites/list-invites.ts | 2 +- .../medusa/src/api/routes/admin/invites/resend-invite.ts | 2 +- packages/medusa/src/api/routes/admin/notes/create-note.ts | 2 +- packages/medusa/src/api/routes/admin/notes/delete-note.ts | 2 +- packages/medusa/src/api/routes/admin/notes/get-note.ts | 2 +- packages/medusa/src/api/routes/admin/notes/list-notes.ts | 2 +- packages/medusa/src/api/routes/admin/notes/update-note.ts | 2 +- .../api/routes/admin/notifications/list-notifications.ts | 2 +- .../api/routes/admin/notifications/resend-notification.ts | 2 +- .../src/api/routes/admin/order-edits/add-line-item.ts | 2 +- .../src/api/routes/admin/order-edits/cancel-order-edit.ts | 2 +- .../src/api/routes/admin/order-edits/confirm-order-edit.ts | 2 +- .../src/api/routes/admin/order-edits/create-order-edit.ts | 2 +- .../src/api/routes/admin/order-edits/delete-line-item.ts | 2 +- .../admin/order-edits/delete-order-edit-item-change.ts | 2 +- .../src/api/routes/admin/order-edits/delete-order-edit.ts | 2 +- .../src/api/routes/admin/order-edits/get-order-edit.ts | 2 +- .../src/api/routes/admin/order-edits/list-order-edit.ts | 2 +- .../api/routes/admin/order-edits/request-confirmation.ts | 2 +- .../routes/admin/order-edits/update-order-edit-line-item.ts | 2 +- .../src/api/routes/admin/order-edits/update-order-edit.ts | 2 +- .../src/api/routes/admin/orders/add-shipping-method.ts | 2 +- .../medusa/src/api/routes/admin/orders/archive-order.ts | 2 +- packages/medusa/src/api/routes/admin/orders/cancel-claim.ts | 2 +- .../src/api/routes/admin/orders/cancel-fulfillment-claim.ts | 2 +- .../src/api/routes/admin/orders/cancel-fulfillment-swap.ts | 2 +- .../src/api/routes/admin/orders/cancel-fulfillment.ts | 2 +- packages/medusa/src/api/routes/admin/orders/cancel-order.ts | 2 +- packages/medusa/src/api/routes/admin/orders/cancel-swap.ts | 2 +- .../medusa/src/api/routes/admin/orders/capture-payment.ts | 2 +- .../medusa/src/api/routes/admin/orders/complete-order.ts | 2 +- .../src/api/routes/admin/orders/create-claim-shipment.ts | 2 +- packages/medusa/src/api/routes/admin/orders/create-claim.ts | 2 +- .../src/api/routes/admin/orders/create-fulfillment.ts | 2 +- .../routes/admin/orders/create-reservation-for-line-item.ts | 2 +- .../medusa/src/api/routes/admin/orders/create-shipment.ts | 2 +- .../src/api/routes/admin/orders/create-swap-shipment.ts | 2 +- packages/medusa/src/api/routes/admin/orders/create-swap.ts | 2 +- .../medusa/src/api/routes/admin/orders/fulfill-claim.ts | 2 +- packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts | 2 +- packages/medusa/src/api/routes/admin/orders/get-order.ts | 2 +- .../medusa/src/api/routes/admin/orders/get-reservations.ts | 2 +- packages/medusa/src/api/routes/admin/orders/list-orders.ts | 2 +- .../src/api/routes/admin/orders/process-swap-payment.ts | 2 +- .../medusa/src/api/routes/admin/orders/refund-payment.ts | 2 +- .../medusa/src/api/routes/admin/orders/request-return.ts | 2 +- packages/medusa/src/api/routes/admin/orders/update-claim.ts | 2 +- packages/medusa/src/api/routes/admin/orders/update-order.ts | 2 +- .../admin/payment-collections/delete-payment-collection.ts | 2 +- .../admin/payment-collections/get-payment-collection.ts | 2 +- .../mark-authorized-payment-collection.ts | 2 +- .../admin/payment-collections/update-payment-collection.ts | 2 +- .../medusa/src/api/routes/admin/payments/capture-payment.ts | 2 +- .../medusa/src/api/routes/admin/payments/get-payment.ts | 2 +- .../medusa/src/api/routes/admin/payments/refund-payment.ts | 2 +- .../src/api/routes/admin/price-lists/add-prices-batch.ts | 2 +- .../src/api/routes/admin/price-lists/create-price-list.ts | 2 +- .../src/api/routes/admin/price-lists/delete-price-list.ts | 2 +- .../src/api/routes/admin/price-lists/delete-prices-batch.ts | 2 +- .../api/routes/admin/price-lists/delete-product-prices.ts | 2 +- .../api/routes/admin/price-lists/delete-variant-prices.ts | 2 +- .../src/api/routes/admin/price-lists/get-price-list.ts | 2 +- .../routes/admin/price-lists/list-price-list-products.ts | 2 +- .../src/api/routes/admin/price-lists/list-price-lists.ts | 2 +- .../src/api/routes/admin/price-lists/update-price-list.ts | 2 +- .../routes/admin/product-categories/add-products-batch.ts | 2 +- .../admin/product-categories/create-product-category.ts | 2 +- .../admin/product-categories/delete-product-category.ts | 2 +- .../admin/product-categories/delete-products-batch.ts | 2 +- .../routes/admin/product-categories/get-product-category.ts | 2 +- .../admin/product-categories/list-product-categories.ts | 2 +- .../admin/product-categories/update-product-category.ts | 2 +- .../src/api/routes/admin/product-tags/list-product-tags.ts | 2 +- .../api/routes/admin/product-types/list-product-types.ts | 2 +- packages/medusa/src/api/routes/admin/products/add-option.ts | 2 +- .../medusa/src/api/routes/admin/products/create-product.ts | 4 ++-- .../medusa/src/api/routes/admin/products/create-variant.ts | 4 ++-- .../medusa/src/api/routes/admin/products/delete-option.ts | 2 +- .../medusa/src/api/routes/admin/products/delete-product.ts | 2 +- .../medusa/src/api/routes/admin/products/delete-variant.ts | 2 +- .../medusa/src/api/routes/admin/products/get-product.ts | 2 +- .../medusa/src/api/routes/admin/products/list-products.ts | 2 +- .../src/api/routes/admin/products/list-tag-usage-count.ts | 2 +- packages/medusa/src/api/routes/admin/products/list-types.ts | 2 +- .../medusa/src/api/routes/admin/products/list-variants.ts | 2 +- .../medusa/src/api/routes/admin/products/set-metadata.ts | 2 +- .../medusa/src/api/routes/admin/products/update-option.ts | 2 +- .../medusa/src/api/routes/admin/products/update-product.ts | 6 +++--- .../medusa/src/api/routes/admin/products/update-variant.ts | 2 +- .../routes/admin/publishable-api-keys/add-channels-batch.ts | 2 +- .../publishable-api-keys/create-publishable-api-key.ts | 2 +- .../admin/publishable-api-keys/delete-channels-batch.ts | 2 +- .../publishable-api-keys/delete-publishable-api-key.ts | 2 +- .../admin/publishable-api-keys/get-publishable-api-key.ts | 2 +- .../list-publishable-api-key-sales-channels.ts | 2 +- .../admin/publishable-api-keys/list-publishable-api-keys.ts | 2 +- .../publishable-api-keys/revoke-publishable-api-key.ts | 2 +- .../publishable-api-keys/update-publishable-api-key.ts | 2 +- packages/medusa/src/api/routes/admin/regions/add-country.ts | 2 +- .../api/routes/admin/regions/add-fulfillment-provider.ts | 2 +- .../src/api/routes/admin/regions/add-payment-provider.ts | 2 +- .../medusa/src/api/routes/admin/regions/create-region.ts | 2 +- .../medusa/src/api/routes/admin/regions/delete-region.ts | 2 +- .../src/api/routes/admin/regions/get-fulfillment-options.ts | 2 +- packages/medusa/src/api/routes/admin/regions/get-region.ts | 2 +- .../medusa/src/api/routes/admin/regions/list-regions.ts | 2 +- .../medusa/src/api/routes/admin/regions/remove-country.ts | 2 +- .../api/routes/admin/regions/remove-fulfillment-provider.ts | 2 +- .../src/api/routes/admin/regions/remove-payment-provider.ts | 2 +- .../medusa/src/api/routes/admin/regions/update-region.ts | 2 +- .../src/api/routes/admin/reservations/create-reservation.ts | 2 +- .../src/api/routes/admin/reservations/delete-reservation.ts | 2 +- .../src/api/routes/admin/reservations/get-reservation.ts | 2 +- .../src/api/routes/admin/reservations/list-reservations.ts | 2 +- .../src/api/routes/admin/reservations/update-reservation.ts | 2 +- .../src/api/routes/admin/return-reasons/create-reason.ts | 2 +- .../src/api/routes/admin/return-reasons/delete-reason.ts | 2 +- .../src/api/routes/admin/return-reasons/get-reason.ts | 2 +- .../src/api/routes/admin/return-reasons/list-reasons.ts | 2 +- .../src/api/routes/admin/return-reasons/update-reason.ts | 2 +- .../medusa/src/api/routes/admin/returns/cancel-return.ts | 2 +- .../medusa/src/api/routes/admin/returns/list-returns.ts | 2 +- .../medusa/src/api/routes/admin/returns/receive-return.ts | 2 +- .../api/routes/admin/sales-channels/add-product-batch.ts | 2 +- .../routes/admin/sales-channels/associate-stock-location.ts | 2 +- .../api/routes/admin/sales-channels/create-sales-channel.ts | 2 +- .../routes/admin/sales-channels/delete-products-batch.ts | 2 +- .../api/routes/admin/sales-channels/delete-sales-channel.ts | 2 +- .../api/routes/admin/sales-channels/get-sales-channel.ts | 2 +- .../api/routes/admin/sales-channels/list-sales-channels.ts | 2 +- .../routes/admin/sales-channels/remove-stock-location.ts | 2 +- .../api/routes/admin/sales-channels/update-sales-channel.ts | 2 +- .../routes/admin/shipping-options/create-shipping-option.ts | 2 +- .../routes/admin/shipping-options/delete-shipping-option.ts | 2 +- .../routes/admin/shipping-options/get-shipping-option.ts | 2 +- .../routes/admin/shipping-options/list-shipping-options.ts | 2 +- .../routes/admin/shipping-options/update-shipping-option.ts | 2 +- .../admin/shipping-profiles/create-shipping-profile.ts | 2 +- .../admin/shipping-profiles/delete-shipping-profile.ts | 2 +- .../routes/admin/shipping-profiles/get-shipping-profile.ts | 2 +- .../admin/shipping-profiles/list-shipping-profiles.ts | 2 +- .../admin/shipping-profiles/update-shipping-profile.ts | 2 +- .../routes/admin/stock-locations/create-stock-location.ts | 2 +- .../routes/admin/stock-locations/delete-stock-location.ts | 2 +- .../api/routes/admin/stock-locations/get-stock-location.ts | 2 +- .../routes/admin/stock-locations/list-stock-locations.ts | 2 +- .../routes/admin/stock-locations/update-stock-location.ts | 2 +- packages/medusa/src/api/routes/admin/store/add-currency.ts | 2 +- packages/medusa/src/api/routes/admin/store/get-store.ts | 2 +- .../src/api/routes/admin/store/list-payment-providers.ts | 2 +- .../medusa/src/api/routes/admin/store/list-tax-providers.ts | 2 +- .../medusa/src/api/routes/admin/store/remove-currency.ts | 2 +- packages/medusa/src/api/routes/admin/store/update-store.ts | 2 +- packages/medusa/src/api/routes/admin/swaps/get-swap.ts | 2 +- packages/medusa/src/api/routes/admin/swaps/list-swaps.ts | 2 +- .../src/api/routes/admin/tax-rates/add-to-product-types.ts | 2 +- .../src/api/routes/admin/tax-rates/add-to-products.ts | 2 +- .../api/routes/admin/tax-rates/add-to-shipping-options.ts | 2 +- .../src/api/routes/admin/tax-rates/create-tax-rate.ts | 2 +- .../src/api/routes/admin/tax-rates/delete-tax-rate.ts | 2 +- .../medusa/src/api/routes/admin/tax-rates/get-tax-rate.ts | 2 +- .../medusa/src/api/routes/admin/tax-rates/list-tax-rates.ts | 2 +- .../api/routes/admin/tax-rates/remove-from-product-types.ts | 2 +- .../src/api/routes/admin/tax-rates/remove-from-products.ts | 2 +- .../routes/admin/tax-rates/remove-from-shipping-options.ts | 2 +- .../src/api/routes/admin/tax-rates/update-tax-rate.ts | 2 +- .../src/api/routes/admin/uploads/create-protected-upload.ts | 2 +- .../medusa/src/api/routes/admin/uploads/create-upload.ts | 2 +- .../medusa/src/api/routes/admin/uploads/delete-upload.ts | 2 +- .../medusa/src/api/routes/admin/uploads/get-download-url.ts | 2 +- packages/medusa/src/api/routes/admin/users/create-user.ts | 2 +- packages/medusa/src/api/routes/admin/users/delete-user.ts | 2 +- packages/medusa/src/api/routes/admin/users/get-user.ts | 2 +- packages/medusa/src/api/routes/admin/users/list-users.ts | 2 +- .../src/api/routes/admin/users/reset-password-token.ts | 2 +- .../medusa/src/api/routes/admin/users/reset-password.ts | 2 +- packages/medusa/src/api/routes/admin/users/update-user.ts | 2 +- .../medusa/src/api/routes/admin/variants/get-inventory.ts | 2 +- .../medusa/src/api/routes/admin/variants/list-variants.ts | 2 +- packages/medusa/src/api/routes/store/auth/create-session.ts | 2 +- packages/medusa/src/api/routes/store/auth/delete-session.ts | 2 +- packages/medusa/src/api/routes/store/auth/exists.ts | 2 +- packages/medusa/src/api/routes/store/auth/get-session.ts | 2 +- .../src/api/routes/store/carts/add-shipping-method.ts | 2 +- .../medusa/src/api/routes/store/carts/calculate-taxes.ts | 2 +- packages/medusa/src/api/routes/store/carts/complete-cart.ts | 2 +- packages/medusa/src/api/routes/store/carts/create-cart.ts | 2 +- .../src/api/routes/store/carts/create-line-item/index.ts | 2 +- .../src/api/routes/store/carts/create-payment-sessions.ts | 2 +- .../medusa/src/api/routes/store/carts/delete-discount.ts | 2 +- .../medusa/src/api/routes/store/carts/delete-line-item.ts | 2 +- .../src/api/routes/store/carts/delete-payment-session.ts | 2 +- packages/medusa/src/api/routes/store/carts/get-cart.ts | 2 +- .../src/api/routes/store/carts/refresh-payment-session.ts | 2 +- .../src/api/routes/store/carts/set-payment-session.ts | 2 +- packages/medusa/src/api/routes/store/carts/update-cart.ts | 2 +- .../medusa/src/api/routes/store/carts/update-line-item.ts | 2 +- .../src/api/routes/store/carts/update-payment-session.ts | 2 +- .../src/api/routes/store/collections/get-collection.ts | 2 +- .../src/api/routes/store/collections/list-collections.ts | 2 +- .../medusa/src/api/routes/store/customers/create-address.ts | 2 +- .../src/api/routes/store/customers/create-customer.ts | 2 +- .../medusa/src/api/routes/store/customers/delete-address.ts | 2 +- .../medusa/src/api/routes/store/customers/get-customer.ts | 2 +- .../src/api/routes/store/customers/get-payment-methods.ts | 2 +- .../medusa/src/api/routes/store/customers/list-orders.ts | 2 +- .../src/api/routes/store/customers/reset-password-token.ts | 2 +- .../medusa/src/api/routes/store/customers/reset-password.ts | 2 +- .../medusa/src/api/routes/store/customers/update-address.ts | 2 +- .../src/api/routes/store/customers/update-customer.ts | 2 +- .../medusa/src/api/routes/store/gift-cards/get-gift-card.ts | 2 +- .../src/api/routes/store/order-edits/complete-order-edit.ts | 2 +- .../src/api/routes/store/order-edits/decline-order-edit.ts | 2 +- .../src/api/routes/store/order-edits/get-order-edit.ts | 2 +- .../src/api/routes/store/orders/confirm-order-request.ts | 2 +- .../medusa/src/api/routes/store/orders/get-order-by-cart.ts | 2 +- packages/medusa/src/api/routes/store/orders/get-order.ts | 2 +- packages/medusa/src/api/routes/store/orders/lookup-order.ts | 2 +- .../medusa/src/api/routes/store/orders/request-order.ts | 2 +- .../payment-collections/authorize-batch-payment-sessions.ts | 2 +- .../store/payment-collections/authorize-payment-session.ts | 2 +- .../store/payment-collections/get-payment-collection.ts | 2 +- .../payment-collections/manage-batch-payment-sessions.ts | 2 +- .../store/payment-collections/manage-payment-session.ts | 2 +- .../store/payment-collections/refresh-payment-session.ts | 2 +- .../routes/store/product-categories/get-product-category.ts | 2 +- .../store/product-categories/list-product-categories.ts | 2 +- .../src/api/routes/store/product-tags/list-product-tags.ts | 2 +- .../api/routes/store/product-types/list-product-types.ts | 2 +- .../medusa/src/api/routes/store/products/get-product.ts | 2 +- .../medusa/src/api/routes/store/products/list-products.ts | 2 +- packages/medusa/src/api/routes/store/products/search.ts | 2 +- packages/medusa/src/api/routes/store/regions/get-region.ts | 2 +- .../medusa/src/api/routes/store/regions/list-regions.ts | 2 +- .../src/api/routes/store/return-reasons/get-reason.ts | 2 +- .../src/api/routes/store/return-reasons/list-reasons.ts | 2 +- .../medusa/src/api/routes/store/returns/create-return.ts | 2 +- .../src/api/routes/store/shipping-options/list-options.ts | 2 +- .../routes/store/shipping-options/list-shipping-options.ts | 2 +- packages/medusa/src/api/routes/store/swaps/create-swap.ts | 2 +- .../medusa/src/api/routes/store/swaps/get-swap-by-cart.ts | 2 +- .../medusa/src/api/routes/store/variants/get-variant.ts | 2 +- .../medusa/src/api/routes/store/variants/list-variants.ts | 2 +- 318 files changed, 329 insertions(+), 324 deletions(-) create mode 100644 .changeset/nice-dryers-search.md diff --git a/.changeset/nice-dryers-search.md b/.changeset/nice-dryers-search.md new file mode 100644 index 0000000000..00fa37c895 --- /dev/null +++ b/.changeset/nice-dryers-search.md @@ -0,0 +1,5 @@ +--- +"@medusajs/medusa": patch +--- + +feat(oas): include `/admin` and `/store` in paths URLs diff --git a/packages/medusa/oas/admin-spec3-base.yaml b/packages/medusa/oas/admin-spec3-base.yaml index 73f000882b..9bdd452e6e 100644 --- a/packages/medusa/oas/admin-spec3-base.yaml +++ b/packages/medusa/oas/admin-spec3-base.yaml @@ -292,7 +292,7 @@ tags: - name: User description: User endpoints that allow handling users in Medusa. servers: - - url: https://api.medusa-commerce.com/admin + - url: https://api.medusa-commerce.com paths: { } components: responses: diff --git a/packages/medusa/oas/store-spec3-base.yaml b/packages/medusa/oas/store-spec3-base.yaml index 82bcce2f25..56f1f71703 100644 --- a/packages/medusa/oas/store-spec3-base.yaml +++ b/packages/medusa/oas/store-spec3-base.yaml @@ -237,7 +237,7 @@ tags: - name: Swap description: Swap endpoints that allow handling swaps in Medusa. servers: - - url: https://api.medusa-commerce.com/store + - url: https://api.medusa-commerce.com paths: { } components: responses: diff --git a/packages/medusa/src/api/routes/admin/apps/authorize-app.ts b/packages/medusa/src/api/routes/admin/apps/authorize-app.ts index dd7ad3a669..8bfbc732d8 100644 --- a/packages/medusa/src/api/routes/admin/apps/authorize-app.ts +++ b/packages/medusa/src/api/routes/admin/apps/authorize-app.ts @@ -4,7 +4,7 @@ import { OauthService } from "../../../../services" import { validator } from "../../../../utils/validator" /** - * @oas [post] /apps/authorizations + * @oas [post] /admin/apps/authorizations * operationId: "PostApps" * summary: "Generate Token for App" * description: "Generates a token for an application." diff --git a/packages/medusa/src/api/routes/admin/apps/list.ts b/packages/medusa/src/api/routes/admin/apps/list.ts index 46c6776c27..68b2ef995d 100644 --- a/packages/medusa/src/api/routes/admin/apps/list.ts +++ b/packages/medusa/src/api/routes/admin/apps/list.ts @@ -1,7 +1,7 @@ import { OauthService } from "../../../../services" /** - * @oas [get] /apps + * @oas [get] /admin/apps * operationId: "GetApps" * summary: "List Applications" * description: "Retrieve a list of applications." 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 a49ee369e4..188c1f8a44 100644 --- a/packages/medusa/src/api/routes/admin/auth/create-session.ts +++ b/packages/medusa/src/api/routes/admin/auth/create-session.ts @@ -8,7 +8,7 @@ import AuthService from "../../../../services/auth" import { validator } from "../../../../utils/validator" /** - * @oas [post] /auth + * @oas [post] /admin/auth * operationId: "PostAuth" * summary: "User Login" * x-authenticated: false diff --git a/packages/medusa/src/api/routes/admin/auth/delete-session.ts b/packages/medusa/src/api/routes/admin/auth/delete-session.ts index 53aa6c9d0d..fae3c8c9d8 100644 --- a/packages/medusa/src/api/routes/admin/auth/delete-session.ts +++ b/packages/medusa/src/api/routes/admin/auth/delete-session.ts @@ -1,5 +1,5 @@ /** - * @oas [delete] /auth + * @oas [delete] /admin/auth * operationId: "DeleteAuth" * summary: "User Logout" * x-authenticated: true 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 098ab665c3..e66d89dcb5 100644 --- a/packages/medusa/src/api/routes/admin/auth/get-session.ts +++ b/packages/medusa/src/api/routes/admin/auth/get-session.ts @@ -2,7 +2,7 @@ import UserService from "../../../../services/user" import _ from "lodash" /** - * @oas [get] /auth + * @oas [get] /admin/auth * operationId: "GetAuth" * summary: "Get Current User" * x-authenticated: true 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 8473c06f0c..55d6452f0f 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 @@ -2,7 +2,7 @@ import { BatchJobService } from "../../../../services" import { EntityManager } from "typeorm" /** - * @oas [post] /batch-jobs/{id}/cancel + * @oas [post] /admin/batch-jobs/{id}/cancel * operationId: "PostBatchJobsBatchJobCancel" * summary: "Cancel a Batch Job" * description: "Marks a batch job as canceled" 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 6bc4bb2bf7..1b0261f143 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 @@ -2,7 +2,7 @@ import { BatchJobService } from "../../../../services" import { EntityManager } from "typeorm" /** - * @oas [post] /batch-jobs/{id}/confirm + * @oas [post] /admin/batch-jobs/{id}/confirm * operationId: "PostBatchJobsBatchJobConfirmProcessing" * summary: "Confirm a Batch Job" * description: "Confirms that a previously requested batch job should be executed." 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 ee0704a5a6..e778402892 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 @@ -6,7 +6,7 @@ import { EntityManager } from "typeorm" import { validator } from "../../../../utils/validator" /** - * @oas [post] /batch-jobs + * @oas [post] /admin/batch-jobs * operationId: "PostBatchJobs" * summary: "Create a Batch Job" * description: "Creates a Batch Job." 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 356540108f..a888a898a8 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 @@ -1,5 +1,5 @@ /** - * @oas [get] /batch-jobs/{id} + * @oas [get] /admin/batch-jobs/{id} * operationId: "GetBatchJobsBatchJob" * summary: "Get a Batch Job" * description: "Retrieves a Batch Job." 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 26b4dc4498..2702c4133e 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 @@ -9,7 +9,7 @@ import { pickBy } from "lodash" import { isDefined } from "medusa-core-utils" /** - * @oas [get] /batch-jobs + * @oas [get] /admin/batch-jobs * operationId: "GetBatchJobs" * summary: "List Batch Jobs" * description: "Retrieve a list of Batch Jobs." 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 2028d797e7..8b298e4181 100644 --- a/packages/medusa/src/api/routes/admin/collections/add-products.ts +++ b/packages/medusa/src/api/routes/admin/collections/add-products.ts @@ -5,7 +5,7 @@ import { EntityManager } from "typeorm" import ProductCollectionService from "../../../../services/product-collection" /** - * @oas [post] /collections/{id}/products/batch + * @oas [post] /admin/collections/{id}/products/batch * operationId: "PostProductsToCollection" * summary: "Update Products" * description: "Updates products associated with a Product Collection" 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 0b046b274b..2bd0338eca 100644 --- a/packages/medusa/src/api/routes/admin/collections/create-collection.ts +++ b/packages/medusa/src/api/routes/admin/collections/create-collection.ts @@ -4,7 +4,7 @@ import { Request, Response } from "express" import { EntityManager } from "typeorm" /** - * @oas [post] /collections + * @oas [post] /admin/collections * operationId: "PostCollections" * summary: "Create a Collection" * description: "Creates a Product Collection." diff --git a/packages/medusa/src/api/routes/admin/collections/delete-collection.ts b/packages/medusa/src/api/routes/admin/collections/delete-collection.ts index c6dbc3a1af..eaad697be3 100644 --- a/packages/medusa/src/api/routes/admin/collections/delete-collection.ts +++ b/packages/medusa/src/api/routes/admin/collections/delete-collection.ts @@ -4,7 +4,7 @@ import { EntityManager } from "typeorm" import ProductCollectionService from "../../../../services/product-collection" /** - * @oas [delete] /collections/{id} + * @oas [delete] /admin/collections/{id} * operationId: "DeleteCollectionsCollection" * summary: "Delete a Collection" * description: "Deletes a Product Collection." 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 97c4a5ce83..052bfa1aa3 100644 --- a/packages/medusa/src/api/routes/admin/collections/get-collection.ts +++ b/packages/medusa/src/api/routes/admin/collections/get-collection.ts @@ -4,7 +4,7 @@ import ProductCollectionService from "../../../../services/product-collection" import { defaultAdminCollectionsRelations } from "." /** - * @oas [get] /collections/{id} + * @oas [get] /admin/collections/{id} * operationId: "GetCollectionsCollection" * summary: "Get a Collection" * description: "Retrieves a Product Collection." 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 154cea4e52..81eb157c0a 100644 --- a/packages/medusa/src/api/routes/admin/collections/list-collections.ts +++ b/packages/medusa/src/api/routes/admin/collections/list-collections.ts @@ -6,7 +6,7 @@ import ProductCollectionService from "../../../../services/product-collection" import { Type } from "class-transformer" /** - * @oas [get] /collections + * @oas [get] /admin/collections * operationId: "GetCollections" * summary: "List Collections" * description: "Retrieve a list of Product Collection." diff --git a/packages/medusa/src/api/routes/admin/collections/remove-products.ts b/packages/medusa/src/api/routes/admin/collections/remove-products.ts index e42915a738..7e228debfe 100644 --- a/packages/medusa/src/api/routes/admin/collections/remove-products.ts +++ b/packages/medusa/src/api/routes/admin/collections/remove-products.ts @@ -5,7 +5,7 @@ import { EntityManager } from "typeorm" import ProductCollectionService from "../../../../services/product-collection" /** - * @oas [delete] /collections/{id}/products/batch + * @oas [delete] /admin/collections/{id}/products/batch * operationId: "DeleteProductsFromCollection" * summary: "Remove Product" * description: "Removes products associated with a Product Collection" 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 7fcff59c6a..8765a6a162 100644 --- a/packages/medusa/src/api/routes/admin/collections/update-collection.ts +++ b/packages/medusa/src/api/routes/admin/collections/update-collection.ts @@ -4,7 +4,7 @@ import { EntityManager } from "typeorm" import ProductCollectionService from "../../../../services/product-collection" /** - * @oas [post] /collections/{id} + * @oas [post] /admin/collections/{id} * operationId: "PostCollectionsCollection" * summary: "Update a Collection" * description: "Updates a Product Collection." 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 8e768fa4bd..ff749fa442 100644 --- a/packages/medusa/src/api/routes/admin/currencies/list-currencies.ts +++ b/packages/medusa/src/api/routes/admin/currencies/list-currencies.ts @@ -7,7 +7,7 @@ import { ExtendedRequest } from "../../../../types/global" import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators" /** - * @oas [get] /currencies + * @oas [get] /admin/currencies * operationId: "GetCurrencies" * summary: "List Currency" * description: "Retrieves a list of Currency" 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 84fa5035dd..b1ccee0e57 100644 --- a/packages/medusa/src/api/routes/admin/currencies/update-currency.ts +++ b/packages/medusa/src/api/routes/admin/currencies/update-currency.ts @@ -7,7 +7,7 @@ import TaxInclusivePricingFeatureFlag from "../../../../loaders/feature-flags/ta import { EntityManager } from "typeorm" /** - * @oas [post] /currencies/{code} + * @oas [post] /admin/currencies/{code} * operationId: "PostCurrenciesCurrency" * summary: "Update a Currency" * description: "Update a Currency" 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 f157e4d6e2..96d48cd227 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 @@ -8,7 +8,7 @@ import { ValidateNested } from "class-validator" import { validator } from "../../../../utils/validator" /** - * @oas [post] /customer-groups/{id}/customers/batch + * @oas [post] /admin/customer-groups/{id}/customers/batch * operationId: "PostCustomerGroupsGroupCustomersBatch" * summary: "Add Customers" * description: "Adds a list of customers, represented by id's, to a customer group." 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 8382f3a8e0..0e1813ba2e 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 @@ -6,7 +6,7 @@ import { EntityManager } from "typeorm" import { validator } from "../../../../utils/validator" /** - * @oas [post] /customer-groups + * @oas [post] /admin/customer-groups * operationId: "PostCustomerGroups" * summary: "Create a Customer Group" * description: "Creates a CustomerGroup." diff --git a/packages/medusa/src/api/routes/admin/customer-groups/delete-customer-group.ts b/packages/medusa/src/api/routes/admin/customer-groups/delete-customer-group.ts index 47cdb6e963..c0ba7f88fd 100644 --- a/packages/medusa/src/api/routes/admin/customer-groups/delete-customer-group.ts +++ b/packages/medusa/src/api/routes/admin/customer-groups/delete-customer-group.ts @@ -4,7 +4,7 @@ import { CustomerGroupService } from "../../../../services" import { EntityManager } from "typeorm" /** - * @oas [delete] /customer-groups/{id} + * @oas [delete] /admin/customer-groups/{id} * operationId: "DeleteCustomerGroupsCustomerGroup" * summary: "Delete a Customer Group" * description: "Deletes a CustomerGroup." 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 ab9ad598ea..3bd4b5e032 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 @@ -8,7 +8,7 @@ import { ValidateNested } from "class-validator" import { validator } from "../../../../utils/validator" /** - * @oas [delete] /customer-groups/{id}/customers/batch + * @oas [delete] /admin/customer-groups/{id}/customers/batch * operationId: "DeleteCustomerGroupsGroupCustomerBatch" * summary: "Remove Customers" * description: "Removes a list of customers, represented by id's, from a customer group." 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 2f5a7e2334..6b6caf3124 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 @@ -5,7 +5,7 @@ import { IsNumber, IsOptional, IsString } from "class-validator" import { Type } from "class-transformer" /** - * @oas [get] /customer-groups/{id}/customers + * @oas [get] /admin/customer-groups/{id}/customers * operationId: "GetCustomerGroupsGroupCustomers" * summary: "List Customers" * description: "Retrieves a list of customers in a customer group" 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 78da680d7a..e808c0c00b 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 @@ -4,7 +4,7 @@ import { CustomerGroupService } from "../../../../services" import { FindParams } from "../../../../types/common" /** - * @oas [get] /customer-groups/{id} + * @oas [get] /admin/customer-groups/{id} * operationId: "GetCustomerGroupsGroup" * summary: "Get a Customer Group" * description: "Retrieves a Customer Group." 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 00158f07ef..0354c0f4bb 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 @@ -6,7 +6,7 @@ import { FilterableCustomerGroupProps } from "../../../../types/customer-groups" import { Type } from "class-transformer" /** - * @oas [get] /customer-groups + * @oas [get] /admin/customer-groups * operationId: "GetCustomerGroups" * summary: "List Customer Groups" * description: "Retrieve a list of customer groups." 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 4f2f86bde7..93800b40d1 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 @@ -8,7 +8,7 @@ import { defaultAdminCustomerGroupsRelations } from "." import { validator } from "../../../../utils/validator" /** - * @oas [post] /customer-groups/{id} + * @oas [post] /admin/customer-groups/{id} * operationId: "PostCustomerGroupsGroup" * summary: "Update a Customer Group" * description: "Update a CustomerGroup." 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 17ac6c50af..fcdd9ad272 100644 --- a/packages/medusa/src/api/routes/admin/customers/create-customer.ts +++ b/packages/medusa/src/api/routes/admin/customers/create-customer.ts @@ -5,7 +5,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /customers + * @oas [post] /admin/customers * operationId: "PostCustomers" * summary: "Create a Customer" * description: "Creates a Customer." 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 0063cecb9e..7c325d6e06 100644 --- a/packages/medusa/src/api/routes/admin/customers/get-customer.ts +++ b/packages/medusa/src/api/routes/admin/customers/get-customer.ts @@ -4,7 +4,7 @@ import { defaultAdminCustomersRelations } from "." import { validator } from "../../../../utils/validator" /** - * @oas [get] /customers/{id} + * @oas [get] /admin/customers/{id} * operationId: "GetCustomersCustomer" * summary: "Get a Customer" * description: "Retrieves a Customer." 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 c3947cda0a..1b636afc23 100644 --- a/packages/medusa/src/api/routes/admin/customers/list-customers.ts +++ b/packages/medusa/src/api/routes/admin/customers/list-customers.ts @@ -5,7 +5,7 @@ import { Type } from "class-transformer" import customerController from "../../../../controllers/customers" /** - * @oas [get] /customers + * @oas [get] /admin/customers * operationId: "GetCustomers" * summary: "List Customers" * description: "Retrieves a list of Customers." 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 f3217ee648..26ef7e5256 100644 --- a/packages/medusa/src/api/routes/admin/customers/update-customer.ts +++ b/packages/medusa/src/api/routes/admin/customers/update-customer.ts @@ -16,7 +16,7 @@ import { defaultAdminCustomersRelations } from "." import { validator } from "../../../../utils/validator" /** - * @oas [post] /customers/{id} + * @oas [post] /admin/customers/{id} * operationId: "PostCustomersCustomer" * summary: "Update a Customer" * description: "Updates a Customer." 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 3f0b89d7a3..81f886c6dc 100644 --- a/packages/medusa/src/api/routes/admin/discounts/add-region.ts +++ b/packages/medusa/src/api/routes/admin/discounts/add-region.ts @@ -5,7 +5,7 @@ import DiscountService from "../../../../services/discount" import { EntityManager } from "typeorm" /** - * @oas [post] /discounts/{id}/regions/{region_id} + * @oas [post] /admin/discounts/{id}/regions/{region_id} * operationId: "PostDiscountsDiscountRegionsRegion" * summary: "Add Region" * description: "Adds a Region to the list of Regions that a Discount can be used in." 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 a92f63e4d1..c75c80ccad 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 @@ -10,7 +10,7 @@ import { IsArray } from "class-validator" import { FindParams } from "../../../../types/common" /** - * @oas [post] /discounts/{discount_id}/conditions/{condition_id}/batch + * @oas [post] /admin/discounts/{discount_id}/conditions/{condition_id}/batch * operationId: "PostDiscountsDiscountConditionsConditionBatch" * summary: "Add Batch Resources" * description: "Add a batch of resources to a discount condition." 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 3c4ab2a91f..aa857387ff 100644 --- a/packages/medusa/src/api/routes/admin/discounts/create-condition.ts +++ b/packages/medusa/src/api/routes/admin/discounts/create-condition.ts @@ -9,7 +9,7 @@ import { EntityManager } from "typeorm" import { FindParams } from "../../../../types/common" /** - * @oas [post] /discounts/{discount_id}/conditions + * @oas [post] /admin/discounts/{discount_id}/conditions * operationId: "PostDiscountsDiscountConditions" * summary: "Create a Condition" * description: "Creates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided." 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 adcb84abf9..158e5d4499 100644 --- a/packages/medusa/src/api/routes/admin/discounts/create-discount.ts +++ b/packages/medusa/src/api/routes/admin/discounts/create-discount.ts @@ -26,7 +26,7 @@ import { Request, Response } from "express" import { FindParams } from "../../../../types/common" /** - * @oas [post] /discounts + * @oas [post] /admin/discounts * operationId: "PostDiscounts" * summary: "Creates a Discount" * x-authenticated: true 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 bad529debd..5f1271423d 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 @@ -12,7 +12,7 @@ import DiscountService from "../../../../services/discount" import { EntityManager } from "typeorm" /** - * @oas [post] /discounts/{id}/dynamic-codes + * @oas [post] /admin/discounts/{id}/dynamic-codes * operationId: "PostDiscountsDiscountDynamicCodes" * summary: "Create a Dynamic Code" * description: "Creates a dynamic unique code that can map to a parent Discount. This is useful if you want to automatically generate codes with the same behaviour." 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 ed0c27a1ac..e0be3f5581 100644 --- a/packages/medusa/src/api/routes/admin/discounts/delete-condition.ts +++ b/packages/medusa/src/api/routes/admin/discounts/delete-condition.ts @@ -5,7 +5,7 @@ import { MedusaError } from "medusa-core-utils" import { FindParams } from "../../../../types/common" /** - * @oas [delete] /discounts/{discount_id}/conditions/{condition_id} + * @oas [delete] /admin/discounts/{discount_id}/conditions/{condition_id} * operationId: "DeleteDiscountsDiscountConditionsCondition" * summary: "Delete a Condition" * description: "Deletes a DiscountCondition" diff --git a/packages/medusa/src/api/routes/admin/discounts/delete-discount.ts b/packages/medusa/src/api/routes/admin/discounts/delete-discount.ts index 34070cc755..e76db017bb 100644 --- a/packages/medusa/src/api/routes/admin/discounts/delete-discount.ts +++ b/packages/medusa/src/api/routes/admin/discounts/delete-discount.ts @@ -2,7 +2,7 @@ import DiscountService from "../../../../services/discount" import { EntityManager } from "typeorm" /** - * @oas [delete] /discounts/{id} + * @oas [delete] /admin/discounts/{id} * operationId: "DeleteDiscountsDiscount" * summary: "Delete a Discount" * description: "Deletes a Discount." 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 b8296f4261..b78a4424fd 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 @@ -4,7 +4,7 @@ import DiscountService from "../../../../services/discount" import { EntityManager } from "typeorm" /** - * @oas [delete] /discounts/{id}/dynamic-codes/{code} + * @oas [delete] /admin/discounts/{id}/dynamic-codes/{code} * operationId: "DeleteDiscountsDiscountDynamicCodesCode" * summary: "Delete a Dynamic Code" * description: "Deletes a dynamic code from a Discount." 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 5c3b799926..7083c21097 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 @@ -9,7 +9,7 @@ import { IsArray } from "class-validator" import { FindParams } from "../../../../types/common" /** - * @oas [delete] /discounts/{discount_id}/conditions/{condition_id}/batch + * @oas [delete] /admin/discounts/{discount_id}/conditions/{condition_id}/batch * operationId: "DeleteDiscountsDiscountConditionsConditionBatch" * summary: "Delete Batch Resources" * description: "Delete a batch of resources from a discount condition." 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 3952718cc2..e9aa3131f4 100644 --- a/packages/medusa/src/api/routes/admin/discounts/get-condition.ts +++ b/packages/medusa/src/api/routes/admin/discounts/get-condition.ts @@ -3,7 +3,7 @@ import DiscountConditionService from "../../../../services/discount-condition" import { FindParams } from "../../../../types/common" /** - * @oas [get] /discounts/{discount_id}/conditions/{condition_id} + * @oas [get] /admin/discounts/{discount_id}/conditions/{condition_id} * operationId: "GetDiscountsDiscountConditionsCondition" * summary: "Get a Condition" * description: "Gets a DiscountCondition" 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 bbfa30ade9..08e03f89e7 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 @@ -3,7 +3,7 @@ import DiscountService from "../../../../services/discount" import { FindParams } from "../../../../types/common" /** - * @oas [get] /discounts/code/{code} + * @oas [get] /admin/discounts/code/{code} * operationId: "GetDiscountsDiscountCode" * summary: "Get Discount by Code" * description: "Retrieves a Discount by its discount code" 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 192f2716aa..c48ec98a35 100644 --- a/packages/medusa/src/api/routes/admin/discounts/get-discount.ts +++ b/packages/medusa/src/api/routes/admin/discounts/get-discount.ts @@ -3,7 +3,7 @@ import { Request, Response } from "express" import { FindParams } from "../../../../types/common" /** - * @oas [get] /discounts/{id} + * @oas [get] /admin/discounts/{id} * operationId: "GetDiscountsDiscount" * summary: "Get a Discount" * description: "Retrieves a Discount" 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 7f793979c3..cb4498c23c 100644 --- a/packages/medusa/src/api/routes/admin/discounts/list-discounts.ts +++ b/packages/medusa/src/api/routes/admin/discounts/list-discounts.ts @@ -13,7 +13,7 @@ import { DiscountService } from "../../../../services" import { optionalBooleanMapper } from "../../../../utils/validators/is-boolean" /** - * @oas [get] /discounts + * @oas [get] /admin/discounts * operationId: "GetDiscounts" * summary: "List Discounts" * x-authenticated: true 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 ca9556653d..bb6cf6155e 100644 --- a/packages/medusa/src/api/routes/admin/discounts/remove-region.ts +++ b/packages/medusa/src/api/routes/admin/discounts/remove-region.ts @@ -4,7 +4,7 @@ import DiscountService from "../../../../services/discount" import { EntityManager } from "typeorm" /** - * @oas [delete] /discounts/{id}/regions/{region_id} + * @oas [delete] /admin/discounts/{id}/regions/{region_id} * operationId: "DeleteDiscountsDiscountRegionsRegion" * summary: "Remove Region" * x-authenticated: true 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 2cc541f473..93386df151 100644 --- a/packages/medusa/src/api/routes/admin/discounts/update-condition.ts +++ b/packages/medusa/src/api/routes/admin/discounts/update-condition.ts @@ -6,7 +6,7 @@ import { EntityManager } from "typeorm" import { FindParams } from "../../../../types/common" /** - * @oas [post] /discounts/{discount_id}/conditions/{condition_id} + * @oas [post] /admin/discounts/{discount_id}/conditions/{condition_id} * operationId: "PostDiscountsDiscountConditionsCondition" * summary: "Update a Condition" * description: "Updates a DiscountCondition. Only one of `products`, `product_types`, `product_collections`, `product_tags`, and `customer_groups` should be provided." 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 8b761e1bd4..9a92303170 100644 --- a/packages/medusa/src/api/routes/admin/discounts/update-discount.ts +++ b/packages/medusa/src/api/routes/admin/discounts/update-discount.ts @@ -23,7 +23,7 @@ import { Type } from "class-transformer" import { FindParams } from "../../../../types/common" /** - * @oas [post] /discounts/{id} + * @oas [post] /admin/discounts/{id} * operationId: "PostDiscountsDiscount" * summary: "Update a Discount" * description: "Updates a Discount with a given set of rules that define how the Discount behaves." 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 8e65df24e3..d98d5414e7 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 @@ -27,7 +27,7 @@ import { validator } from "../../../../utils/validator" import { IsType } from "../../../../utils/validators/is-type" /** - * @oas [post] /draft-orders + * @oas [post] /admin/draft-orders * operationId: "PostDraftOrders" * summary: "Create a Draft Order" * description: "Creates a Draft Order" 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 18497b0911..94ef00ca0b 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 @@ -15,7 +15,7 @@ import { MedusaError } from "medusa-core-utils" import { validator } from "../../../../utils/validator" /** - * @oas [post] /draft-orders/{id}/line-items + * @oas [post] /admin/draft-orders/{id}/line-items * operationId: "PostDraftOrdersDraftOrderLineItems" * summary: "Create a Line Item" * description: "Creates a Line Item for the Draft Order" diff --git a/packages/medusa/src/api/routes/admin/draft-orders/delete-draft-order.ts b/packages/medusa/src/api/routes/admin/draft-orders/delete-draft-order.ts index 060277005a..d8ef04d684 100644 --- a/packages/medusa/src/api/routes/admin/draft-orders/delete-draft-order.ts +++ b/packages/medusa/src/api/routes/admin/draft-orders/delete-draft-order.ts @@ -2,7 +2,7 @@ import { DraftOrderService } from "../../../../services" import { EntityManager } from "typeorm" /** - * @oas [delete] /draft-orders/{id} + * @oas [delete] /admin/draft-orders/{id} * operationId: DeleteDraftOrdersDraftOrder * summary: Delete a Draft Order * description: "Deletes a Draft Order" 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 4395817cbc..0180c5cc0e 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 @@ -10,7 +10,7 @@ import { EntityManager } from "typeorm" import { MedusaError } from "medusa-core-utils" /** - * @oas [delete] /draft-orders/{id}/line-items/{line_id} + * @oas [delete] /admin/draft-orders/{id}/line-items/{line_id} * operationId: DeleteDraftOrdersDraftOrderLineItemsItem * summary: Delete a Line Item * description: "Removes a Line Item from a Draft Order." 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 c3c87382ba..0f7e88f593 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 @@ -9,7 +9,7 @@ import { import { DraftOrder } from "../../../.." /** - * @oas [get] /draft-orders/{id} + * @oas [get] /admin/draft-orders/{id} * operationId: "GetDraftOrdersDraftOrder" * summary: "Get a Draft Order" * description: "Retrieves a Draft Order." 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 85a6b96f8f..97bc299522 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 @@ -12,7 +12,7 @@ import { Type } from "class-transformer" import { validator } from "../../../../utils/validator" /** - * @oas [get] /draft-orders + * @oas [get] /admin/draft-orders * operationId: "GetDraftOrders" * summary: "List Draft Orders" * description: "Retrieves an list of Draft Orders" 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 c3632fdb59..3ec50c5a54 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 @@ -15,7 +15,7 @@ import { Order } from "../../../../models" import { MedusaError } from "medusa-core-utils" /** - * @oas [post] /draft-orders/{id}/pay + * @oas [post] /admin/draft-orders/{id}/pay * summary: "Registers a Payment" * operationId: "PostDraftOrdersDraftOrderRegisterPayment" * description: "Registers a payment for a Draft Order." 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 e62896afa2..78abe0ab09 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 @@ -21,7 +21,7 @@ import { validator } from "../../../../utils/validator" import { IsType } from "../../../../utils/validators/is-type" /** - * @oas [post] /draft-orders/{id} + * @oas [post] /admin/draft-orders/{id} * operationId: PostDraftOrdersDraftOrder * summary: Update a Draft Order * description: "Updates a Draft Order." 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 c38ba03aec..1b55bd74f5 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 @@ -13,7 +13,7 @@ import { MedusaError } from "medusa-core-utils" import { validator } from "../../../../utils/validator" /** - * @oas [post] /draft-orders/{id}/line-items/{line_id} + * @oas [post] /admin/draft-orders/{id}/line-items/{line_id} * operationId: "PostDraftOrdersDraftOrderLineItemsItem" * summary: "Update a Line Item" * description: "Updates a Line Item for a Draft Order" 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 c2144adef8..3957f07ff0 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 @@ -6,7 +6,7 @@ import { Type } from "class-transformer" import { EntityManager } from "typeorm" /** - * @oas [post] /gift-cards + * @oas [post] /admin/gift-cards * operationId: "PostGiftCards" * summary: "Create a Gift Card" * description: "Creates a Gift Card that can redeemed by its unique code. The Gift Card is only valid within 1 region." diff --git a/packages/medusa/src/api/routes/admin/gift-cards/delete-gift-card.ts b/packages/medusa/src/api/routes/admin/gift-cards/delete-gift-card.ts index cf1e45a4a5..46ee43dddb 100644 --- a/packages/medusa/src/api/routes/admin/gift-cards/delete-gift-card.ts +++ b/packages/medusa/src/api/routes/admin/gift-cards/delete-gift-card.ts @@ -1,7 +1,7 @@ import { EntityManager } from "typeorm" /** - * @oas [delete] /gift-cards/{id} + * @oas [delete] /admin/gift-cards/{id} * operationId: "DeleteGiftCardsGiftCard" * summary: "Delete a Gift Card" * description: "Deletes a Gift Card" 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 65e8da07f4..d14833505b 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 @@ -1,7 +1,7 @@ import { defaultAdminGiftCardFields, defaultAdminGiftCardRelations } from "./" /** - * @oas [get] /gift-cards/{id} + * @oas [get] /admin/gift-cards/{id} * operationId: "GetGiftCardsGiftCard" * summary: "Get a Gift Card" * description: "Retrieves a Gift Card." 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 9236c5c66b..30be72259a 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 @@ -7,7 +7,7 @@ import { validator } from "../../../../utils/validator" import { isDefined } from "medusa-core-utils" /** - * @oas [get] /gift-cards + * @oas [get] /admin/gift-cards * operationId: "GetGiftCards" * summary: "List Gift Cards" * description: "Retrieves a list of Gift Cards." 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 77e65fc99d..db675baecb 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 @@ -7,7 +7,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /gift-cards/{id} + * @oas [post] /admin/gift-cards/{id} * operationId: "PostGiftCardsGiftCard" * summary: "Update a Gift Card" * description: "Update a Gift Card that can redeemed by its unique code. The Gift Card is only valid within 1 region." diff --git a/packages/medusa/src/api/routes/admin/inventory-items/create-location-level.ts b/packages/medusa/src/api/routes/admin/inventory-items/create-location-level.ts index 4401fc1ed9..734ea0cf27 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/create-location-level.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/create-location-level.ts @@ -8,7 +8,7 @@ import { import { FindParams } from "../../../../types/common" /** - * @oas [post] /inventory-items/{id}/location-levels + * @oas [post] /admin/inventory-items/{id}/location-levels * operationId: "PostInventoryItemsInventoryItemLocationLevels" * summary: "Create an Inventory Location Level for a given Inventory Item." * description: "Creates an Inventory Location Level for a given Inventory Item." diff --git a/packages/medusa/src/api/routes/admin/inventory-items/delete-inventory-item.ts b/packages/medusa/src/api/routes/admin/inventory-items/delete-inventory-item.ts index a8371d526b..9822e610b0 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/delete-inventory-item.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/delete-inventory-item.ts @@ -4,7 +4,7 @@ import { IInventoryService } from "../../../../interfaces" import { ProductVariantInventoryService } from "../../../../services" /** - * @oas [delete] /inventory-items/{id} + * @oas [delete] /admin/inventory-items/{id} * operationId: "DeleteInventoryItemsInventoryItem" * summary: "Delete an Inventory Item" * description: "Delete an Inventory Item" diff --git a/packages/medusa/src/api/routes/admin/inventory-items/delete-location-level.ts b/packages/medusa/src/api/routes/admin/inventory-items/delete-location-level.ts index 4471b76fa7..817b44906c 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/delete-location-level.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/delete-location-level.ts @@ -4,7 +4,7 @@ import { EntityManager } from "typeorm" import { IInventoryService } from "../../../../interfaces" /** - * @oas [delete] /inventory-items/{id}/location-levels/{location_id} + * @oas [delete] /admin/inventory-items/{id}/location-levels/{location_id} * operationId: "DeleteInventoryItemsInventoryIteLocationLevelsLocation" * summary: "Delete a location level of an Inventory Item." * description: "Delete a location level of an Inventory Item." diff --git a/packages/medusa/src/api/routes/admin/inventory-items/get-inventory-item.ts b/packages/medusa/src/api/routes/admin/inventory-items/get-inventory-item.ts index 3efc087308..7020c6e0cc 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/get-inventory-item.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/get-inventory-item.ts @@ -4,7 +4,7 @@ import { FindParams } from "../../../../types/common" import { joinLevels } from "./utils/join-levels" /** - * @oas [get] /inventory-items/{id} + * @oas [get] /admin/inventory-items/{id} * operationId: "GetInventoryItemsInventoryItem" * summary: "Retrive an Inventory Item." * description: "Retrives an Inventory Item." diff --git a/packages/medusa/src/api/routes/admin/inventory-items/list-inventory-items.ts b/packages/medusa/src/api/routes/admin/inventory-items/list-inventory-items.ts index 2377af2d94..504ca7b1bb 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/list-inventory-items.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/list-inventory-items.ts @@ -1,5 +1,5 @@ import { Request, Response } from "express" -import { IsString, IsBoolean, IsOptional } from "class-validator" +import { IsBoolean, IsOptional, IsString } from "class-validator" import { Transform } from "class-transformer" import { IsType } from "../../../../utils/validators/is-type" import { getLevelsByInventoryItemId } from "./utils/join-levels" @@ -14,13 +14,13 @@ import { import { IInventoryService } from "../../../../interfaces" import { extendedFindParamsMixin, - StringComparisonOperator, NumericalComparisonOperator, + StringComparisonOperator, } from "../../../../types/common" import { AdminInventoryItemsListWithVariantsAndLocationLevelsRes } from "." /** - * @oas [get] /inventory-items + * @oas [get] /admin/inventory-items * operationId: "GetInventoryItems" * summary: "List inventory items." * description: "Lists inventory items." diff --git a/packages/medusa/src/api/routes/admin/inventory-items/list-location-levels.ts b/packages/medusa/src/api/routes/admin/inventory-items/list-location-levels.ts index 3842b59c0f..4a67870cb5 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/list-location-levels.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/list-location-levels.ts @@ -4,7 +4,7 @@ import { IInventoryService } from "../../../../interfaces" import { FindParams } from "../../../../types/common" /** - * @oas [get] /inventory-items/{id}/location-levels + * @oas [get] /admin/inventory-items/{id}/location-levels * operationId: "GetInventoryItemsInventoryItemLocationLevels" * summary: "List stock levels of a given location." * description: "Lists stock levels of a given location." diff --git a/packages/medusa/src/api/routes/admin/inventory-items/update-inventory-item.ts b/packages/medusa/src/api/routes/admin/inventory-items/update-inventory-item.ts index ad4628f209..38ed6637ae 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/update-inventory-item.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/update-inventory-item.ts @@ -6,7 +6,7 @@ import { FindParams } from "../../../../types/common" import { EntityManager } from "typeorm" /** - * @oas [post] /inventory-items/{id} + * @oas [post] /admin/inventory-items/{id} * operationId: "PostInventoryItemsInventoryItem" * summary: "Update an Inventory Item." * description: "Updates an Inventory Item." diff --git a/packages/medusa/src/api/routes/admin/inventory-items/update-location-level.ts b/packages/medusa/src/api/routes/admin/inventory-items/update-location-level.ts index fb0218de3d..2c7e3f8a7a 100644 --- a/packages/medusa/src/api/routes/admin/inventory-items/update-location-level.ts +++ b/packages/medusa/src/api/routes/admin/inventory-items/update-location-level.ts @@ -1,12 +1,12 @@ import { Request, Response } from "express" -import { IsOptional, IsNumber } from "class-validator" +import { IsNumber, IsOptional } from "class-validator" import { IInventoryService } from "../../../../interfaces" import { FindParams } from "../../../../types/common" import { EntityManager } from "typeorm" /** - * @oas [post] /inventory-items/{id}/location-levels/{location_id} + * @oas [post] /admin/inventory-items/{id}/location-levels/{location_id} * operationId: "PostInventoryItemsInventoryItemLocationLevelsLocationLevel" * summary: "Update an Inventory Location Level for a given Inventory Item." * description: "Updates an Inventory Location Level for a given Inventory Item." diff --git a/packages/medusa/src/api/routes/admin/invites/accept-invite.ts b/packages/medusa/src/api/routes/admin/invites/accept-invite.ts index e175c59735..677c6eb55e 100644 --- a/packages/medusa/src/api/routes/admin/invites/accept-invite.ts +++ b/packages/medusa/src/api/routes/admin/invites/accept-invite.ts @@ -6,7 +6,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /invites/accept + * @oas [post] /admin/invites/accept * operationId: "PostInvitesInviteAccept" * summary: "Accept an Invite" * description: "Accepts an Invite and creates a corresponding user" diff --git a/packages/medusa/src/api/routes/admin/invites/create-invite.ts b/packages/medusa/src/api/routes/admin/invites/create-invite.ts index 38566a7399..46bf65aa6c 100644 --- a/packages/medusa/src/api/routes/admin/invites/create-invite.ts +++ b/packages/medusa/src/api/routes/admin/invites/create-invite.ts @@ -6,7 +6,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /invites + * @oas [post] /admin/invites * operationId: "PostInvites" * summary: "Create an Invite" * description: "Creates an Invite and triggers an 'invite' created event" diff --git a/packages/medusa/src/api/routes/admin/invites/delete-invite.ts b/packages/medusa/src/api/routes/admin/invites/delete-invite.ts index b5d1586986..a78fc8c570 100644 --- a/packages/medusa/src/api/routes/admin/invites/delete-invite.ts +++ b/packages/medusa/src/api/routes/admin/invites/delete-invite.ts @@ -2,7 +2,7 @@ import { EntityManager } from "typeorm" import InviteService from "../../../../services/invite" /** - * @oas [delete] /invites/{invite_id} + * @oas [delete] /admin/invites/{invite_id} * operationId: "DeleteInvitesInvite" * summary: "Delete an Invite" * description: "Deletes an Invite" 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 895a840f97..a495d8ec10 100644 --- a/packages/medusa/src/api/routes/admin/invites/list-invites.ts +++ b/packages/medusa/src/api/routes/admin/invites/list-invites.ts @@ -1,7 +1,7 @@ import InviteService from "../../../../services/invite" /** - * @oas [get] /invites + * @oas [get] /admin/invites * operationId: "GetInvites" * summary: "Lists Invites" * description: "Lists all Invites" diff --git a/packages/medusa/src/api/routes/admin/invites/resend-invite.ts b/packages/medusa/src/api/routes/admin/invites/resend-invite.ts index 61f1b685ad..ec9ac247d6 100644 --- a/packages/medusa/src/api/routes/admin/invites/resend-invite.ts +++ b/packages/medusa/src/api/routes/admin/invites/resend-invite.ts @@ -2,7 +2,7 @@ import InviteService from "../../../../services/invite" import { EntityManager } from "typeorm" /** - * @oas [post] /invites/{invite_id}/resend + * @oas [post] /admin/invites/{invite_id}/resend * operationId: "PostInvitesInviteResend" * summary: "Resend an Invite" * description: "Resends an Invite by triggering the 'invite' created event again" 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 1800078add..049d0f1448 100644 --- a/packages/medusa/src/api/routes/admin/notes/create-note.ts +++ b/packages/medusa/src/api/routes/admin/notes/create-note.ts @@ -5,7 +5,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /notes + * @oas [post] /admin/notes * operationId: "PostNotes" * summary: "Creates a Note" * description: "Creates a Note which can be associated with any resource as required." diff --git a/packages/medusa/src/api/routes/admin/notes/delete-note.ts b/packages/medusa/src/api/routes/admin/notes/delete-note.ts index 7a884b284c..745c080fa1 100644 --- a/packages/medusa/src/api/routes/admin/notes/delete-note.ts +++ b/packages/medusa/src/api/routes/admin/notes/delete-note.ts @@ -2,7 +2,7 @@ import { EntityManager } from "typeorm" import NoteService from "../../../../services/note" /** - * @oas [delete] /notes/{id} + * @oas [delete] /admin/notes/{id} * operationId: "DeleteNotesNote" * summary: "Delete a Note" * description: "Deletes a Note." 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 c6c3f70ea6..fc29b55585 100644 --- a/packages/medusa/src/api/routes/admin/notes/get-note.ts +++ b/packages/medusa/src/api/routes/admin/notes/get-note.ts @@ -1,7 +1,7 @@ import NoteService from "../../../../services/note" /** - * @oas [get] /notes/{id} + * @oas [get] /admin/notes/{id} * operationId: "GetNotesNote" * summary: "Get a Note" * description: "Retrieves a single note using its id" 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 982f9e959d..aaeb869d84 100644 --- a/packages/medusa/src/api/routes/admin/notes/list-notes.ts +++ b/packages/medusa/src/api/routes/admin/notes/list-notes.ts @@ -6,7 +6,7 @@ import { selector } from "../../../../types/note" import { validator } from "../../../../utils/validator" /** - * @oas [get] /notes + * @oas [get] /admin/notes * operationId: "GetNotes" * summary: "List Notes" * x-authenticated: true 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 63bee84088..f214577b8a 100644 --- a/packages/medusa/src/api/routes/admin/notes/update-note.ts +++ b/packages/medusa/src/api/routes/admin/notes/update-note.ts @@ -4,7 +4,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /notes/{id} + * @oas [post] /admin/notes/{id} * operationId: "PostNotesNote" * summary: "Update a Note" * x-authenticated: true 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 1493db2c34..6ec2b474ad 100644 --- a/packages/medusa/src/api/routes/admin/notifications/list-notifications.ts +++ b/packages/medusa/src/api/routes/admin/notifications/list-notifications.ts @@ -12,7 +12,7 @@ import { pick } from "lodash" import { validator } from "../../../../utils/validator" /** - * @oas [get] /notifications + * @oas [get] /admin/notifications * operationId: "GetNotifications" * summary: "List Notifications" * description: "Retrieves a list of Notifications." 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 f60fbe5a20..9c74b27705 100644 --- a/packages/medusa/src/api/routes/admin/notifications/resend-notification.ts +++ b/packages/medusa/src/api/routes/admin/notifications/resend-notification.ts @@ -10,7 +10,7 @@ import { NotificationService } from "../../../../services" import { validator } from "../../../../utils/validator" /** - * @oas [post] /notifications/{id}/resend + * @oas [post] /admin/notifications/{id}/resend * operationId: "PostNotificationsNotificationResend" * summary: "Resend Notification" * description: "Resends a previously sent notifications, with the same data but optionally to a different address" 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 f883db9ed9..5e1a2b52de 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 @@ -9,7 +9,7 @@ import { } from "../../../../types/order-edit" /** - * @oas [post] /order-edits/{id}/items + * @oas [post] /admin/order-edits/{id}/items * operationId: "PostOrderEditsEditLineItems" * summary: "Add a Line Item" * description: "Create an OrderEdit LineItem." 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 fccd563408..223c453849 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 @@ -7,7 +7,7 @@ import { } from "../../../../types/order-edit" /** - * @oas [post] /order-edits/{id}/cancel + * @oas [post] /admin/order-edits/{id}/cancel * operationId: "PostOrderEditsOrderEditCancel" * summary: "Cancel an OrderEdit" * description: "Cancels an OrderEdit." 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 064c064c71..665b348337 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 @@ -7,7 +7,7 @@ import { } from "../../../../types/order-edit" /** - * @oas [post] /order-edits/{id}/confirm + * @oas [post] /admin/order-edits/{id}/confirm * operationId: "PostOrderEditsOrderEditConfirm" * summary: "Confirms an OrderEdit" * description: "Confirms an OrderEdit." 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 7e52e19b99..bb1cc43fce 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 @@ -8,7 +8,7 @@ import { } from "../../../../types/order-edit" /** - * @oas [post] /order-edits + * @oas [post] /admin/order-edits * operationId: "PostOrderEdits" * summary: "Create an OrderEdit" * description: "Creates an OrderEdit." 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 404858622e..b3b9a2b0fd 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 @@ -7,7 +7,7 @@ import { } from "../../../../types/order-edit" /** - * @oas [delete] /order-edits/{id}/items/{item_id} + * @oas [delete] /admin/order-edits/{id}/items/{item_id} * operationId: "DeleteOrderEditsOrderEditLineItemsLineItem" * summary: "Delete a Line Item" * description: "Delete line items from an order edit and create change item" diff --git a/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit-item-change.ts b/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit-item-change.ts index fd7f7823af..42c33ada3e 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit-item-change.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit-item-change.ts @@ -2,7 +2,7 @@ import { EntityManager } from "typeorm" import { OrderEditService } from "../../../../services" /** - * @oas [delete] /order-edits/{id}/changes/{change_id} + * @oas [delete] /admin/order-edits/{id}/changes/{change_id} * operationId: "DeleteOrderEditsOrderEditItemChange" * summary: "Delete a Line Item Change" * description: "Deletes an Order Edit Item Change" diff --git a/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit.ts b/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit.ts index 96952fa44f..f2fe803c50 100644 --- a/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit.ts +++ b/packages/medusa/src/api/routes/admin/order-edits/delete-order-edit.ts @@ -2,7 +2,7 @@ import { EntityManager } from "typeorm" import { OrderEditService } from "../../../../services" /** - * @oas [delete] /order-edits/{id} + * @oas [delete] /admin/order-edits/{id} * operationId: "DeleteOrderEditsOrderEdit" * summary: "Delete an Order Edit" * description: "Delete an Order Edit" 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 51849e74fb..0022ea041d 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 @@ -3,7 +3,7 @@ import { OrderEditService } from "../../../../services" import { FindParams } from "../../../../types/common" /** - * @oas [get] /order-edits/{id} + * @oas [get] /admin/order-edits/{id} * operationId: "GetOrderEditsOrderEdit" * summary: "Get an OrderEdit" * description: "Retrieves a OrderEdit." 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 0d2cbdcac5..e3998d61c0 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 @@ -4,7 +4,7 @@ import { extendedFindParamsMixin } from "../../../../types/common" import { IsOptional, IsString } from "class-validator" /** - * @oas [get] /order-edits + * @oas [get] /admin/order-edits * operationId: "GetOrderEdits" * summary: "List OrderEdits" * description: "List OrderEdits." 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 b33901ec49..40b370bdc1 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 @@ -12,7 +12,7 @@ import { } from "../../../../types/order-edit" /** - * @oas [post] /order-edits/{id}/request + * @oas [post] /admin/order-edits/{id}/request * operationId: "PostOrderEditsOrderEditRequest" * summary: "Request Confirmation" * description: "Request customer confirmation of an Order Edit" 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 9ba144f3d0..f482abaa2a 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 @@ -8,7 +8,7 @@ import { } from "../../../../types/order-edit" /** - * @oas [post] /order-edits/{id}/items/{item_id} + * @oas [post] /admin/order-edits/{id}/items/{item_id} * operationId: "PostOrderEditsEditLineItemsLineItem" * summary: "Upsert Line Item Change" * description: "Create or update the order edit change holding the line item changes" 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 8d2a1344fa..3556c8ea9a 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 @@ -9,7 +9,7 @@ import { } from "../../../../types/order-edit" /** - * @oas [post] /order-edits/{id} + * @oas [post] /admin/order-edits/{id} * operationId: "PostOrderEditsOrderEdit" * summary: "Update an OrderEdit" * description: "Updates a OrderEdit." 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 68814b7ba8..aaf4596604 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 @@ -12,7 +12,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /orders/{id}/shipping-methods + * @oas [post] /admin/orders/{id}/shipping-methods * operationId: "PostOrdersOrderShippingMethods" * summary: "Add a Shipping Method" * description: "Adds a Shipping Method to an Order. If another Shipping Method exists with the same Shipping Profile, the previous Shipping Method will be replaced." 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 81ce7c3ea3..2b2f77f8aa 100644 --- a/packages/medusa/src/api/routes/admin/orders/archive-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/archive-order.ts @@ -2,7 +2,7 @@ import { OrderService } from "../../../../services" import { EntityManager } from "typeorm" /** - * @oas [post] /orders/{id}/archive + * @oas [post] /admin/orders/{id}/archive * operationId: "PostOrdersOrderArchive" * summary: "Archive Order" * description: "Archives the order with the given id." 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 3c11518088..be3021ceec 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-claim.ts @@ -5,7 +5,7 @@ import { EntityManager } from "typeorm" import { MedusaError } from "medusa-core-utils" /** - * @oas [post] /orders/{id}/claims/{claim_id}/cancel + * @oas [post] /admin/orders/{id}/claims/{claim_id}/cancel * operationId: "PostOrdersClaimCancel" * summary: "Cancel a Claim" * description: "Cancels a Claim" 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 56c7acedbb..525ba91d57 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 @@ -9,7 +9,7 @@ import { EntityManager } from "typeorm" import { MedusaError } from "medusa-core-utils" /** - * @oas [post] /orders/{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel + * @oas [post] /admin/orders/{id}/claims/{claim_id}/fulfillments/{fulfillment_id}/cancel * operationId: "PostOrdersClaimFulfillmentsCancel" * summary: "Cancel Claim Fulfillment" * description: "Registers a claim's fulfillment as canceled." 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 b0505a682e..81817dedbb 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 @@ -9,7 +9,7 @@ import { EntityManager } from "typeorm" import { MedusaError } from "medusa-core-utils" /** - * @oas [post] /orders/{id}/swaps/{swap_id}/fulfillments/{fulfillment_id}/cancel + * @oas [post] /admin/orders/{id}/swaps/{swap_id}/fulfillments/{fulfillment_id}/cancel * operationId: "PostOrdersSwapFulfillmentsCancel" * summary: "Cancel Swap's Fulfilmment" * description: "Registers a Swap's Fulfillment as canceled." 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 56c21d7615..cba0f750f1 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-fulfillment.ts @@ -11,7 +11,7 @@ import { Fulfillment } from "../../../../models" import { IInventoryService } from "../../../../interfaces" /** - * @oas [post] /orders/{id}/fulfillments/{fulfillment_id}/cancel + * @oas [post] /admin/orders/{id}/fulfillments/{fulfillment_id}/cancel * operationId: "PostOrdersOrderFulfillmentsCancel" * summary: "Cancels a Fulfilmment" * description: "Registers a Fulfillment as canceled." 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 dc2134f644..99ab316e81 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-order.ts @@ -4,7 +4,7 @@ import { OrderService } from "../../../../services" import { EntityManager } from "typeorm" /** - * @oas [post] /orders/{id}/cancel + * @oas [post] /admin/orders/{id}/cancel * operationId: "PostOrdersOrderCancel" * summary: "Cancel an Order" * description: "Registers an Order as canceled. This triggers a flow that will cancel any created Fulfillments and Payments, may fail if the Payment or Fulfillment Provider is unable to cancel the Payment/Fulfillment." 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 2ecae0b1e5..24fee02b43 100644 --- a/packages/medusa/src/api/routes/admin/orders/cancel-swap.ts +++ b/packages/medusa/src/api/routes/admin/orders/cancel-swap.ts @@ -5,7 +5,7 @@ import { EntityManager } from "typeorm" import { MedusaError } from "medusa-core-utils" /** - * @oas [post] /orders/{id}/swaps/{swap_id}/cancel + * @oas [post] /admin/orders/{id}/swaps/{swap_id}/cancel * operationId: "PostOrdersSwapCancel" * summary: "Cancels a Swap" * description: "Cancels a Swap" 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 b5c025c2ee..15b5c16779 100644 --- a/packages/medusa/src/api/routes/admin/orders/capture-payment.ts +++ b/packages/medusa/src/api/routes/admin/orders/capture-payment.ts @@ -4,7 +4,7 @@ import { OrderService } from "../../../../services" import { EntityManager } from "typeorm" /** - * @oas [post] /orders/{id}/capture + * @oas [post] /admin/orders/{id}/capture * operationId: "PostOrdersOrderCapture" * summary: "Capture Order's Payment" * description: "Captures all the Payments associated with an Order." 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 3ed8b4fc00..7c46a707b8 100644 --- a/packages/medusa/src/api/routes/admin/orders/complete-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/complete-order.ts @@ -2,7 +2,7 @@ import { OrderService } from "../../../../services" import { EntityManager } from "typeorm" /** - * @oas [post] /orders/{id}/complete + * @oas [post] /admin/orders/{id}/complete * operationId: "PostOrdersOrderComplete" * summary: "Complete an Order" * description: "Completes an Order" 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 f3ca645046..ba7fac8f84 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 @@ -6,7 +6,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /orders/{id}/claims/{claim_id}/shipments + * @oas [post] /admin/orders/{id}/claims/{claim_id}/shipments * operationId: "PostOrdersOrderClaimsClaimShipments" * summary: "Create Claim Shipment" * description: "Registers a Claim Fulfillment as shipped." 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 5fecd6c2ee..5e86608065 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-claim.ts @@ -20,7 +20,7 @@ import { AddressPayload } from "../../../../types/common" import { validator } from "../../../../utils/validator" /** - * @oas [post] /order/{id}/claims + * @oas [post] /admin/order/{id}/claims * operationId: "PostOrdersOrderClaims" * summary: "Create a Claim" * description: "Creates a Claim." 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 61434c7791..19f6fbfc2d 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts @@ -21,7 +21,7 @@ import { optionalBooleanMapper } from "../../../../utils/validators/is-boolean" import { Fulfillment, LineItem } from "../../../../models" /** - * @oas [post] /orders/{id}/fulfillment + * @oas [post] /admin/orders/{id}/fulfillment * operationId: "PostOrdersOrderFulfillments" * summary: "Create a Fulfillment" * description: "Creates a Fulfillment of an Order - will notify Fulfillment Providers to prepare a shipment." diff --git a/packages/medusa/src/api/routes/admin/orders/create-reservation-for-line-item.ts b/packages/medusa/src/api/routes/admin/orders/create-reservation-for-line-item.ts index 12460ea0dc..610ffc1160 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-reservation-for-line-item.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-reservation-for-line-item.ts @@ -6,7 +6,7 @@ import { } from "../../../../services" /** - * @oas [post] /orders/{id}/line-items/{line_item_id}/reserve + * @oas [post] /admin/orders/{id}/line-items/{line_item_id}/reserve * operationId: "PostOrdersOrderLineItemReservations" * summary: "Create a Reservation for a line item" * description: "Creates a Reservation for a line item at a specified location, optionally for a partial quantity." 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 2435626b82..6044f298dd 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-shipment.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-shipment.ts @@ -13,7 +13,7 @@ import { TrackingLink } from "../../../../models" import { validator } from "../../../../utils/validator" /** - * @oas [post] /orders/{id}/shipment + * @oas [post] /admin/orders/{id}/shipment * operationId: "PostOrdersOrderShipment" * summary: "Create a Shipment" * description: "Registers a Fulfillment as shipped." 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 515c62036b..0f84f850b1 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 @@ -12,7 +12,7 @@ import { EntityManager } from "typeorm" import { validator } from "../../../../utils/validator" /** - * @oas [post] /orders/{id}/swaps/{swap_id}/shipments + * @oas [post] /admin/orders/{id}/swaps/{swap_id}/shipments * operationId: "PostOrdersOrderSwapsSwapShipments" * summary: "Create Swap Shipment" * description: "Registers a Swap Fulfillment as shipped." 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 df6f1a7650..0decab7462 100644 --- a/packages/medusa/src/api/routes/admin/orders/create-swap.ts +++ b/packages/medusa/src/api/routes/admin/orders/create-swap.ts @@ -24,7 +24,7 @@ import { Type } from "class-transformer" import { validator } from "../../../../utils/validator" /** - * @oas [post] /order/{id}/swaps + * @oas [post] /admin/order/{id}/swaps * operationId: "PostOrdersOrderSwaps" * summary: "Create a Swap" * description: "Creates a Swap. Swaps are used to handle Return of previously purchased goods and Fulfillment of replacements simultaneously." 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 4551d33aca..b370e87a9a 100644 --- a/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/fulfill-claim.ts @@ -6,7 +6,7 @@ import { EntityManager } from "typeorm" import { validator } from "../../../../utils/validator" /** - * @oas [post] /orders/{id}/claims/{claim_id}/fulfillments + * @oas [post] /admin/orders/{id}/claims/{claim_id}/fulfillments * operationId: "PostOrdersOrderClaimsClaimFulfillments" * summary: "Create Claim Fulfillment" * description: "Creates a Fulfillment for a Claim." 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 878df88c20..a8678a0bf6 100644 --- a/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts +++ b/packages/medusa/src/api/routes/admin/orders/fulfill-swap.ts @@ -6,7 +6,7 @@ import { EntityManager } from "typeorm" import { validator } from "../../../../utils/validator" /** - * @oas [post] /orders/{id}/swaps/{swap_id}/fulfillments + * @oas [post] /admin/orders/{id}/swaps/{swap_id}/fulfillments * operationId: "PostOrdersOrderSwapsSwapFulfillments" * summary: "Create Swap Fulfillment" * description: "Creates a Fulfillment for a Swap." 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 6b2020460f..b88f9fc490 100644 --- a/packages/medusa/src/api/routes/admin/orders/get-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/get-order.ts @@ -2,7 +2,7 @@ import { OrderService } from "../../../../services" import { FindParams } from "../../../../types/common" /** - * @oas [get] /orders/{id} + * @oas [get] /admin/orders/{id} * operationId: "GetOrdersOrder" * summary: "Get an Order" * description: "Retrieves an Order" diff --git a/packages/medusa/src/api/routes/admin/orders/get-reservations.ts b/packages/medusa/src/api/routes/admin/orders/get-reservations.ts index 352cee1724..9c2bb9bb8b 100644 --- a/packages/medusa/src/api/routes/admin/orders/get-reservations.ts +++ b/packages/medusa/src/api/routes/admin/orders/get-reservations.ts @@ -4,7 +4,7 @@ import { OrderService } from "../../../../services" import { extendedFindParamsMixin } from "../../../../types/common" /** - * @oas [get] /orders/{id}/reservations + * @oas [get] /admin/orders/{id}/reservations * operationId: "GetOrdersOrderReservations" * summary: "Get reservations for an Order" * description: "Retrieves reservations for an Order" 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 83bf18192e..37ab98c78a 100644 --- a/packages/medusa/src/api/routes/admin/orders/list-orders.ts +++ b/packages/medusa/src/api/routes/admin/orders/list-orders.ts @@ -7,7 +7,7 @@ import { Type } from "class-transformer" import { pick } from "lodash" /** - * @oas [get] /orders + * @oas [get] /admin/orders * operationId: "GetOrders" * summary: "List Orders" * description: "Retrieves a list of Orders" 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 321322d9ca..99a8cdef87 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 @@ -4,7 +4,7 @@ import { defaultAdminOrdersFields, defaultAdminOrdersRelations } from "." import { EntityManager } from "typeorm" /** - * @oas [post] /orders/{id}/swaps/{swap_id}/process-payment + * @oas [post] /admin/orders/{id}/swaps/{swap_id}/process-payment * operationId: "PostOrdersOrderSwapsSwapProcessPayment" * summary: "Process Swap Payment" * description: "When there are differences between the returned and shipped Products in a Swap, the difference must be processed. Either a Refund will be issued or a Payment will be captured." 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 7b8bcceb44..c68837b599 100644 --- a/packages/medusa/src/api/routes/admin/orders/refund-payment.ts +++ b/packages/medusa/src/api/routes/admin/orders/refund-payment.ts @@ -12,7 +12,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /orders/{id}/refund + * @oas [post] /admin/orders/{id}/refund * operationId: "PostOrdersOrderRefunds" * summary: "Create a Refund" * description: "Issues a Refund." 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 eff4cac4d8..95e5b47b25 100644 --- a/packages/medusa/src/api/routes/admin/orders/request-return.ts +++ b/packages/medusa/src/api/routes/admin/orders/request-return.ts @@ -21,7 +21,7 @@ import { OrdersReturnItem } from "../../../../types/orders" import { validator } from "../../../../utils/validator" /** - * @oas [post] /orders/{id}/return + * @oas [post] /admin/orders/{id}/return * operationId: "PostOrdersOrderReturns" * summary: "Request a Return" * description: "Requests a Return. If applicable a return label will be created and other plugins notified." 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 41787f69d1..489437eaea 100644 --- a/packages/medusa/src/api/routes/admin/orders/update-claim.ts +++ b/packages/medusa/src/api/routes/admin/orders/update-claim.ts @@ -16,7 +16,7 @@ import { EntityManager } from "typeorm" import { validator } from "../../../../utils/validator" /** - * @oas [post] /order/{id}/claims/{claim_id} + * @oas [post] /admin/order/{id}/claims/{claim_id} * operationId: "PostOrdersOrderClaimsClaim" * summary: "Update a Claim" * description: "Updates a Claim." 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 c44d1215dc..83ff2f3c3d 100644 --- a/packages/medusa/src/api/routes/admin/orders/update-order.ts +++ b/packages/medusa/src/api/routes/admin/orders/update-order.ts @@ -17,7 +17,7 @@ import { Type } from "class-transformer" import { validator } from "../../../../utils/validator" /** - * @oas [post] /orders/{id} + * @oas [post] /admin/orders/{id} * operationId: "PostOrdersOrder" * summary: "Update an Order" * description: "Updates and order" diff --git a/packages/medusa/src/api/routes/admin/payment-collections/delete-payment-collection.ts b/packages/medusa/src/api/routes/admin/payment-collections/delete-payment-collection.ts index de601b362a..96eef2aa58 100644 --- a/packages/medusa/src/api/routes/admin/payment-collections/delete-payment-collection.ts +++ b/packages/medusa/src/api/routes/admin/payment-collections/delete-payment-collection.ts @@ -1,7 +1,7 @@ import { PaymentCollectionService } from "../../../../services" /** - * @oas [delete] /payment-collections/{id} + * @oas [delete] /admin/payment-collections/{id} * operationId: "DeletePaymentCollectionsPaymentCollection" * summary: "Del a PaymentCollection" * description: "Deletes a Payment Collection" 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 0939a4ea07..3fdfaaad1e 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 @@ -2,7 +2,7 @@ import { PaymentCollectionService } from "../../../../services" import { FindParams } from "../../../../types/common" /** - * @oas [get] /payment-collections/{id} + * @oas [get] /admin/payment-collections/{id} * operationId: "GetPaymentCollectionsPaymentCollection" * summary: "Get a PaymentCollection" * description: "Retrieves a PaymentCollection." 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 949a540ab0..6bb430e70d 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 @@ -2,7 +2,7 @@ import { EntityManager } from "typeorm" import { PaymentCollectionService } from "../../../../services" /** - * @oas [post] /payment-collections/{id}/authorize + * @oas [post] /admin/payment-collections/{id}/authorize * operationId: "PostPaymentCollectionsPaymentCollectionAuthorize" * summary: "Mark Authorized" * description: "Sets the status of PaymentCollection as Authorized." 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 efbe1500c6..c5bdc1ac99 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 @@ -4,7 +4,7 @@ import { EntityManager } from "typeorm" import { PaymentCollectionService } from "../../../../services" /** - * @oas [post] /payment-collections/{id} + * @oas [post] /admin/payment-collections/{id} * operationId: "PostPaymentCollectionsPaymentCollection" * summary: "Update PaymentCollection" * description: "Updates a PaymentCollection." 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 6c028922a6..064ccfd1c5 100644 --- a/packages/medusa/src/api/routes/admin/payments/capture-payment.ts +++ b/packages/medusa/src/api/routes/admin/payments/capture-payment.ts @@ -1,7 +1,7 @@ import { PaymentService } from "../../../../services" /** - * @oas [post] /payments/{id}/capture + * @oas [post] /admin/payments/{id}/capture * operationId: "PostPaymentsPaymentCapture" * summary: "Capture a Payment" * description: "Captures a Payment." 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 ba44dbf5ab..e0812c0241 100644 --- a/packages/medusa/src/api/routes/admin/payments/get-payment.ts +++ b/packages/medusa/src/api/routes/admin/payments/get-payment.ts @@ -2,7 +2,7 @@ import { PaymentService } from "../../../../services" import { FindParams } from "../../../../types/common" /** - * @oas [get] /payments/{id} + * @oas [get] /admin/payments/{id} * operationId: "GetPaymentsPayment" * summary: "Get Payment details" * description: "Retrieves the Payment details" 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 f105f4ad92..b876a2ea04 100644 --- a/packages/medusa/src/api/routes/admin/payments/refund-payment.ts +++ b/packages/medusa/src/api/routes/admin/payments/refund-payment.ts @@ -10,7 +10,7 @@ import { RefundReason } from "../../../../models" import { PaymentService } from "../../../../services" /** - * @oas [post] /payments/{id}/refund + * @oas [post] /admin/payments/{id}/refund * operationId: "PostPaymentsPaymentRefunds" * summary: "Create a Refund" * description: "Issues a Refund." 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 c3f7751915..b703812aed 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 @@ -9,7 +9,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /price-lists/{id}/prices/batch + * @oas [post] /admin/price-lists/{id}/prices/batch * operationId: "PostPriceListsPriceListPricesBatch" * summary: "Update Prices" * description: "Batch update prices for a Price List" 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 9d9923fe79..b503363b4c 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 @@ -21,7 +21,7 @@ import PriceListService from "../../../../services/price-list" import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators" /** - * @oas [post] /price-lists + * @oas [post] /admin/price-lists * operationId: "PostPriceListsPriceList" * summary: "Create a Price List" * description: "Creates a Price List" diff --git a/packages/medusa/src/api/routes/admin/price-lists/delete-price-list.ts b/packages/medusa/src/api/routes/admin/price-lists/delete-price-list.ts index 3dbbe983fa..917a78bae6 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/delete-price-list.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/delete-price-list.ts @@ -2,7 +2,7 @@ import { EntityManager } from "typeorm" import PriceListService from "../../../../services/price-list" /** - * @oas [delete] /price-lists/{id} + * @oas [delete] /admin/price-lists/{id} * operationId: "DeletePriceListsPriceList" * summary: "Delete a Price List" * description: "Deletes a Price List" diff --git a/packages/medusa/src/api/routes/admin/price-lists/delete-prices-batch.ts b/packages/medusa/src/api/routes/admin/price-lists/delete-prices-batch.ts index 33d1e438cb..7c17f66272 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/delete-prices-batch.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/delete-prices-batch.ts @@ -5,7 +5,7 @@ import PriceListService from "../../../../services/price-list" import { validator } from "../../../../utils/validator" /** - * @oas [delete] /price-lists/{id}/prices/batch + * @oas [delete] /admin/price-lists/{id}/prices/batch * operationId: "DeletePriceListsPriceListPricesBatch" * summary: "Delete Prices" * description: "Batch delete prices that belong to a Price List" diff --git a/packages/medusa/src/api/routes/admin/price-lists/delete-product-prices.ts b/packages/medusa/src/api/routes/admin/price-lists/delete-product-prices.ts index ac8d64cdee..7353b43385 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/delete-product-prices.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/delete-product-prices.ts @@ -2,7 +2,7 @@ import { EntityManager } from "typeorm" import PriceListService from "../../../../services/price-list" /** - * @oas [delete] /price-lists/{id}/products/{product_id}/prices + * @oas [delete] /admin/price-lists/{id}/products/{product_id}/prices * operationId: "DeletePriceListsPriceListProductsProductPrices" * summary: "Delete Product's Prices" * description: "Delete all the prices related to a specific product in a price list" diff --git a/packages/medusa/src/api/routes/admin/price-lists/delete-variant-prices.ts b/packages/medusa/src/api/routes/admin/price-lists/delete-variant-prices.ts index 5f3391f63d..869390a4d7 100644 --- a/packages/medusa/src/api/routes/admin/price-lists/delete-variant-prices.ts +++ b/packages/medusa/src/api/routes/admin/price-lists/delete-variant-prices.ts @@ -2,7 +2,7 @@ import { EntityManager } from "typeorm" import PriceListService from "../../../../services/price-list" /** - * @oas [delete] /price-lists/{id}/variants/{variant_id}/prices + * @oas [delete] /admin/price-lists/{id}/variants/{variant_id}/prices * operationId: "DeletePriceListsPriceListVariantsVariantPrices" * summary: "Delete Variant's Prices" * description: "Delete all the prices related to a specific variant in a price list" 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 ebe6451862..34feea8e06 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 @@ -4,7 +4,7 @@ import { PriceList } from "../../../.." import PriceListService from "../../../../services/price-list" /** - * @oas [get] /price-lists/{id} + * @oas [get] /admin/price-lists/{id} * operationId: "GetPriceListsPriceList" * summary: "Get a Price List" * description: "Retrieves a Price List." 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 56aa4c6550..b2e02e912b 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 @@ -20,7 +20,7 @@ import { pickBy } from "lodash" import { isDefined } from "medusa-core-utils" /** - * @oas [get] /price-lists/{id}/products + * @oas [get] /admin/price-lists/{id}/products * operationId: "GetPriceListsPriceListProducts" * summary: "List Products" * description: "Retrieves a list of Product that are part of a Price List" 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 3393a65097..cf26496e32 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 @@ -6,7 +6,7 @@ import { Request } from "express" import { Type } from "class-transformer" /** - * @oas [get] /price-lists + * @oas [get] /admin/price-lists * operationId: "GetPriceLists" * summary: "List Price Lists" * description: "Retrieves a list of Price Lists." 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 ca76aa4c64..beccaa4f1e 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 @@ -22,7 +22,7 @@ import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators import { validator } from "../../../../utils/validator" /** - * @oas [post] /price-lists/{id} + * @oas [post] /admin/price-lists/{id} * operationId: "PostPriceListsPriceListPriceList" * summary: "Update a Price List" * description: "Updates a Price List" diff --git a/packages/medusa/src/api/routes/admin/product-categories/add-products-batch.ts b/packages/medusa/src/api/routes/admin/product-categories/add-products-batch.ts index 463d3b1118..6822a32b69 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/add-products-batch.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/add-products-batch.ts @@ -8,7 +8,7 @@ import { Type } from "class-transformer" import { FindParams } from "../../../../types/common" /** - * @oas [post] /product-categories/{id}/products/batch + * @oas [post] /admin/product-categories/{id}/products/batch * operationId: "PostProductCategoriesCategoryProductsBatch" * summary: "Add Products to a category" * description: "Assign a batch of products to a product category." diff --git a/packages/medusa/src/api/routes/admin/product-categories/create-product-category.ts b/packages/medusa/src/api/routes/admin/product-categories/create-product-category.ts index 1962bee84f..4be1759316 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/create-product-category.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/create-product-category.ts @@ -7,7 +7,7 @@ import { AdminProductCategoriesReqBase } from "../../../../types/product-categor import { FindParams } from "../../../../types/common" /** - * @oas [post] /product-categories + * @oas [post] /admin/product-categories * operationId: "PostProductCategories" * summary: "Create a Product Category" * description: "Creates a Product Category." diff --git a/packages/medusa/src/api/routes/admin/product-categories/delete-product-category.ts b/packages/medusa/src/api/routes/admin/product-categories/delete-product-category.ts index ae62f0c7ea..33ae033e1d 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/delete-product-category.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/delete-product-category.ts @@ -4,7 +4,7 @@ import { EntityManager } from "typeorm" import { ProductCategoryService } from "../../../../services" /** - * @oas [delete] /product-categories/{id} + * @oas [delete] /admin/product-categories/{id} * operationId: "DeleteProductCategoriesCategory" * summary: "Delete a Product Category" * description: "Deletes a ProductCategory." diff --git a/packages/medusa/src/api/routes/admin/product-categories/delete-products-batch.ts b/packages/medusa/src/api/routes/admin/product-categories/delete-products-batch.ts index 95a05e78b1..ea67647ccc 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/delete-products-batch.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/delete-products-batch.ts @@ -8,7 +8,7 @@ import { Type } from "class-transformer" import { FindParams } from "../../../../types/common" /** - * @oas [delete] /product-categories/{id}/products/batch + * @oas [delete] /admin/product-categories/{id}/products/batch * operationId: "DeleteProductCategoriesCategoryProductsBatch" * summary: "Delete Products" * description: "Remove a list of products from a product category." diff --git a/packages/medusa/src/api/routes/admin/product-categories/get-product-category.ts b/packages/medusa/src/api/routes/admin/product-categories/get-product-category.ts index d7a8a75a7a..997d74d7dd 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/get-product-category.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/get-product-category.ts @@ -5,7 +5,7 @@ import { FindParams } from "../../../../types/common" import { defaultAdminProductCategoryRelations } from "." /** - * @oas [get] /product-categories/{id} + * @oas [get] /admin/product-categories/{id} * operationId: "GetProductCategoriesCategory" * summary: "Get a Product Category" * description: "Retrieves a Product Category." diff --git a/packages/medusa/src/api/routes/admin/product-categories/list-product-categories.ts b/packages/medusa/src/api/routes/admin/product-categories/list-product-categories.ts index d357458074..705f37d187 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/list-product-categories.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/list-product-categories.ts @@ -6,7 +6,7 @@ import { ProductCategoryService } from "../../../../services" import { extendedFindParamsMixin } from "../../../../types/common" /** - * @oas [get] /product-categories + * @oas [get] /admin/product-categories * operationId: "GetProductCategories" * summary: "List Product Categories" * description: "Retrieve a list of product categories." diff --git a/packages/medusa/src/api/routes/admin/product-categories/update-product-category.ts b/packages/medusa/src/api/routes/admin/product-categories/update-product-category.ts index 5ce615ea23..09ba00930c 100644 --- a/packages/medusa/src/api/routes/admin/product-categories/update-product-category.ts +++ b/packages/medusa/src/api/routes/admin/product-categories/update-product-category.ts @@ -7,7 +7,7 @@ import { AdminProductCategoriesReqBase } from "../../../../types/product-categor import { FindParams } from "../../../../types/common" /** - * @oas [post] /product-categories/{id} + * @oas [post] /admin/product-categories/{id} * operationId: "PostProductCategoriesCategory" * summary: "Update a Product Category" * description: "Updates a Product Category." 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 0ffdb5bd63..8839e16eb3 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 @@ -10,7 +10,7 @@ import { Type } from "class-transformer" import { Request, Response } from "express" /** - * @oas [get] /product-tags + * @oas [get] /admin/product-tags * operationId: "GetProductTags" * summary: "List Product Tags" * description: "Retrieve a list of Product Tags." 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 29f0120be6..bc49038736 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 @@ -9,7 +9,7 @@ import { IsType } from "../../../../utils/validators/is-type" import ProductTypeService from "../../../../services/product-type" /** - * @oas [get] /product-types + * @oas [get] /admin/product-types * operationId: "GetProductTypes" * summary: "List Product Types" * description: "Retrieve a list of Product Types." 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 d4e4d3ab5f..be01d3216e 100644 --- a/packages/medusa/src/api/routes/admin/products/add-option.ts +++ b/packages/medusa/src/api/routes/admin/products/add-option.ts @@ -6,7 +6,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /products/{id}/options + * @oas [post] /admin/products/{id}/options * operationId: "PostProductsProductOptions" * summary: "Add an Option" * x-authenticated: true 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 a713953003..429594055d 100644 --- a/packages/medusa/src/api/routes/admin/products/create-product.ts +++ b/packages/medusa/src/api/routes/admin/products/create-product.ts @@ -18,8 +18,8 @@ import { ShippingProfileService, } from "../../../../services" import { - ProductSalesChannelReq, ProductProductCategoryReq, + ProductSalesChannelReq, ProductTagReq, ProductTypeReq, } from "../../../../types/product" @@ -44,7 +44,7 @@ import { DistributedTransaction } from "../../../../utils/transaction" import { Logger } from "../../../../types/global" /** - * @oas [post] /products + * @oas [post] /admin/products * operationId: "PostProducts" * summary: "Create a Product" * x-authenticated: true 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 c48f7b5f95..4b5babbc52 100644 --- a/packages/medusa/src/api/routes/admin/products/create-variant.ts +++ b/packages/medusa/src/api/routes/admin/products/create-variant.ts @@ -10,8 +10,8 @@ import { import { Type } from "class-transformer" import { ProductService, - ProductVariantService, ProductVariantInventoryService, + ProductVariantService, } from "../../../../services" import { defaultAdminProductFields, defaultAdminProductRelations } from "." @@ -27,7 +27,7 @@ import { EntityManager } from "typeorm" import { createVariantTransaction } from "./transaction/create-product-variant" /** - * @oas [post] /products/{id}/variants + * @oas [post] /admin/products/{id}/variants * operationId: "PostProductsProductVariants" * summary: "Create a Product Variant" * description: "Creates a Product Variant. Each Product Variant must have a unique combination of Product Option Values." 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 b989c4a55d..23da68cc88 100644 --- a/packages/medusa/src/api/routes/admin/products/delete-option.ts +++ b/packages/medusa/src/api/routes/admin/products/delete-option.ts @@ -4,7 +4,7 @@ import { EntityManager } from "typeorm" import { ProductService } from "../../../../services" /** - * @oas [delete] /products/{id}/options/{option_id} + * @oas [delete] /admin/products/{id}/options/{option_id} * operationId: "DeleteProductsProductOptionsOption" * summary: "Delete a Product Option" * description: "Deletes a Product Option. Before a Product Option can be deleted all Option Values for the Product Option must be the same. You may, for example, have to delete some of your variants prior to deleting the Product Option" diff --git a/packages/medusa/src/api/routes/admin/products/delete-product.ts b/packages/medusa/src/api/routes/admin/products/delete-product.ts index 2358cbcaf8..23fc0cc32d 100644 --- a/packages/medusa/src/api/routes/admin/products/delete-product.ts +++ b/packages/medusa/src/api/routes/admin/products/delete-product.ts @@ -2,7 +2,7 @@ import { EntityManager } from "typeorm" import { ProductService } from "../../../../services" /** - * @oas [delete] /products/{id} + * @oas [delete] /admin/products/{id} * operationId: "DeleteProductsProduct" * summary: "Delete a Product" * description: "Deletes a Product and it's associated Product Variants." 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 0e6635f88c..392c504cf3 100644 --- a/packages/medusa/src/api/routes/admin/products/delete-variant.ts +++ b/packages/medusa/src/api/routes/admin/products/delete-variant.ts @@ -8,7 +8,7 @@ import { defaultAdminProductFields, defaultAdminProductRelations } from "." import { EntityManager } from "typeorm" /** - * @oas [delete] /products/{id}/variants/{variant_id} + * @oas [delete] /admin/products/{id}/variants/{variant_id} * operationId: "DeleteProductsProductVariantsVariant" * summary: "Delete a Product Variant" * description: "Deletes a Product Variant." 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 21eff65ae1..2ad146bb41 100644 --- a/packages/medusa/src/api/routes/admin/products/get-product.ts +++ b/packages/medusa/src/api/routes/admin/products/get-product.ts @@ -1,7 +1,7 @@ import { PricingService, ProductService } from "../../../../services" /** - * @oas [get] /products/{id} + * @oas [get] /admin/products/{id} * operationId: "GetProductsProduct" * summary: "Get a Product" * description: "Retrieves a Product." 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 c71c2af809..ee4968f2a8 100644 --- a/packages/medusa/src/api/routes/admin/products/list-products.ts +++ b/packages/medusa/src/api/routes/admin/products/list-products.ts @@ -7,7 +7,7 @@ import { PricedProduct } from "../../../../types/pricing" import { FilterableProductProps } from "../../../../types/product" /** - * @oas [get] /products + * @oas [get] /admin/products * operationId: "GetProducts" * summary: "List Products" * description: "Retrieves a list of Product" diff --git a/packages/medusa/src/api/routes/admin/products/list-tag-usage-count.ts b/packages/medusa/src/api/routes/admin/products/list-tag-usage-count.ts index 0bc6aa9ce1..b400ec39d3 100644 --- a/packages/medusa/src/api/routes/admin/products/list-tag-usage-count.ts +++ b/packages/medusa/src/api/routes/admin/products/list-tag-usage-count.ts @@ -1,7 +1,7 @@ import { ProductService } from "../../../../services" /** - * @oas [get] /products/tag-usage + * @oas [get] /admin/products/tag-usage * operationId: "GetProductsTagUsage" * summary: "List Tags Usage Number" * description: "Retrieves a list of Product Tags with how many times each is used." 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 9d99d4bf14..ec7cdf5005 100644 --- a/packages/medusa/src/api/routes/admin/products/list-types.ts +++ b/packages/medusa/src/api/routes/admin/products/list-types.ts @@ -1,7 +1,7 @@ import { ProductService } from "../../../../services" /** - * @oas [get] /products/types + * @oas [get] /admin/products/types * deprecated: true * operationId: "GetProductsTypes" * summary: "List Product Types" 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 33d9ee1408..a983ccaaaa 100644 --- a/packages/medusa/src/api/routes/admin/products/list-variants.ts +++ b/packages/medusa/src/api/routes/admin/products/list-variants.ts @@ -9,7 +9,7 @@ import { getRetrieveConfig } from "../../../../utils/get-query-config" import { validator } from "../../../../utils/validator" /** - * @oas [get] /products/{id}/variants + * @oas [get] /admin/products/{id}/variants * operationId: "GetProductsProductVariants" * summary: "List a Product's Variants" * description: "Retrieves a list of the Product Variants associated with a Product." 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 4041165468..98cda94e21 100644 --- a/packages/medusa/src/api/routes/admin/products/set-metadata.ts +++ b/packages/medusa/src/api/routes/admin/products/set-metadata.ts @@ -5,7 +5,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /products/{id}/metadata + * @oas [post] /admin/products/{id}/metadata * operationId: "PostProductsProductMetadata" * summary: "Set Product Metadata" * description: "Set metadata key/value pair for Product" 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 467205ecf6..eace1bd30b 100644 --- a/packages/medusa/src/api/routes/admin/products/update-option.ts +++ b/packages/medusa/src/api/routes/admin/products/update-option.ts @@ -6,7 +6,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /products/{id}/options/{option_id} + * @oas [post] /admin/products/{id}/options/{option_id} * operationId: "PostProductsProductOptionsOption" * summary: "Update a Product Option" * description: "Updates a Product Option" 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 25a0feda20..dfa23a425b 100644 --- a/packages/medusa/src/api/routes/admin/products/update-product.ts +++ b/packages/medusa/src/api/routes/admin/products/update-product.ts @@ -19,16 +19,16 @@ import { ProductVariantService, } from "../../../../services" import { + ProductProductCategoryReq, ProductSalesChannelReq, ProductTagReq, ProductTypeReq, - ProductProductCategoryReq, } from "../../../../types/product" import { Type } from "class-transformer" import { EntityManager } from "typeorm" import SalesChannelFeatureFlag from "../../../../loaders/feature-flags/sales-channels" -import { ProductStatus, ProductVariant } from "../../../../models" +import { ProductStatus } from "../../../../models" import { CreateProductVariantInput, ProductVariantPricesUpdateReq, @@ -45,7 +45,7 @@ import { IInventoryService } from "../../../../interfaces" import { Logger } from "../../../../types/global" /** - * @oas [post] /products/{id} + * @oas [post] /admin/products/{id} * operationId: "PostProductsProduct" * summary: "Update a Product" * description: "Updates a Product" 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 28ef0767f2..b05da53878 100644 --- a/packages/medusa/src/api/routes/admin/products/update-variant.ts +++ b/packages/medusa/src/api/routes/admin/products/update-variant.ts @@ -21,7 +21,7 @@ import { ProductVariantPricesUpdateReq } from "../../../../types/product-variant import { validator } from "../../../../utils/validator" /** - * @oas [post] /products/{id}/variants/{variant_id} + * @oas [post] /admin/products/{id}/variants/{variant_id} * operationId: "PostProductsProductVariantsVariant" * summary: "Update a Product Variant" * description: "Update a Product Variant." 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 e5b3ec0217..ebd774a68c 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 @@ -7,7 +7,7 @@ import { ProductBatchSalesChannel } from "../../../../types/sales-channels" import PublishableApiKeyService from "../../../../services/publishable-api-key" /** - * @oas [post] /publishable-api-keys/{id}/sales-channels/batch + * @oas [post] /admin/publishable-api-keys/{id}/sales-channels/batch * operationId: "PostPublishableApiKeySalesChannelsChannelsBatch" * summary: "Add SalesChannels" * description: "Assign a batch of sales channels to a publishable api key." 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 4d9ccb6a89..0d94d9bf0f 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 @@ -5,7 +5,7 @@ import { IsString } from "class-validator" import PublishableApiKeyService from "../../../../services/publishable-api-key" /** - * @oas [post] /publishable-api-keys + * @oas [post] /admin/publishable-api-keys * operationId: "PostPublishableApiKeys" * summary: "Create PublishableApiKey" * description: "Creates a PublishableApiKey." 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 4634003c7e..b69f4e2b6a 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 @@ -7,7 +7,7 @@ import { ProductBatchSalesChannel } from "../../../../types/sales-channels" import PublishableApiKeyService from "../../../../services/publishable-api-key" /** - * @oas [delete] /publishable-api-keys/{id}/sales-channels/batch + * @oas [delete] /admin/publishable-api-keys/{id}/sales-channels/batch * operationId: "DeletePublishableApiKeySalesChannelsChannelsBatch" * summary: "Delete SalesChannels" * description: "Remove a batch of sales channels from a publishable api key." diff --git a/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-publishable-api-key.ts b/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-publishable-api-key.ts index a576e17be3..40e9c0bf2e 100644 --- a/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-publishable-api-key.ts +++ b/packages/medusa/src/api/routes/admin/publishable-api-keys/delete-publishable-api-key.ts @@ -3,7 +3,7 @@ import { EntityManager } from "typeorm" import PublishableApiKeyService from "../../../../services/publishable-api-key" /** - * @oas [delete] /publishable-api-keys/{id} + * @oas [delete] /admin/publishable-api-keys/{id} * operationId: "DeletePublishableApiKeysPublishableApiKey" * summary: "Delete PublishableApiKey" * description: "Deletes a PublishableApiKeys" 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 28d34363b5..1c03e6d1d6 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 @@ -3,7 +3,7 @@ import { Request, Response } from "express" import PublishableApiKeyService from "../../../../services/publishable-api-key" /** - * @oas [get] /publishable-api-keys/{id} + * @oas [get] /admin/publishable-api-keys/{id} * operationId: "GetPublishableApiKeysPublishableApiKey" * summary: "Get a PublishableApiKey" * description: "Retrieve the Publishable Api Key." 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 8dfaba9871..b67d8d55fc 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 @@ -5,7 +5,7 @@ import PublishableApiKeyService from "../../../../services/publishable-api-key" import { extendedFindParamsMixin } from "../../../../types/common" /** - * @oas [get] /publishable-api-keys/{id}/sales-channels + * @oas [get] /admin/publishable-api-keys/{id}/sales-channels * operationId: "GetPublishableApiKeySalesChannels" * summary: "List SalesChannels" * description: "List PublishableApiKey's SalesChannels" 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 8f3a4e3141..edc92db092 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 @@ -5,7 +5,7 @@ import { extendedFindParamsMixin } from "../../../../types/common" import PublishableApiKeyService from "../../../../services/publishable-api-key" /** - * @oas [get] /publishable-api-keys + * @oas [get] /admin/publishable-api-keys * operationId: "GetPublishableApiKeys" * summary: "List PublishableApiKeys" * description: "List PublishableApiKeys." 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 f6c0ef9de7..ecfedeb4d3 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 @@ -4,7 +4,7 @@ import { EntityManager } from "typeorm" import PublishableApiKeyService from "../../../../services/publishable-api-key" /** - * @oas [post] /publishable-api-keys/{id}/revoke + * @oas [post] /admin/publishable-api-keys/{id}/revoke * operationId: "PostPublishableApiKeysPublishableApiKeyRevoke" * summary: "Revoke PublishableApiKey" * description: "Revokes a PublishableApiKey." 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 d71ed8f3af..a7cbdf0a50 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 @@ -5,7 +5,7 @@ import { EntityManager } from "typeorm" import PublishableApiKeyService from "../../../../services/publishable-api-key" /** - * @oas [post] /publishable-api-key/{id} + * @oas [post] /admin/publishable-api-key/{id} * operationId: "PostPublishableApiKysPublishableApiKey" * summary: "Update PublishableApiKey" * description: "Updates a PublishableApiKey." 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 ac49e925ed..31846bfc0e 100644 --- a/packages/medusa/src/api/routes/admin/regions/add-country.ts +++ b/packages/medusa/src/api/routes/admin/regions/add-country.ts @@ -7,7 +7,7 @@ import RegionService from "../../../../services/region" import { validator } from "../../../../utils/validator" /** - * @oas [post] /regions/{id}/countries + * @oas [post] /admin/regions/{id}/countries * operationId: "PostRegionsRegionCountries" * summary: "Add Country" * description: "Adds a Country to the list of Countries in a Region" 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 0aec86ce6f..9304e0b001 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 @@ -7,7 +7,7 @@ import RegionService from "../../../../services/region" import { validator } from "../../../../utils/validator" /** - * @oas [post] /regions/{id}/fulfillment-providers + * @oas [post] /admin/regions/{id}/fulfillment-providers * operationId: "PostRegionsRegionFulfillmentProviders" * summary: "Add Fulfillment Provider" * description: "Adds a Fulfillment Provider to a Region" 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 5908b37acb..dbf33e67d3 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 @@ -7,7 +7,7 @@ import RegionService from "../../../../services/region" import { validator } from "../../../../utils/validator" /** - * @oas [post] /regions/{id}/payment-providers + * @oas [post] /admin/regions/{id}/payment-providers * operationId: "PostRegionsRegionPaymentProviders" * summary: "Add Payment Provider" * description: "Adds a Payment Provider to a Region" 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 f5811adaad..fd1a2389c2 100644 --- a/packages/medusa/src/api/routes/admin/regions/create-region.ts +++ b/packages/medusa/src/api/routes/admin/regions/create-region.ts @@ -15,7 +15,7 @@ import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators import { validator } from "../../../../utils/validator" /** - * @oas [post] /regions + * @oas [post] /admin/regions * operationId: "PostRegions" * summary: "Create a Region" * description: "Creates a Region" diff --git a/packages/medusa/src/api/routes/admin/regions/delete-region.ts b/packages/medusa/src/api/routes/admin/regions/delete-region.ts index 2e9e0a402d..fa055e0d25 100644 --- a/packages/medusa/src/api/routes/admin/regions/delete-region.ts +++ b/packages/medusa/src/api/routes/admin/regions/delete-region.ts @@ -2,7 +2,7 @@ import { EntityManager } from "typeorm" import RegionService from "../../../../services/region" /** - * @oas [delete] /regions/{id} + * @oas [delete] /admin/regions/{id} * operationId: "DeleteRegionsRegion" * summary: "Delete a Region" * description: "Deletes a Region." diff --git a/packages/medusa/src/api/routes/admin/regions/get-fulfillment-options.ts b/packages/medusa/src/api/routes/admin/regions/get-fulfillment-options.ts index 2f452fb3aa..5843c20fa4 100644 --- a/packages/medusa/src/api/routes/admin/regions/get-fulfillment-options.ts +++ b/packages/medusa/src/api/routes/admin/regions/get-fulfillment-options.ts @@ -3,7 +3,7 @@ import FulfillmentProviderService from "../../../../services/fulfillment-provide import RegionService from "../../../../services/region" /** - * @oas [get] /regions/{id}/fulfillment-options + * @oas [get] /admin/regions/{id}/fulfillment-options * operationId: "GetRegionsRegionFulfillmentOptions" * summary: "List Fulfillment Options" * description: "Gathers all the fulfillment options available to in the Region." 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 98e7c47a76..9d17db6c6f 100644 --- a/packages/medusa/src/api/routes/admin/regions/get-region.ts +++ b/packages/medusa/src/api/routes/admin/regions/get-region.ts @@ -3,7 +3,7 @@ import { defaultAdminRegionFields, defaultAdminRegionRelations } from "." import RegionService from "../../../../services/region" /** - * @oas [get] /regions/{id} + * @oas [get] /admin/regions/{id} * operationId: "GetRegionsRegion" * summary: "Get a Region" * description: "Retrieves a Region." 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 8b1179d963..5a85d71588 100644 --- a/packages/medusa/src/api/routes/admin/regions/list-regions.ts +++ b/packages/medusa/src/api/routes/admin/regions/list-regions.ts @@ -9,7 +9,7 @@ import { Type } from "class-transformer" import { validator } from "../../../../utils/validator" /** - * @oas [get] /regions + * @oas [get] /admin/regions * operationId: "GetRegions" * summary: "List Regions" * description: "Retrieves a list of Regions." 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 9a25ebfdbc..243734c5f5 100644 --- a/packages/medusa/src/api/routes/admin/regions/remove-country.ts +++ b/packages/medusa/src/api/routes/admin/regions/remove-country.ts @@ -4,7 +4,7 @@ import { EntityManager } from "typeorm" import RegionService from "../../../../services/region" /** - * @oas [delete] /regions/{id}/countries/{country_code} + * @oas [delete] /admin/regions/{id}/countries/{country_code} * operationId: "PostRegionsRegionCountriesCountry" * summary: "Delete Country" * x-authenticated: true 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 f6634b4804..ce4880afe5 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 @@ -4,7 +4,7 @@ import { EntityManager } from "typeorm" import RegionService from "../../../../services/region" /** - * @oas [delete] /regions/{id}/fulfillment-providers/{provider_id} + * @oas [delete] /admin/regions/{id}/fulfillment-providers/{provider_id} * operationId: "PostRegionsRegionFulfillmentProvidersProvider" * summary: "Del. Fulfillment Provider" * description: "Removes a Fulfillment Provider." 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 35719c27ab..67a59ebe70 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 @@ -4,7 +4,7 @@ import { EntityManager } from "typeorm" import RegionService from "../../../../services/region" /** - * @oas [delete] /regions/{id}/payment-providers/{provider_id} + * @oas [delete] /admin/regions/{id}/payment-providers/{provider_id} * operationId: "PostRegionsRegionPaymentProvidersProvider" * summary: "Delete Payment Provider" * description: "Removes a Payment Provider." 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 443dd7a276..df5c0745b6 100644 --- a/packages/medusa/src/api/routes/admin/regions/update-region.ts +++ b/packages/medusa/src/api/routes/admin/regions/update-region.ts @@ -15,7 +15,7 @@ import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators import { validator } from "../../../../utils/validator" /** - * @oas [post] /regions/{id} + * @oas [post] /admin/regions/{id} * operationId: "PostRegionsRegion" * summary: "Update a Region" * description: "Updates a Region" diff --git a/packages/medusa/src/api/routes/admin/reservations/create-reservation.ts b/packages/medusa/src/api/routes/admin/reservations/create-reservation.ts index c5e3d50ba2..a0eb321480 100644 --- a/packages/medusa/src/api/routes/admin/reservations/create-reservation.ts +++ b/packages/medusa/src/api/routes/admin/reservations/create-reservation.ts @@ -3,7 +3,7 @@ import { EntityManager } from "typeorm" import { IInventoryService } from "../../../../interfaces" /** - * @oas [post] /reservations + * @oas [post] /admin/reservations * operationId: "PostReservations" * summary: "Creates a Reservation" * description: "Creates a Reservation which can be associated with any resource as required." diff --git a/packages/medusa/src/api/routes/admin/reservations/delete-reservation.ts b/packages/medusa/src/api/routes/admin/reservations/delete-reservation.ts index 353ab99177..69d743cc22 100644 --- a/packages/medusa/src/api/routes/admin/reservations/delete-reservation.ts +++ b/packages/medusa/src/api/routes/admin/reservations/delete-reservation.ts @@ -2,7 +2,7 @@ import { EntityManager } from "typeorm" import { IInventoryService } from "../../../../interfaces" /** - * @oas [delete] /reservations/{id} + * @oas [delete] /admin/reservations/{id} * operationId: "DeleteReservationsReservation" * summary: "Delete a Reservation" * description: "Deletes a Reservation." diff --git a/packages/medusa/src/api/routes/admin/reservations/get-reservation.ts b/packages/medusa/src/api/routes/admin/reservations/get-reservation.ts index 3376a65c54..db45a7cf0e 100644 --- a/packages/medusa/src/api/routes/admin/reservations/get-reservation.ts +++ b/packages/medusa/src/api/routes/admin/reservations/get-reservation.ts @@ -2,7 +2,7 @@ import { MedusaError } from "medusa-core-utils" import { IInventoryService } from "../../../../interfaces" /** - * @oas [get] /reservations/{id} + * @oas [get] /admin/reservations/{id} * operationId: "GetReservationsReservation" * summary: "Get a Reservation" * description: "Retrieves a single reservation using its id" diff --git a/packages/medusa/src/api/routes/admin/reservations/list-reservations.ts b/packages/medusa/src/api/routes/admin/reservations/list-reservations.ts index 48e69043a0..1736e3147d 100644 --- a/packages/medusa/src/api/routes/admin/reservations/list-reservations.ts +++ b/packages/medusa/src/api/routes/admin/reservations/list-reservations.ts @@ -8,7 +8,7 @@ import { } from "../../../../types/common" /** - * @oas [get] /reservations + * @oas [get] /admin/reservations * operationId: "GetReservations" * summary: "List Reservations" * description: "Retrieve a list of Reservations." diff --git a/packages/medusa/src/api/routes/admin/reservations/update-reservation.ts b/packages/medusa/src/api/routes/admin/reservations/update-reservation.ts index b845ff450d..8651896f6a 100644 --- a/packages/medusa/src/api/routes/admin/reservations/update-reservation.ts +++ b/packages/medusa/src/api/routes/admin/reservations/update-reservation.ts @@ -3,7 +3,7 @@ import { EntityManager } from "typeorm" import { IInventoryService } from "../../../../interfaces" /** - * @oas [post] /reservations/{id} + * @oas [post] /admin/reservations/{id} * operationId: "PostReservationsReservation" * summary: "Updates a Reservation" * description: "Updates a Reservation which can be associated with any resource as required." 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 05fed737c7..cfa8571e97 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 @@ -9,7 +9,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /return-reasons + * @oas [post] /admin/return-reasons * operationId: "PostReturnReasons" * summary: "Create a Return Reason" * description: "Creates a Return Reason" diff --git a/packages/medusa/src/api/routes/admin/return-reasons/delete-reason.ts b/packages/medusa/src/api/routes/admin/return-reasons/delete-reason.ts index b79d56e01e..41a6cde9a7 100644 --- a/packages/medusa/src/api/routes/admin/return-reasons/delete-reason.ts +++ b/packages/medusa/src/api/routes/admin/return-reasons/delete-reason.ts @@ -2,7 +2,7 @@ import { EntityManager } from "typeorm" import { ReturnReasonService } from "../../../../services" /** - * @oas [delete] /return-reasons/{id} + * @oas [delete] /admin/return-reasons/{id} * operationId: "DeleteReturnReason" * summary: "Delete a Return Reason" * description: "Deletes a return reason." 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 81e4b25dc3..ffffdd031a 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 @@ -6,7 +6,7 @@ import { import { ReturnReasonService } from "../../../../services" /** - * @oas [get] /return-reasons/{id} + * @oas [get] /admin/return-reasons/{id} * operationId: "GetReturnReasonsReason" * summary: "Get a Return Reason" * description: "Retrieves a Return Reason." 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 d25616b219..c742b189a7 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 @@ -7,7 +7,7 @@ import { ReturnReasonService } from "../../../../services" import { Selector } from "../../../../types/common" /** - * @oas [get] /return-reasons + * @oas [get] /admin/return-reasons * operationId: "GetReturnReasons" * summary: "List Return Reasons" * description: "Retrieves a list of Return Reasons." 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 b76b3b4c77..e4e0ff3cea 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 @@ -9,7 +9,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /return-reasons/{id} + * @oas [post] /admin/return-reasons/{id} * operationId: "PostReturnReasonsReason" * summary: "Update a Return Reason" * description: "Updates a Return Reason" 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 0214242362..99985c22ce 100644 --- a/packages/medusa/src/api/routes/admin/returns/cancel-return.ts +++ b/packages/medusa/src/api/routes/admin/returns/cancel-return.ts @@ -6,7 +6,7 @@ import { import { EntityManager } from "typeorm" /** - * @oas [post] /returns/{id}/cancel + * @oas [post] /admin/returns/{id}/cancel * operationId: "PostReturnsReturnCancel" * summary: "Cancel a Return" * description: "Registers a Return as canceled." 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 fd84fcc226..38a6c45f42 100644 --- a/packages/medusa/src/api/routes/admin/returns/list-returns.ts +++ b/packages/medusa/src/api/routes/admin/returns/list-returns.ts @@ -7,7 +7,7 @@ import { FindConfig } from "../../../../types/common" import { Return } from "../../../../models" /** - * @oas [get] /returns + * @oas [get] /admin/returns * operationId: "GetReturns" * summary: "List Returns" * description: "Retrieves a list of Returns" 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 c5d5a02871..61683324b0 100644 --- a/packages/medusa/src/api/routes/admin/returns/receive-return.ts +++ b/packages/medusa/src/api/routes/admin/returns/receive-return.ts @@ -13,7 +13,7 @@ import { validator } from "../../../../utils/validator" import { isDefined } from "medusa-core-utils" /** - * @oas [post] /returns/{id}/receive + * @oas [post] /admin/returns/{id}/receive * operationId: "PostReturnsReturnReceive" * summary: "Receive a Return" * description: "Registers a Return as received. Updates statuses on Orders and Swaps accordingly." 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 1c661941c2..4b98a0a93b 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 @@ -7,7 +7,7 @@ import { SalesChannelService } from "../../../../services" import { Type } from "class-transformer" /** - * @oas [post] /sales-channels/{id}/products/batch + * @oas [post] /admin/sales-channels/{id}/products/batch * operationId: "PostSalesChannelsChannelProductsBatch" * summary: "Add Products" * description: "Assign a batch of product to a sales channel." diff --git a/packages/medusa/src/api/routes/admin/sales-channels/associate-stock-location.ts b/packages/medusa/src/api/routes/admin/sales-channels/associate-stock-location.ts index f324604ef0..dfdae57695 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/associate-stock-location.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/associate-stock-location.ts @@ -8,7 +8,7 @@ import { } from "../../../../services" /** - * @oas [post] /sales-channels/{id}/stock-locations + * @oas [post] /admin/sales-channels/{id}/stock-locations * operationId: "PostSalesChannelsSalesChannelStockLocation" * summary: "Associate a stock location to a Sales Channel" * description: "Associates a stock location to a Sales Channel." 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 25b3b25748..1ff43a1fdb 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 @@ -6,7 +6,7 @@ import { EntityManager } from "typeorm" import SalesChannelService from "../../../../services/sales-channel" /** - * @oas [post] /sales-channels + * @oas [post] /admin/sales-channels * operationId: "PostSalesChannels" * summary: "Create a Sales Channel" * description: "Creates a Sales Channel." 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 6f70b12f82..9993a7f77e 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 @@ -7,7 +7,7 @@ import { SalesChannelService } from "../../../../services" import { Type } from "class-transformer" /** - * @oas [delete] /sales-channels/{id}/products/batch + * @oas [delete] /admin/sales-channels/{id}/products/batch * operationId: "DeleteSalesChannelsChannelProductsBatch" * summary: "Delete Products" * description: "Remove a list of products from a sales channel." diff --git a/packages/medusa/src/api/routes/admin/sales-channels/delete-sales-channel.ts b/packages/medusa/src/api/routes/admin/sales-channels/delete-sales-channel.ts index cf13919561..98c2c28f74 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/delete-sales-channel.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/delete-sales-channel.ts @@ -4,7 +4,7 @@ import { EntityManager } from "typeorm" import { SalesChannelService } from "../../../../services/" /** - * @oas [delete] /sales-channels/{id} + * @oas [delete] /admin/sales-channels/{id} * operationId: "DeleteSalesChannelsSalesChannel" * summary: "Delete a Sales Channel" * description: "Deletes the sales channel." 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 f727b85716..c24f2b2b45 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 @@ -3,7 +3,7 @@ import { Request, Response } from "express" import { SalesChannelService } from "../../../../services" /** - * @oas [get] /sales-channels/{id} + * @oas [get] /admin/sales-channels/{id} * operationId: "GetSalesChannelsSalesChannel" * summary: "Get a Sales Channel" * description: "Retrieves the sales channel." 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 008e6fd01d..9f905a3228 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 @@ -9,7 +9,7 @@ import { SalesChannelService } from "../../../../services" import { Type } from "class-transformer" /** - * @oas [get] /sales-channels + * @oas [get] /admin/sales-channels * operationId: "GetSalesChannels" * summary: "List Sales Channels" * description: "Retrieves a list of sales channels" diff --git a/packages/medusa/src/api/routes/admin/sales-channels/remove-stock-location.ts b/packages/medusa/src/api/routes/admin/sales-channels/remove-stock-location.ts index 8af6c12f82..faf33efb8d 100644 --- a/packages/medusa/src/api/routes/admin/sales-channels/remove-stock-location.ts +++ b/packages/medusa/src/api/routes/admin/sales-channels/remove-stock-location.ts @@ -5,7 +5,7 @@ import { EntityManager } from "typeorm" import { SalesChannelLocationService } from "../../../../services" /** - * @oas [delete] /sales-channels/{id}/stock-locations + * @oas [delete] /admin/sales-channels/{id}/stock-locations * operationId: "DeleteSalesChannelsSalesChannelStockLocation" * summary: "Remove a stock location from a Sales Channel" * description: "Removes a stock location from a Sales Channel." 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 5471f166a3..9f1eac00dd 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 @@ -5,7 +5,7 @@ import { SalesChannelService } from "../../../../services" import { EntityManager } from "typeorm" /** - * @oas [post] /sales-channels/{id} + * @oas [post] /admin/sales-channels/{id} * operationId: "PostSalesChannelsSalesChannel" * summary: "Update a Sales Channel" * description: "Updates a Sales Channel." 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 6b510b02af..7db8bcfe90 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 @@ -16,7 +16,7 @@ import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators import { validator } from "../../../../utils/validator" /** - * @oas [post] /shipping-options + * @oas [post] /admin/shipping-options * operationId: "PostShippingOptions" * summary: "Create Shipping Option" * description: "Creates a Shipping Option" diff --git a/packages/medusa/src/api/routes/admin/shipping-options/delete-shipping-option.ts b/packages/medusa/src/api/routes/admin/shipping-options/delete-shipping-option.ts index 61a25d1467..4eeee95a89 100644 --- a/packages/medusa/src/api/routes/admin/shipping-options/delete-shipping-option.ts +++ b/packages/medusa/src/api/routes/admin/shipping-options/delete-shipping-option.ts @@ -1,7 +1,7 @@ import { EntityManager } from "typeorm" /** - * @oas [delete] /shipping-options/{id} + * @oas [delete] /admin/shipping-options/{id} * operationId: "DeleteShippingOptionsOption" * summary: "Delete a Shipping Option" * description: "Deletes a Shipping Option." 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 accee2432f..5379145893 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 @@ -1,5 +1,5 @@ /** - * @oas [get] /shipping-options/{id} + * @oas [get] /admin/shipping-options/{id} * operationId: "GetShippingOptionsOption" * summary: "Get a Shipping Option" * description: "Retrieves a Shipping Option." 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 e22c1e3638..cec2988164 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 @@ -7,7 +7,7 @@ import { optionalBooleanMapper } from "../../../../utils/validators/is-boolean" import { validator } from "../../../../utils/validator" /** - * @oas [get] /shipping-options + * @oas [get] /admin/shipping-options * operationId: "GetShippingOptions" * summary: "List Shipping Options" * description: "Retrieves a list of Shipping Options." 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 eebbe5f999..6357de10fd 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 @@ -18,7 +18,7 @@ import { ShippingOptionService } from "../../../../services" import { UpdateShippingOptionInput } from "../../../../types/shipping-options" /** - * @oas [post] /shipping-options/{id} + * @oas [post] /admin/shipping-options/{id} * operationId: "PostShippingOptionsOption" * summary: "Update Shipping Option" * description: "Updates a Shipping Option" 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 4b53042154..10682880c8 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 @@ -5,7 +5,7 @@ import { ShippingProfileService } from "../../../../services" import { validator } from "../../../../utils/validator" /** - * @oas [post] /shipping-profiles + * @oas [post] /admin/shipping-profiles * operationId: "PostShippingProfiles" * summary: "Create a Shipping Profile" * description: "Creates a Shipping Profile" diff --git a/packages/medusa/src/api/routes/admin/shipping-profiles/delete-shipping-profile.ts b/packages/medusa/src/api/routes/admin/shipping-profiles/delete-shipping-profile.ts index 1638198da3..ca9646c91f 100644 --- a/packages/medusa/src/api/routes/admin/shipping-profiles/delete-shipping-profile.ts +++ b/packages/medusa/src/api/routes/admin/shipping-profiles/delete-shipping-profile.ts @@ -2,7 +2,7 @@ import { EntityManager } from "typeorm" import { ShippingProfileService } from "../../../../services" /** - * @oas [delete] /shipping-profiles/{id} + * @oas [delete] /admin/shipping-profiles/{id} * operationId: "DeleteShippingProfilesProfile" * summary: "Delete a Shipping Profile" * description: "Deletes a Shipping Profile." 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 c21fadc685..1375fe98af 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 @@ -6,7 +6,7 @@ import { import { ShippingProfileService } from "../../../../services" /** - * @oas [get] /shipping-profiles/{id} + * @oas [get] /admin/shipping-profiles/{id} * operationId: "GetShippingProfilesProfile" * summary: "Get a Shipping Profile" * description: "Retrieves a Shipping Profile." 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 254d144f25..d612126202 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 @@ -1,7 +1,7 @@ import { ShippingProfileService } from "../../../../services" /** - * @oas [get] /shipping-profiles + * @oas [get] /admin/shipping-profiles * operationId: "GetShippingProfiles" * summary: "List Shipping Profiles" * description: "Retrieves a list of Shipping Profile." 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 46f4bae74d..3e6107b7c6 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 @@ -12,7 +12,7 @@ import { ShippingProfileService } from "../../../../services" import { validator } from "../../../../utils/validator" /** - * @oas [post] /shipping-profiles/{id} + * @oas [post] /admin/shipping-profiles/{id} * operationId: "PostShippingProfilesProfile" * summary: "Update a Shipping Profile" * description: "Updates a Shipping Profile" diff --git a/packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts b/packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts index f6fc5e97d3..e831f12ee6 100644 --- a/packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts +++ b/packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts @@ -6,7 +6,7 @@ import { IStockLocationService } from "../../../../interfaces" import { FindParams } from "../../../../types/common" /** - * @oas [post] /stock-locations + * @oas [post] /admin/stock-locations * operationId: "PostStockLocations" * summary: "Create a Stock Location" * description: "Creates a Stock Location." diff --git a/packages/medusa/src/api/routes/admin/stock-locations/delete-stock-location.ts b/packages/medusa/src/api/routes/admin/stock-locations/delete-stock-location.ts index 8a9bad21a1..79804eeee0 100644 --- a/packages/medusa/src/api/routes/admin/stock-locations/delete-stock-location.ts +++ b/packages/medusa/src/api/routes/admin/stock-locations/delete-stock-location.ts @@ -3,7 +3,7 @@ import { IStockLocationService } from "../../../../interfaces" import { SalesChannelLocationService } from "../../../../services" /** - * @oas [delete] /stock-locations/{id} + * @oas [delete] /admin/stock-locations/{id} * operationId: "DeleteStockLocationsStockLocation" * summary: "Delete a Stock Location" * description: "Delete a Stock Location" diff --git a/packages/medusa/src/api/routes/admin/stock-locations/get-stock-location.ts b/packages/medusa/src/api/routes/admin/stock-locations/get-stock-location.ts index 3731d752bd..f31883b2e6 100644 --- a/packages/medusa/src/api/routes/admin/stock-locations/get-stock-location.ts +++ b/packages/medusa/src/api/routes/admin/stock-locations/get-stock-location.ts @@ -8,7 +8,7 @@ import { } from "../../../../services" /** - * @oas [get] /stock-locations/{id} + * @oas [get] /admin/stock-locations/{id} * operationId: "GetStockLocationsStockLocation" * summary: "Get a Stock Location" * description: "Retrieves the Stock Location." diff --git a/packages/medusa/src/api/routes/admin/stock-locations/list-stock-locations.ts b/packages/medusa/src/api/routes/admin/stock-locations/list-stock-locations.ts index 2963b22b11..5ab517d247 100644 --- a/packages/medusa/src/api/routes/admin/stock-locations/list-stock-locations.ts +++ b/packages/medusa/src/api/routes/admin/stock-locations/list-stock-locations.ts @@ -11,7 +11,7 @@ import { import { joinSalesChannels } from "./utils/join-sales-channels" /** - * @oas [get] /stock-locations + * @oas [get] /admin/stock-locations * operationId: "GetStockLocations" * summary: "List Stock Locations" * description: "Retrieves a list of stock locations" diff --git a/packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts b/packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts index 920da001c8..79a07261ef 100644 --- a/packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts +++ b/packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts @@ -6,7 +6,7 @@ import { IStockLocationService } from "../../../../interfaces" import { FindParams } from "../../../../types/common" /** - * @oas [post] /stock-locations/{id} + * @oas [post] /admin/stock-locations/{id} * operationId: "PostStockLocationsStockLocation" * summary: "Update a Stock Location" * description: "Updates a Stock Location." 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 64d1d192f7..fd350d608f 100644 --- a/packages/medusa/src/api/routes/admin/store/add-currency.ts +++ b/packages/medusa/src/api/routes/admin/store/add-currency.ts @@ -2,7 +2,7 @@ import { StoreService } from "../../../../services" import { EntityManager } from "typeorm" /** - * @oas [post] /store/currencies/{code} + * @oas [post] /admin/store/currencies/{code} * operationId: "PostStoreCurrenciesCode" * summary: "Add a Currency Code" * description: "Adds a Currency Code to the available currencies." 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 f522bfd419..aa31519326 100644 --- a/packages/medusa/src/api/routes/admin/store/get-store.ts +++ b/packages/medusa/src/api/routes/admin/store/get-store.ts @@ -8,7 +8,7 @@ import { FlagRouter } from "../../../../utils/flag-router" import { ModulesHelper } from "../../../../utils/module-helper" /** - * @oas [get] /store + * @oas [get] /admin/store * operationId: "GetStore" * summary: "Get Store details" * description: "Retrieves the Store details" 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 587715e2aa..bb14683a04 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,7 +1,7 @@ import { PaymentProviderService } from "../../../../services" /** - * @oas [get] /store/payment-providers + * @oas [get] /admin/store/payment-providers * operationId: "GetStorePaymentProviders" * summary: "List Payment Providers" * description: "Retrieves the configured Payment Providers" 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 5fab72633c..e0a4e4b1f3 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 @@ -1,7 +1,7 @@ import { TaxProviderService } from "../../../../services" /** - * @oas [get] /store/tax-providers + * @oas [get] /admin/store/tax-providers * operationId: "GetStoreTaxProviders" * summary: "List Tax Providers" * description: "Retrieves the configured Tax Providers" 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 feef25c363..34dffde139 100644 --- a/packages/medusa/src/api/routes/admin/store/remove-currency.ts +++ b/packages/medusa/src/api/routes/admin/store/remove-currency.ts @@ -2,7 +2,7 @@ import { StoreService } from "../../../../services" import { EntityManager } from "typeorm" /** - * @oas [delete] /store/currencies/{code} + * @oas [delete] /admin/store/currencies/{code} * operationId: "DeleteStoreCurrenciesCode" * summary: "Delete a Currency Code" * description: "Removes a Currency Code from the available currencies." 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 316dccb55d..006f2d633c 100644 --- a/packages/medusa/src/api/routes/admin/store/update-store.ts +++ b/packages/medusa/src/api/routes/admin/store/update-store.ts @@ -5,7 +5,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /store + * @oas [post] /admin/store * operationId: "PostStore" * summary: "Update Store Details" * description: "Updates the Store details" 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 3cdda6d48f..cc13224a3e 100644 --- a/packages/medusa/src/api/routes/admin/swaps/get-swap.ts +++ b/packages/medusa/src/api/routes/admin/swaps/get-swap.ts @@ -3,7 +3,7 @@ import { defaultAdminSwapFields, defaultAdminSwapRelations } from "." import { SwapService } from "../../../../services" /** - * @oas [get] /swaps/{id} + * @oas [get] /admin/swaps/{id} * operationId: "GetSwapsSwap" * summary: "Get a Swap" * description: "Retrieves a Swap." 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 4d1383675b..1337fddebe 100644 --- a/packages/medusa/src/api/routes/admin/swaps/list-swaps.ts +++ b/packages/medusa/src/api/routes/admin/swaps/list-swaps.ts @@ -7,7 +7,7 @@ import { FindConfig } from "../../../../types/common" import { Swap } from "../../../../models" /** - * @oas [get] /swaps + * @oas [get] /admin/swaps * operationId: "GetSwaps" * summary: "List Swaps" * description: "Retrieves a list of Swaps." 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 92855e654a..78e3d0bdaa 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 @@ -7,7 +7,7 @@ import { TaxRateService } from "../../../../services" import { validator } from "../../../../utils/validator" /** - * @oas [post] /tax-rates/{id}/product-types/batch + * @oas [post] /admin/tax-rates/{id}/product-types/batch * operationId: "PostTaxRatesTaxRateProductTypes" * summary: "Add to Product Types" * description: "Associates a Tax Rate with a list of Product Types" 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 de963d7934..425d2168a7 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 @@ -7,7 +7,7 @@ import { TaxRateService } from "../../../../services" import { validator } from "../../../../utils/validator" /** - * @oas [post] /tax-rates/{id}/products/batch + * @oas [post] /admin/tax-rates/{id}/products/batch * operationId: "PostTaxRatesTaxRateProducts" * summary: "Add to Products" * description: "Associates a Tax Rate with a list of Products" 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 1b6c5b6c00..33f0b844c4 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 @@ -7,7 +7,7 @@ import { TaxRateService } from "../../../../services" import { validator } from "../../../../utils/validator" /** - * @oas [post] /tax-rates/{id}/shipping-options/batch + * @oas [post] /admin/tax-rates/{id}/shipping-options/batch * operationId: "PostTaxRatesTaxRateShippingOptions" * summary: "Add to Shipping Options" * description: "Associates a Tax Rate with a list of Shipping Options" 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 af639d2397..c4234daa53 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 @@ -10,7 +10,7 @@ import { omit } from "lodash" import { validator } from "../../../../utils/validator" /** - * @oas [post] /tax-rates + * @oas [post] /admin/tax-rates * operationId: "PostTaxRates" * summary: "Create a Tax Rate" * description: "Creates a Tax Rate" diff --git a/packages/medusa/src/api/routes/admin/tax-rates/delete-tax-rate.ts b/packages/medusa/src/api/routes/admin/tax-rates/delete-tax-rate.ts index ea4a9666bc..d6e8f21341 100644 --- a/packages/medusa/src/api/routes/admin/tax-rates/delete-tax-rate.ts +++ b/packages/medusa/src/api/routes/admin/tax-rates/delete-tax-rate.ts @@ -2,7 +2,7 @@ import { EntityManager } from "typeorm" import { TaxRateService } from "../../../../services" /** - * @oas [delete] /tax-rates/{id} + * @oas [delete] /admin/tax-rates/{id} * operationId: "DeleteTaxRatesTaxRate" * summary: "Delete a Tax Rate" * description: "Deletes a Tax Rate" 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 ca77442ac0..408a01921c 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 @@ -6,7 +6,7 @@ import { TaxRateService } from "../../../../services" import { validator } from "../../../../utils/validator" /** - * @oas [get] /tax-rates/{id} + * @oas [get] /admin/tax-rates/{id} * operationId: "GetTaxRatesTaxRate" * summary: "Get a Tax Rate" * description: "Retrieves a TaxRate" 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 632c48e3c2..34b31a2243 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 @@ -10,7 +10,7 @@ import { Type } from "class-transformer" import { validator } from "../../../../utils/validator" /** - * @oas [get] /tax-rates + * @oas [get] /admin/tax-rates * operationId: "GetTaxRates" * summary: "List Tax Rates" * description: "Retrieves a list of TaxRates" 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 21826f308b..d51997f50b 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 @@ -7,7 +7,7 @@ import { TaxRateService } from "../../../../services" import { validator } from "../../../../utils/validator" /** - * @oas [delete] /tax-rates/{id}/product-types/batch + * @oas [delete] /admin/tax-rates/{id}/product-types/batch * operationId: "DeleteTaxRatesTaxRateProductTypes" * summary: "Delete from Product Types" * description: "Removes a Tax Rate from a list of Product Types" 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 26857f31d6..38f23feab6 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 @@ -7,7 +7,7 @@ import { TaxRateService } from "../../../../services" import { validator } from "../../../../utils/validator" /** - * @oas [delete] /tax-rates/{id}/products/batch + * @oas [delete] /admin/tax-rates/{id}/products/batch * operationId: "DeleteTaxRatesTaxRateProducts" * summary: "Delete from Products" * description: "Removes a Tax Rate from a list of Products" 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 8884706885..4b37e15259 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 @@ -7,7 +7,7 @@ import { TaxRateService } from "../../../../services" import { validator } from "../../../../utils/validator" /** - * @oas [delete] /tax-rates/{id}/shipping-options/batch + * @oas [delete] /admin/tax-rates/{id}/shipping-options/batch * operationId: "DeleteTaxRatesTaxRateShippingOptions" * summary: "Del. for Shipping Options" * description: "Removes a Tax Rate from a list of Shipping Options" 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 8098284102..7e6a22087c 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 @@ -10,7 +10,7 @@ import { validator } from "../../../../utils/validator" import { isDefined } from "medusa-core-utils" /** - * @oas [post] /tax-rates/{id} + * @oas [post] /admin/tax-rates/{id} * operationId: "PostTaxRatesTaxRate" * summary: "Update a Tax Rate" * description: "Updates a Tax Rate" diff --git a/packages/medusa/src/api/routes/admin/uploads/create-protected-upload.ts b/packages/medusa/src/api/routes/admin/uploads/create-protected-upload.ts index 4b4d01864e..024fab9368 100644 --- a/packages/medusa/src/api/routes/admin/uploads/create-protected-upload.ts +++ b/packages/medusa/src/api/routes/admin/uploads/create-protected-upload.ts @@ -2,7 +2,7 @@ import fs from "fs" import { IFileService } from "../../../../interfaces" /** - * @oas [post] /uploads/protected + * @oas [post] /admin/uploads/protected * operationId: "PostUploadsProtected" * summary: "Protected File Upload" * description: "Uploads at least one file with ACL or a non-public bucket to the specific fileservice that is installed in Medusa." diff --git a/packages/medusa/src/api/routes/admin/uploads/create-upload.ts b/packages/medusa/src/api/routes/admin/uploads/create-upload.ts index 0a4e5975c9..7fdafc54da 100644 --- a/packages/medusa/src/api/routes/admin/uploads/create-upload.ts +++ b/packages/medusa/src/api/routes/admin/uploads/create-upload.ts @@ -1,7 +1,7 @@ import fs from "fs" /** - * @oas [post] /uploads + * @oas [post] /admin/uploads * operationId: "PostUploads" * summary: "Upload files" * description: "Uploads at least one file to the specific fileservice that is installed in Medusa." diff --git a/packages/medusa/src/api/routes/admin/uploads/delete-upload.ts b/packages/medusa/src/api/routes/admin/uploads/delete-upload.ts index bbe48a0b34..3f5eef2f84 100644 --- a/packages/medusa/src/api/routes/admin/uploads/delete-upload.ts +++ b/packages/medusa/src/api/routes/admin/uploads/delete-upload.ts @@ -1,7 +1,7 @@ import { IsString } from "class-validator" /** - * @oas [delete] /uploads + * @oas [delete] /admin/uploads * operationId: "DeleteUploads" * summary: "Delete an Uploaded File" * description: "Removes an uploaded file using the installed fileservice" diff --git a/packages/medusa/src/api/routes/admin/uploads/get-download-url.ts b/packages/medusa/src/api/routes/admin/uploads/get-download-url.ts index 65bfc6f973..ca8a81ce57 100644 --- a/packages/medusa/src/api/routes/admin/uploads/get-download-url.ts +++ b/packages/medusa/src/api/routes/admin/uploads/get-download-url.ts @@ -2,7 +2,7 @@ import { AbstractFileService } from "../../../../interfaces" import { IsString } from "class-validator" /** - * @oas [post] /uploads/download-url + * @oas [post] /admin/uploads/download-url * operationId: "PostUploadsDownloadUrl" * summary: "Get a File's Download URL" * description: "Creates a presigned download url for a file" 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 319a35847b..adc9a3e5ce 100644 --- a/packages/medusa/src/api/routes/admin/users/create-user.ts +++ b/packages/medusa/src/api/routes/admin/users/create-user.ts @@ -7,7 +7,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /users + * @oas [post] /admin/users * operationId: "PostUsers" * summary: "Create a User" * description: "Creates a User" diff --git a/packages/medusa/src/api/routes/admin/users/delete-user.ts b/packages/medusa/src/api/routes/admin/users/delete-user.ts index 3d538d2be3..ad401979ec 100644 --- a/packages/medusa/src/api/routes/admin/users/delete-user.ts +++ b/packages/medusa/src/api/routes/admin/users/delete-user.ts @@ -2,7 +2,7 @@ import { EntityManager } from "typeorm" import UserService from "../../../../services/user" /** - * @oas [delete] /users/{id} + * @oas [delete] /admin/users/{id} * operationId: "DeleteUsersUser" * summary: "Delete a User" * description: "Deletes a User" 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 a835907e7f..9b68c2ffbd 100644 --- a/packages/medusa/src/api/routes/admin/users/get-user.ts +++ b/packages/medusa/src/api/routes/admin/users/get-user.ts @@ -1,7 +1,7 @@ import UserService from "../../../../services/user" /** - * @oas [get] /users/{id} + * @oas [get] /admin/users/{id} * operationId: "GetUsersUser" * summary: "Get a User" * description: "Retrieves a User." 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 9776a61527..b79c3a5068 100644 --- a/packages/medusa/src/api/routes/admin/users/list-users.ts +++ b/packages/medusa/src/api/routes/admin/users/list-users.ts @@ -1,7 +1,7 @@ import UserService from "../../../../services/user" /** - * @oas [get] /users + * @oas [get] /admin/users * operationId: "GetUsers" * summary: "List Users" * description: "Retrieves all users." diff --git a/packages/medusa/src/api/routes/admin/users/reset-password-token.ts b/packages/medusa/src/api/routes/admin/users/reset-password-token.ts index 68e8adb93b..dff0982040 100644 --- a/packages/medusa/src/api/routes/admin/users/reset-password-token.ts +++ b/packages/medusa/src/api/routes/admin/users/reset-password-token.ts @@ -4,7 +4,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /users/password-token + * @oas [post] /admin/users/password-token * operationId: "PostUsersUserPasswordToken" * summary: "Request Password Reset" * description: "Generates a password token for a User with a given email." 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 08d71715e2..920adb879d 100644 --- a/packages/medusa/src/api/routes/admin/users/reset-password.ts +++ b/packages/medusa/src/api/routes/admin/users/reset-password.ts @@ -9,7 +9,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /users/reset-password + * @oas [post] /admin/users/reset-password * operationId: "PostUsersUserPassword" * summary: "Reset Password" * description: "Sets the password for a User given the correct token." 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 6a95d19c6d..8b0392c90b 100644 --- a/packages/medusa/src/api/routes/admin/users/update-user.ts +++ b/packages/medusa/src/api/routes/admin/users/update-user.ts @@ -6,7 +6,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /users/{id} + * @oas [post] /admin/users/{id} * operationId: "PostUsersUser" * summary: "Update a User" * description: "Updates a User" diff --git a/packages/medusa/src/api/routes/admin/variants/get-inventory.ts b/packages/medusa/src/api/routes/admin/variants/get-inventory.ts index 3de41126ed..edf3f578f1 100644 --- a/packages/medusa/src/api/routes/admin/variants/get-inventory.ts +++ b/packages/medusa/src/api/routes/admin/variants/get-inventory.ts @@ -13,7 +13,7 @@ import ProductVariantService from "../../../../services/product-variant" import { joinLevels } from "../inventory-items/utils/join-levels" /** - * @oas [get] /variants/{id}/inventory + * @oas [get] /admin/variants/{id}/inventory * operationId: "GetVariantsVariantInventory" * summary: "Get inventory of Variant." * description: "Returns the available inventory of a Variant." 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 f995fa8fb4..e8edfcee88 100644 --- a/packages/medusa/src/api/routes/admin/variants/list-variants.ts +++ b/packages/medusa/src/api/routes/admin/variants/list-variants.ts @@ -13,7 +13,7 @@ import { AdminPriceSelectionParams } from "../../../../types/price-selection" import { IsType } from "../../../../utils/validators/is-type" /** - * @oas [get] /variants + * @oas [get] /admin/variants * operationId: "GetVariants" * summary: "List Product Variants" * description: "Retrieves a list of Product Variants" 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 0adbe02e1c..1358784e33 100644 --- a/packages/medusa/src/api/routes/store/auth/create-session.ts +++ b/packages/medusa/src/api/routes/store/auth/create-session.ts @@ -6,7 +6,7 @@ import CustomerService from "../../../../services/customer" import { validator } from "../../../../utils/validator" /** - * @oas [post] /auth + * @oas [post] /store/auth * operationId: "PostAuth" * summary: "Customer Login" * description: "Logs a Customer in and authorizes them to view their details. Successful authentication will set a session cookie in the Customer's browser." diff --git a/packages/medusa/src/api/routes/store/auth/delete-session.ts b/packages/medusa/src/api/routes/store/auth/delete-session.ts index 69f83b5d37..2663fc6553 100644 --- a/packages/medusa/src/api/routes/store/auth/delete-session.ts +++ b/packages/medusa/src/api/routes/store/auth/delete-session.ts @@ -1,5 +1,5 @@ /** - * @oas [delete] /auth + * @oas [delete] /store/auth * operationId: "DeleteAuth" * summary: "Customer Log out" * description: "Destroys a Customer's authenticated session." diff --git a/packages/medusa/src/api/routes/store/auth/exists.ts b/packages/medusa/src/api/routes/store/auth/exists.ts index 74fedae868..e3d1b60bf6 100644 --- a/packages/medusa/src/api/routes/store/auth/exists.ts +++ b/packages/medusa/src/api/routes/store/auth/exists.ts @@ -1,7 +1,7 @@ import CustomerService from "../../../../services/customer" /** - * @oas [get] /auth/{email} + * @oas [get] /store/auth/{email} * operationId: "GetAuthEmail" * summary: "Check if email exists" * description: "Checks if a Customer with the given email has signed up." 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 d70a78e4e2..3dccbb7370 100644 --- a/packages/medusa/src/api/routes/store/auth/get-session.ts +++ b/packages/medusa/src/api/routes/store/auth/get-session.ts @@ -1,7 +1,7 @@ import CustomerService from "../../../../services/customer" /** - * @oas [get] /auth + * @oas [get] /store/auth * operationId: "GetAuth" * summary: "Get Current Customer" * description: "Gets the currently logged in Customer." 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 4a95d190d9..f0a5053423 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 @@ -6,7 +6,7 @@ import { EntityManager } from "typeorm" import { validator } from "../../../../utils/validator" /** - * @oas [post] /carts/{id}/shipping-methods + * @oas [post] /store/carts/{id}/shipping-methods * operationId: "PostCartsCartShippingMethod" * description: "Adds a Shipping Method to the Cart." * summary: "Add a Shipping Method" 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 d9dc4969fa..f575ca0faf 100644 --- a/packages/medusa/src/api/routes/store/carts/calculate-taxes.ts +++ b/packages/medusa/src/api/routes/store/carts/calculate-taxes.ts @@ -4,7 +4,7 @@ import { EntityManager } from "typeorm" import { IdempotencyKey } from "../../../../models/idempotency-key" /** - * @oas [post] /carts/{id}/taxes + * @oas [post] /store/carts/{id}/taxes * summary: "Calculate Cart Taxes" * operationId: "PostCartsCartTaxes" * description: "Calculates taxes for a cart. Depending on the cart's region 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 ba4e945e3c..c2d3e5bc62 100644 --- a/packages/medusa/src/api/routes/store/carts/complete-cart.ts +++ b/packages/medusa/src/api/routes/store/carts/complete-cart.ts @@ -4,7 +4,7 @@ import { IdempotencyKey } from "../../../../models" import { IdempotencyKeyService } from "../../../../services" /** - * @oas [post] /carts/{id}/complete + * @oas [post] /store/carts/{id}/complete * summary: "Complete a Cart" * operationId: "PostCartsCartComplete" * description: "Completes a cart. The following steps will be performed. Payment 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 14c86f97aa..a17ab9d58d 100644 --- a/packages/medusa/src/api/routes/store/carts/create-cart.ts +++ b/packages/medusa/src/api/routes/store/carts/create-cart.ts @@ -24,7 +24,7 @@ import SalesChannelFeatureFlag from "../../../../loaders/feature-flags/sales-cha import { CartCreateProps } from "../../../../types/cart" /** - * @oas [post] /carts + * @oas [post] /store/carts * summary: "Create a Cart" * operationId: "PostCart" * description: "Creates a Cart within the given region and with the initial items. If no 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 ad866536a4..d60e4f1a6f 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 @@ -13,7 +13,7 @@ import { } from "../../../../../utils/idempotency" /** - * @oas [post] /carts/{id}/line-items + * @oas [post] /store/carts/{id}/line-items * operationId: PostCartsCartLineItems * summary: "Add a Line Item" * description: "Generates a Line Item with a given Product Variant and adds it 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 73848816a6..7e3f2a120f 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 @@ -4,7 +4,7 @@ import { EntityManager } from "typeorm" import IdempotencyKeyService from "../../../../services/idempotency-key" /** - * @oas [post] /carts/{id}/payment-sessions + * @oas [post] /store/carts/{id}/payment-sessions * operationId: "PostCartsCartPaymentSessions" * summary: "Create Payment Sessions" * description: "Creates Payment Sessions for each of the available Payment Providers in the Cart's Region." 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 7d2614b00c..c01e056b56 100644 --- a/packages/medusa/src/api/routes/store/carts/delete-discount.ts +++ b/packages/medusa/src/api/routes/store/carts/delete-discount.ts @@ -3,7 +3,7 @@ import { defaultStoreCartFields, defaultStoreCartRelations } from "." import { CartService } from "../../../../services" /** - * @oas [delete] /carts/{id}/discounts/{code} + * @oas [delete] /store/carts/{id}/discounts/{code} * operationId: DeleteCartsCartDiscountsDiscount * description: "Removes a Discount from a Cart." * summary: "Remove Discount" 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 c1de836022..fc430b3b76 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 @@ -3,7 +3,7 @@ import { defaultStoreCartFields, defaultStoreCartRelations } from "." import { CartService } from "../../../../services" /** - * @oas [delete] /carts/{id}/line-items/{line_id} + * @oas [delete] /store/carts/{id}/line-items/{line_id} * operationId: DeleteCartsCartLineItemsItem * summary: Delete a Line Item * description: "Removes a Line Item from a Cart." 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 85fe988305..d632ac2260 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 @@ -3,7 +3,7 @@ import { CartService } from "../../../../services" import { EntityManager } from "typeorm" /** - * @oas [delete] /carts/{id}/payment-sessions/{provider_id} + * @oas [delete] /store/carts/{id}/payment-sessions/{provider_id} * operationId: DeleteCartsCartPaymentSessionsSession * summary: "Delete a Payment Session" * description: "Deletes a Payment Session on a Cart. May be useful if a payment has failed." 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 c441adb19d..e207a44a24 100644 --- a/packages/medusa/src/api/routes/store/carts/get-cart.ts +++ b/packages/medusa/src/api/routes/store/carts/get-cart.ts @@ -2,7 +2,7 @@ import { CartService } from "../../../../services" import { EntityManager } from "typeorm" /** - * @oas [get] /carts/{id} + * @oas [get] /store/carts/{id} * operationId: "GetCartsCart" * summary: "Get a Cart" * description: "Retrieves a Cart." 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 17cc17e8a7..f8628b0561 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 @@ -2,7 +2,7 @@ import { CartService } from "../../../../services" import { EntityManager } from "typeorm" /** - * @oas [post] /carts/{id}/payment-sessions/{provider_id}/refresh + * @oas [post] /store/carts/{id}/payment-sessions/{provider_id}/refresh * operationId: PostCartsCartPaymentSessionsSession * summary: Refresh a Payment Session * description: "Refreshes a Payment Session to ensure that it is in sync with the Cart - this is usually not necessary." 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 cf80e04949..8f7f6d9ccd 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 @@ -6,7 +6,7 @@ import { IsString } from "class-validator" import { validator } from "../../../../utils/validator" /** - * @oas [post] /carts/{id}/payment-session + * @oas [post] /store/carts/{id}/payment-session * operationId: PostCartsCartPaymentSession * summary: Select a Payment Session * description: "Selects a Payment Session as the session intended to be used towards the completion of the Cart." 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 011e9c8c44..fd37746331 100644 --- a/packages/medusa/src/api/routes/store/carts/update-cart.ts +++ b/packages/medusa/src/api/routes/store/carts/update-cart.ts @@ -16,7 +16,7 @@ import { FeatureFlagDecorators } from "../../../../utils/feature-flag-decorators import { IsType } from "../../../../utils/validators/is-type" /** - * @oas [post] /carts/{id} + * @oas [post] /store/carts/{id} * operationId: PostCartsCart * summary: Update a Cart * description: "Updates a Cart." 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 6bd71a5bfe..171af4e98c 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 @@ -6,7 +6,7 @@ import { CartService } from "../../../../services" import { validator } from "../../../../utils/validator" /** - * @oas [post] /carts/{id}/line-items/{line_id} + * @oas [post] /store/carts/{id}/line-items/{line_id} * operationId: PostCartsCartLineItemsItem * summary: Update a Line Item * description: "Updates a Line Item if the desired quantity can be fulfilled." 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 e13d4290f0..80b4a6e978 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 @@ -5,7 +5,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /carts/{id}/payment-sessions/{provider_id} + * @oas [post] /store/carts/{id}/payment-sessions/{provider_id} * operationId: PostCartsCartPaymentSessionUpdate * summary: Update a Payment Session * description: "Updates a Payment Session with additional data." 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 dc1f6e0262..e91cc4d01d 100644 --- a/packages/medusa/src/api/routes/store/collections/get-collection.ts +++ b/packages/medusa/src/api/routes/store/collections/get-collection.ts @@ -1,7 +1,7 @@ import ProductCollectionService from "../../../../services/product-collection" /** - * @oas [get] /collections/{id} + * @oas [get] /store/collections/{id} * operationId: "GetCollectionsCollection" * summary: "Get a Collection" * description: "Retrieves a Product Collection." 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 d59ac97243..cb15fcd965 100644 --- a/packages/medusa/src/api/routes/store/collections/list-collections.ts +++ b/packages/medusa/src/api/routes/store/collections/list-collections.ts @@ -5,7 +5,7 @@ import ProductCollectionService from "../../../../services/product-collection" import { Type } from "class-transformer" /** - * @oas [get] /collections + * @oas [get] /store/collections * operationId: "GetCollections" * summary: "List Collections" * description: "Retrieve a list of Product Collection." 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 ad7b8c71ed..688c02bc6a 100644 --- a/packages/medusa/src/api/routes/store/customers/create-address.ts +++ b/packages/medusa/src/api/routes/store/customers/create-address.ts @@ -7,7 +7,7 @@ import { AddressCreatePayload } from "../../../../types/common" import { validator } from "../../../../utils/validator" /** - * @oas [post] /customers/me/addresses + * @oas [post] /store/customers/me/addresses * operationId: PostCustomersCustomerAddresses * summary: "Add a Shipping Address" * description: "Adds a Shipping Address to a Customer's saved addresses." 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 d00e4f864a..54b4e9ac22 100644 --- a/packages/medusa/src/api/routes/store/customers/create-customer.ts +++ b/packages/medusa/src/api/routes/store/customers/create-customer.ts @@ -8,7 +8,7 @@ import CustomerService from "../../../../services/customer" import { validator } from "../../../../utils/validator" /** - * @oas [post] /customers + * @oas [post] /store/customers * operationId: PostCustomers * summary: Create a Customer * description: "Creates a Customer account." 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 d411b22524..1195af8979 100644 --- a/packages/medusa/src/api/routes/store/customers/delete-address.ts +++ b/packages/medusa/src/api/routes/store/customers/delete-address.ts @@ -4,7 +4,7 @@ import { EntityManager } from "typeorm" import CustomerService from "../../../../services/customer" /** - * @oas [delete] /customers/me/addresses/{address_id} + * @oas [delete] /store/customers/me/addresses/{address_id} * operationId: DeleteCustomersCustomerAddressesAddress * summary: Delete an Address * description: "Removes an Address from the Customer's saved addresses." 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 5d1d2f3c17..44170c912f 100644 --- a/packages/medusa/src/api/routes/store/customers/get-customer.ts +++ b/packages/medusa/src/api/routes/store/customers/get-customer.ts @@ -2,7 +2,7 @@ import { defaultStoreCustomersFields, defaultStoreCustomersRelations } from "." import CustomerService from "../../../../services/customer" /** - * @oas [get] /customers/me + * @oas [get] /store/customers/me * operationId: GetCustomersCustomer * summary: Get a Customer * description: "Retrieves a Customer - the Customer must be logged in to retrieve their details." diff --git a/packages/medusa/src/api/routes/store/customers/get-payment-methods.ts b/packages/medusa/src/api/routes/store/customers/get-payment-methods.ts index 537582d8dd..68ba724ee1 100644 --- a/packages/medusa/src/api/routes/store/customers/get-payment-methods.ts +++ b/packages/medusa/src/api/routes/store/customers/get-payment-methods.ts @@ -4,7 +4,7 @@ import PaymentProviderService from "../../../../services/payment-provider" import { PaymentProvider } from "../../../../models" /** - * @oas [get] /customers/me/payment-methods + * @oas [get] /store/customers/me/payment-methods * operationId: GetCustomersCustomerPaymentMethods * summary: Get Payment Methods * description: "Retrieves a list of a Customer's saved payment methods. Payment methods are saved with Payment Providers and it is their responsibility to fetch saved methods." 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 e7cf793fff..fa50b76b60 100644 --- a/packages/medusa/src/api/routes/store/customers/list-orders.ts +++ b/packages/medusa/src/api/routes/store/customers/list-orders.ts @@ -17,7 +17,7 @@ import OrderService from "../../../../services/order" import { DateComparisonOperator } from "../../../../types/common" /** - * @oas [get] /customers/me/orders + * @oas [get] /store/customers/me/orders * operationId: GetCustomersCustomerOrders * summary: List Orders * description: "Retrieves a list of a Customer's Orders." diff --git a/packages/medusa/src/api/routes/store/customers/reset-password-token.ts b/packages/medusa/src/api/routes/store/customers/reset-password-token.ts index 4bcbc0b1c1..73ae59b7fc 100644 --- a/packages/medusa/src/api/routes/store/customers/reset-password-token.ts +++ b/packages/medusa/src/api/routes/store/customers/reset-password-token.ts @@ -4,7 +4,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /customers/password-token + * @oas [post] /store/customers/password-token * operationId: PostCustomersCustomerPasswordToken * summary: Request Password Reset * description: "Creates a reset password token to be used in a subsequent /reset-password request. The password token should be sent out of band e.g. via email and will not be returned." 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 3308e3bdde..8e083a4ad5 100644 --- a/packages/medusa/src/api/routes/store/customers/reset-password.ts +++ b/packages/medusa/src/api/routes/store/customers/reset-password.ts @@ -6,7 +6,7 @@ import { validator } from "../../../../utils/validator" import { EntityManager } from "typeorm" /** - * @oas [post] /customers/password-reset + * @oas [post] /store/customers/password-reset * operationId: PostCustomersResetPassword * summary: Reset Password * description: "Resets a Customer's password using a password token created by a previous /password-token request." 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 19cf92939c..c76e58f04b 100644 --- a/packages/medusa/src/api/routes/store/customers/update-address.ts +++ b/packages/medusa/src/api/routes/store/customers/update-address.ts @@ -6,7 +6,7 @@ import { AddressPayload } from "../../../../types/common" import { validator } from "../../../../utils/validator" /** - * @oas [post] /customers/me/addresses/{address_id} + * @oas [post] /store/customers/me/addresses/{address_id} * operationId: PostCustomersCustomerAddressesAddress * summary: "Update a Shipping Address" * description: "Updates a Customer's saved Shipping Address." 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 29ed334a22..76ee831c02 100644 --- a/packages/medusa/src/api/routes/store/customers/update-customer.ts +++ b/packages/medusa/src/api/routes/store/customers/update-customer.ts @@ -8,7 +8,7 @@ import { validator } from "../../../../utils/validator" import { IsType } from "../../../../utils/validators/is-type" /** - * @oas [post] /customers/me + * @oas [post] /store/customers/me * operationId: PostCustomersCustomer * summary: Update Customer * description: "Updates a Customer's saved details." 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 df56821f34..0c7af91f1e 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 @@ -3,7 +3,7 @@ import { defaultStoreGiftCardFields, defaultStoreGiftCardRelations } from "." import GiftCardService from "../../../../services/gift-card" /** - * @oas [get] /gift-cards/{code} + * @oas [get] /store/gift-cards/{code} * operationId: "GetGiftCardsCode" * summary: "Get Gift Card by Code" * description: "Retrieves a Gift Card by its associated unique code." 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 42705bc7bc..744bebb6ff 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 @@ -9,7 +9,7 @@ import { } from "../../../../types/order-edit" /** - * @oas [post] /order-edits/{id}/complete + * @oas [post] /store/order-edits/{id}/complete * operationId: "PostOrderEditsOrderEditComplete" * summary: "Completes an OrderEdit" * description: "Completes an OrderEdit." 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 ca62cfedd9..5bea5084be 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 @@ -8,7 +8,7 @@ import { } from "../../../../types/order-edit" /** - * @oas [post] /order-edits/{id}/decline + * @oas [post] /store/order-edits/{id}/decline * operationId: "PostOrderEditsOrderEditDecline" * summary: "Decline an OrderEdit" * description: "Declines an OrderEdit." 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 130b571e10..929968bea4 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 @@ -2,7 +2,7 @@ import { Request, Response } from "express" import { OrderEditService } from "../../../../services" /** - * @oas [get] /order-edits/{id} + * @oas [get] /store/order-edits/{id} * operationId: "GetOrderEditsOrderEdit" * summary: "Retrieve an OrderEdit" * description: "Retrieves a OrderEdit." diff --git a/packages/medusa/src/api/routes/store/orders/confirm-order-request.ts b/packages/medusa/src/api/routes/store/orders/confirm-order-request.ts index 0050e09c6f..b97fb39466 100644 --- a/packages/medusa/src/api/routes/store/orders/confirm-order-request.ts +++ b/packages/medusa/src/api/routes/store/orders/confirm-order-request.ts @@ -7,7 +7,7 @@ import { } from "../../../../services" /** - * @oas [post] /orders/customer/confirm + * @oas [post] /store/orders/customer/confirm * operationId: "PostOrdersCustomerOrderClaimsCustomerOrderClaimAccept" * summary: "Verify an Order Claim" * description: "Verifies the claim order token provided to the customer upon request of order ownership" 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 d97d7e64ee..bcb2f49991 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 @@ -3,7 +3,7 @@ import { defaultStoreOrdersFields, defaultStoreOrdersRelations } from "." import { OrderService } from "../../../../services" /** - * @oas [get] /orders/cart/{cart_id} + * @oas [get] /store/orders/cart/{cart_id} * operationId: GetOrdersOrderCartId * summary: Get by Cart ID * description: "Retrieves an Order by the id of the Cart that was used to create the Order." 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 671584a0fc..8dbf09c067 100644 --- a/packages/medusa/src/api/routes/store/orders/get-order.ts +++ b/packages/medusa/src/api/routes/store/orders/get-order.ts @@ -5,7 +5,7 @@ import { FindParams } from "../../../../types/common" import { cleanResponseData } from "../../../../utils/clean-response-data" /** - * @oas [get] /orders/{id} + * @oas [get] /store/orders/{id} * operationId: GetOrdersOrder * summary: Get an Order * description: "Retrieves an Order" 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 1ee96f0948..830b3ae324 100644 --- a/packages/medusa/src/api/routes/store/orders/lookup-order.ts +++ b/packages/medusa/src/api/routes/store/orders/lookup-order.ts @@ -14,7 +14,7 @@ import { defaultStoreOrdersFields, defaultStoreOrdersRelations } from "." import { FindParams } from "../../../../types/common" /** - * @oas [get] /orders + * @oas [get] /store/orders * operationId: "GetOrders" * summary: "Look Up an Order" * description: "Look up an order using filters." diff --git a/packages/medusa/src/api/routes/store/orders/request-order.ts b/packages/medusa/src/api/routes/store/orders/request-order.ts index fd5e4b8b0a..39634365cf 100644 --- a/packages/medusa/src/api/routes/store/orders/request-order.ts +++ b/packages/medusa/src/api/routes/store/orders/request-order.ts @@ -9,7 +9,7 @@ import TokenService from "../../../../services/token" import { TokenEvents } from "../../../../types/token" /** - * @oas [post] /orders/batch/customer/token + * @oas [post] /store/orders/batch/customer/token * operationId: "PostOrdersCustomerOrderClaim" * summary: "Claim an Order" * description: "Sends an email to emails registered to orders provided with link to transfer order ownership" 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 b13fc70ed4..99862892ae 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 @@ -2,7 +2,7 @@ import { IsArray, IsString } from "class-validator" import { PaymentCollectionService } from "../../../../services" /** - * @oas [post] /payment-collections/{id}/sessions/batch/authorize + * @oas [post] /store/payment-collections/{id}/sessions/batch/authorize * operationId: "PostPaymentCollectionsSessionsBatchAuthorize" * summary: "Authorize PaymentSessions" * description: "Authorizes Payment Sessions of a Payment Collection." 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 5d5aa7be92..c5cbd8fd0b 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 @@ -3,7 +3,7 @@ import { PaymentSessionStatus } from "../../../../models" import { PaymentCollectionService } from "../../../../services" /** - * @oas [post] /payment-collections/{id}/sessions/{session_id}/authorize + * @oas [post] /store/payment-collections/{id}/sessions/{session_id}/authorize * operationId: "PostPaymentCollectionsSessionsSessionAuthorize" * summary: "Authorize Payment Session" * description: "Authorizes a Payment Session of a Payment Collection." 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 ce2bf9a75a..ded664d25c 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 @@ -2,7 +2,7 @@ import { PaymentCollectionService } from "../../../../services" import { FindParams } from "../../../../types/common" /** - * @oas [get] /payment-collections/{id} + * @oas [get] /store/payment-collections/{id} * operationId: "GetPaymentCollectionsPaymentCollection" * summary: "Get a PaymentCollection" * description: "Get a Payment Collection" 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 70070ff81e..0e34e4a108 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 @@ -5,7 +5,7 @@ import { EntityManager } from "typeorm" import { PaymentCollectionService } from "../../../../services" /** - * @oas [post] /payment-collections/{id}/sessions/batch + * @oas [post] /store/payment-collections/{id}/sessions/batch * operationId: "PostPaymentCollectionsPaymentCollectionSessionsBatch" * summary: "Manage Payment Sessions" * description: "Manages Multiple Payment Sessions from Payment Collections." 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 c13ac82efe..1fde7f86f9 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 @@ -4,7 +4,7 @@ import { EntityManager } from "typeorm" import { PaymentCollectionService } from "../../../../services" /** - * @oas [post] /payment-collections/{id}/sessions + * @oas [post] /store/payment-collections/{id}/sessions * operationId: "PostPaymentCollectionsSessions" * summary: "Manage a Payment Session" * description: "Manages Payment Sessions from Payment Collections." 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 a369d9a25a..1a1f99a7a5 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 @@ -2,7 +2,7 @@ import { EntityManager } from "typeorm" import { PaymentCollectionService } from "../../../../services" /** - * @oas [post] /payment-collections/{id}/sessions/{session_id} + * @oas [post] /store/payment-collections/{id}/sessions/{session_id} * operationId: PostPaymentCollectionsPaymentCollectionPaymentSessionsSession * summary: "Refresh a Payment Session" * description: "Refreshes a Payment Session to ensure that it is in sync with the Payment Collection." diff --git a/packages/medusa/src/api/routes/store/product-categories/get-product-category.ts b/packages/medusa/src/api/routes/store/product-categories/get-product-category.ts index 06c7f9f2cd..635df9733c 100644 --- a/packages/medusa/src/api/routes/store/product-categories/get-product-category.ts +++ b/packages/medusa/src/api/routes/store/product-categories/get-product-category.ts @@ -6,7 +6,7 @@ import { transformTreeNodesWithConfig } from "../../../../utils/transformers/tre import { defaultStoreScope } from "." /** - * @oas [get] /product-categories/{id} + * @oas [get] /store/product-categories/{id} * operationId: "GetProductCategoriesCategory" * summary: "Get a Product Category" * description: "Retrieves a Product Category." diff --git a/packages/medusa/src/api/routes/store/product-categories/list-product-categories.ts b/packages/medusa/src/api/routes/store/product-categories/list-product-categories.ts index 2512ab0dbf..79e8bb915f 100644 --- a/packages/medusa/src/api/routes/store/product-categories/list-product-categories.ts +++ b/packages/medusa/src/api/routes/store/product-categories/list-product-categories.ts @@ -7,7 +7,7 @@ import { extendedFindParamsMixin } from "../../../../types/common" import { defaultStoreScope } from "." /** - * @oas [get] /product-categories + * @oas [get] /store/product-categories * operationId: "GetProductCategories" * summary: "List Product Categories" * description: "Retrieve a list of product categories." diff --git a/packages/medusa/src/api/routes/store/product-tags/list-product-tags.ts b/packages/medusa/src/api/routes/store/product-tags/list-product-tags.ts index 1de0759680..cf33f0f308 100644 --- a/packages/medusa/src/api/routes/store/product-tags/list-product-tags.ts +++ b/packages/medusa/src/api/routes/store/product-tags/list-product-tags.ts @@ -10,7 +10,7 @@ import ProductTagService from "../../../../services/product-tag" import { IsType } from "../../../../utils/validators/is-type" /** - * @oas [get] /product-tags + * @oas [get] /store/product-tags * operationId: "GetProductTags" * summary: "List Product Tags" * description: "Retrieve a list of Product Tags." 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 b017720e3c..203cabfbb3 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 @@ -9,7 +9,7 @@ import { IsType } from "../../../../utils/validators/is-type" import ProductTypeService from "../../../../services/product-type" /** - * @oas [get] /product-types + * @oas [get] /store/product-types * operationId: "GetProductTypes" * summary: "List Product Types" * description: "Retrieve a list of Product Types." 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 199589b7a7..31ba33c041 100644 --- a/packages/medusa/src/api/routes/store/products/get-product.ts +++ b/packages/medusa/src/api/routes/store/products/get-product.ts @@ -11,7 +11,7 @@ import { PriceSelectionParams } from "../../../../types/price-selection" import { cleanResponseData } from "../../../../utils/clean-response-data" /** - * @oas [get] /products/{id} + * @oas [get] /store/products/{id} * operationId: GetProductsProduct * summary: Get a Product * description: "Retrieves a Product." 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 be7b924ced..180728147c 100644 --- a/packages/medusa/src/api/routes/store/products/list-products.ts +++ b/packages/medusa/src/api/routes/store/products/list-products.ts @@ -23,7 +23,7 @@ import { cleanResponseData } from "../../../../utils/clean-response-data" import { Cart, Product } from "../../../../models" /** - * @oas [get] /products + * @oas [get] /store/products * operationId: GetProducts * summary: List Products * description: "Retrieves a list of Products." diff --git a/packages/medusa/src/api/routes/store/products/search.ts b/packages/medusa/src/api/routes/store/products/search.ts index 6e0453a198..90661cd2e2 100644 --- a/packages/medusa/src/api/routes/store/products/search.ts +++ b/packages/medusa/src/api/routes/store/products/search.ts @@ -6,7 +6,7 @@ import { Type } from "class-transformer" import { validator } from "../../../../utils/validator" /** - * @oas [post] /products/search + * @oas [post] /store/products/search * operationId: PostProductsSearch * summary: Search Products * description: "Run a search query on products using the search engine installed on Medusa" 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 5dc4eec489..e8cffd2d3c 100644 --- a/packages/medusa/src/api/routes/store/regions/get-region.ts +++ b/packages/medusa/src/api/routes/store/regions/get-region.ts @@ -1,7 +1,7 @@ import RegionService from "../../../../services/region" /** - * @oas [get] /regions/{id} + * @oas [get] /store/regions/{id} * operationId: GetRegionsRegion * summary: Get a Region * description: "Retrieves a Region." 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 3d30c9820f..40b04f89d1 100644 --- a/packages/medusa/src/api/routes/store/regions/list-regions.ts +++ b/packages/medusa/src/api/routes/store/regions/list-regions.ts @@ -7,7 +7,7 @@ import { omit } from "lodash" import { validator } from "../../../../utils/validator" /** - * @oas [get] /regions + * @oas [get] /store/regions * operationId: GetRegions * summary: List Regions * description: "Retrieves a list of Regions." 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 f97e3d34f6..e770f624d6 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 @@ -5,7 +5,7 @@ import { import ReturnReasonService from "../../../../services/return-reason" /** - * @oas [get] /return-reasons/{id} + * @oas [get] /store/return-reasons/{id} * operationId: "GetReturnReasonsReason" * summary: "Get a Return Reason" * description: "Retrieves a Return Reason." 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 d119a08b90..e000d0218b 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 @@ -5,7 +5,7 @@ import { import ReturnReasonService from "../../../../services/return-reason" /** - * @oas [get] /return-reasons + * @oas [get] /store/return-reasons * operationId: "GetReturnReasons" * summary: "List Return Reasons" * description: "Retrieves a list of Return Reasons." 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 aefad109d9..5f4b468610 100644 --- a/packages/medusa/src/api/routes/store/returns/create-return.ts +++ b/packages/medusa/src/api/routes/store/returns/create-return.ts @@ -17,7 +17,7 @@ import ReturnService from "../../../../services/return" import { validator } from "../../../../utils/validator" /** - * @oas [post] /returns + * @oas [post] /store/returns * operationId: "PostReturns" * summary: "Create Return" * description: "Creates a Return for an Order." 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 f23959959a..6dd327bbd7 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 @@ -4,7 +4,7 @@ import ShippingOptionService from "../../../../services/shipping-option" import { validator } from "../../../../utils/validator" /** - * @oas [get] /shipping-options + * @oas [get] /store/shipping-options * operationId: GetShippingOptions * summary: Get Shipping Options * description: "Retrieves a list of Shipping Options." 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 33c2f767a3..803fd7cd14 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 @@ -2,7 +2,7 @@ import { CartService, PricingService } from "../../../../services" import ShippingProfileService from "../../../../services/shipping-profile" /** - * @oas [get] /shipping-options/{cart_id} + * @oas [get] /store/shipping-options/{cart_id} * operationId: GetShippingOptionsCartId * summary: List for Cart * description: "Retrieves a list of Shipping Options available to a cart." 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 ce87ad34ab..cb3a993e17 100644 --- a/packages/medusa/src/api/routes/store/swaps/create-swap.ts +++ b/packages/medusa/src/api/routes/store/swaps/create-swap.ts @@ -19,7 +19,7 @@ import { Type } from "class-transformer" import { validator } from "../../../../utils/validator" /** - * @oas [post] /swaps + * @oas [post] /store/swaps * operationId: PostSwaps * summary: Create a Swap * description: "Creates a Swap on an Order by providing some items to return along with some items to send back" 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 c270e7491d..c2d2bbf332 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,7 +1,7 @@ import SwapService from "../../../../services/swap" /** - * @oas [get] /swaps/{cart_id} + * @oas [get] /store/swaps/{cart_id} * operationId: GetSwapsSwapCartId * summary: Get by Cart ID * description: "Retrieves a Swap by the id of the Cart used to confirm the Swap." 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 ebe7ac40f7..ea6ec8633b 100644 --- a/packages/medusa/src/api/routes/store/variants/get-variant.ts +++ b/packages/medusa/src/api/routes/store/variants/get-variant.ts @@ -12,7 +12,7 @@ import { validator } from "../../../../utils/validator" import { IsOptional, IsString } from "class-validator" /** - * @oas [get] /variants/{variant_id} + * @oas [get] /store/variants/{variant_id} * operationId: GetVariantsVariant * summary: Get a Product Variant * description: "Retrieves a Product Variant by id" 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 8a1b5817e5..9df50d19bf 100644 --- a/packages/medusa/src/api/routes/store/variants/list-variants.ts +++ b/packages/medusa/src/api/routes/store/variants/list-variants.ts @@ -17,7 +17,7 @@ import { validator } from "../../../../utils/validator" import { IsType } from "../../../../utils/validators/is-type" /** - * @oas [get] /variants + * @oas [get] /store/variants * operationId: GetVariants * summary: Get Product Variants * description: "Retrieves a list of Product Variants"