Skip to content

Commit 0fd9f27

Browse files
authored
chore: add missing since and featureFlag tags (medusajs#13926)
1 parent 604ff55 commit 0fd9f27

File tree

17 files changed

+50
-2
lines changed

17 files changed

+50
-2
lines changed

packages/cli/oas/medusa-oas-cli/redocly/redocly-config.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,9 @@ decorators:
149149
- StoreGiftCardInvitation
150150
StoreTransactionGroup:
151151
- StoreStoreCreditAccount
152+
AdminProductImage:
153+
- AdminProduct
154+
- AdminProductVariant
152155
theme:
153156
openapi:
154157
theme:

packages/core/core-flows/src/product/steps/add-image-to-variants.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ export const addImageToVariantsStepId = "add-image-to-variants"
66

77
/**
88
* This step adds an image to one or more product variants.
9+
*
10+
* @since 2.11.2
911
*
1012
* @example
1113
* const data = addImageToVariantsStep({

packages/core/core-flows/src/product/steps/add-images-to-variant.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ export const addImagesToVariantStepId = "add-images-to-variant"
66

77
/**
88
* This step adds one or more images to a product variant.
9+
*
10+
* @since 2.11.2
911
*
1012
* @example
1113
* const data = addImagesToVariantStep({

packages/core/core-flows/src/product/steps/remove-image-from-variants.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ export const removeImageFromVariantsStepId = "remove-image-from-variants"
77
/**
88
* This step removes an image from one or more product variants.
99
*
10+
* @since 2.11.2
11+
*
1012
* @example
1113
* const data = removeImageFromVariantsStep({
1214
* image_id: "img_123",

packages/core/core-flows/src/product/steps/remove-images-from-variant.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ export const removeImagesFromVariantStepId = "remove-images-from-variant"
77
/**
88
* This step removes one or more images from a product variant.
99
*
10+
* @since 2.11.2
11+
*
1012
* @example
1113
* const data = removeImagesFromVariantStep({
1214
* variant_id: "variant_123",

packages/core/core-flows/src/product/workflows/batch-image-variants.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ export const batchImageVariantsWorkflowId = "batch-image-variants"
5555
* You can use this workflow within your own customizations or custom workflows to manage image-variant associations in bulk.
5656
* This is also useful when writing a [seed script](https://docs.medusajs.com/learn/fundamentals/custom-cli-scripts/seed-data) or a custom import script.
5757
*
58+
* @since 2.11.2
59+
*
5860
* @example
5961
* const { result } = await batchImageVariantsWorkflow(container)
6062
* .run({

packages/core/core-flows/src/product/workflows/batch-variant-images.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ export const batchVariantImagesWorkflowId = "batch-variant-images"
5555
* You can use this workflow within your own customizations or custom workflows to manage variant-image associations in bulk.
5656
* This is also useful when writing a [seed script](https://docs.medusajs.com/learn/fundamentals/custom-cli-scripts/seed-data) or a custom import script.
5757
*
58+
* @since 2.11.2
59+
*
5860
* @example
5961
* const { result } = await batchVariantImagesWorkflow(container)
6062
* .run({

packages/core/js-sdk/src/admin/product.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1080,6 +1080,8 @@ export class Product {
10801080
* This method manages image-variant associations for a specific image. It sends a request to the
10811081
* [Batch Image Variants](https://docs.medusajs.com/api/admin#products_postproductsidimagesimage_idvariantsbatch)
10821082
* API route.
1083+
*
1084+
* @since 2.11.2
10831085
*
10841086
* @param productId - The product's ID.
10851087
* @param imageId - The image's ID.
@@ -1116,6 +1118,8 @@ export class Product {
11161118
* This method manages variant-image associations for a specific variant. It sends a request to the
11171119
* [Batch Variant Images](https://docs.medusajs.com/api/admin#products_postproductsidvariantsvariant_idimagesbatch)
11181120
* API route.
1121+
*
1122+
* @since 2.11.2
11191123
*
11201124
* @param productId - The product's ID.
11211125
* @param variantId - The variant's ID.

packages/medusa/src/api/admin/index/details/route.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ import { Modules } from "@medusajs/framework/utils"
44

55
/**
66
* Get the index information for all entities that are indexed and their sync state
7-
* @param req
8-
* @param res
7+
*
8+
* @since 2.11.2
9+
* @featureFlag index
910
*/
1011
export const GET = async (
1112
req: AuthenticatedMedusaRequest<void>,

packages/medusa/src/api/admin/index/sync/route.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@ import { AuthenticatedMedusaRequest, MedusaResponse } from "@medusajs/framework"
22
import { HttpTypes } from "@medusajs/framework/types"
33
import { Modules } from "@medusajs/framework/utils"
44

5+
/**
6+
* @since 2.11.2
7+
* @featureFlag index
8+
*/
59
export const POST = async (
610
req: AuthenticatedMedusaRequest<HttpTypes.AdminIndexSyncPayload>,
711
res: MedusaResponse

0 commit comments

Comments
 (0)