Skip to content

Commit dde167d

Browse files
shahednassershahednasser
authored
chore: fixes to since tags in TSDocs (#16225)
1 parent e2b2a5c commit dde167d

14 files changed

Lines changed: 54 additions & 10 deletions

File tree

‎packages/core/core-flows/src/product/steps/process-product-options-for-import.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export const processProductOptionsForImportStepId =
1616
* created — defaulting to `is_exclusive: true` unless the import explicitly
1717
* sets it to `false`.
1818
*
19-
* @since 2.17.3
19+
* @since 2.18.0
2020
*/
2121
export type ImportProductOptionInput = ProductTypes.CreateProductOptionDTO & {
2222
id?: string

‎packages/core/types/src/http/invite/admin/entities.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ export interface AdminInvite {
2727
metadata?: Record<string, unknown>
2828
/**
2929
* The RBAC roles assigned to the invite.
30+
*
31+
* @featureFlag rbac
3032
*/
3133
rbac_roles?: AdminRbacRole[]
3234
/**

‎packages/core/utils/src/core-flows/events.ts‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1015,7 +1015,7 @@ export const InventoryItemWorkflowEvents = {
10151015
/**
10161016
* Emitted when inventory items are created.
10171017
*
1018-
* @since 2.17.3
1018+
* @since 2.18.0
10191019
*
10201020
* @eventPayload
10211021
* ```ts
@@ -1028,7 +1028,7 @@ export const InventoryItemWorkflowEvents = {
10281028
/**
10291029
* Emitted when inventory items are updated.
10301030
*
1031-
* @since 2.17.3
1031+
* @since 2.18.0
10321032
*
10331033
* @eventPayload
10341034
* ```ts
@@ -1041,7 +1041,7 @@ export const InventoryItemWorkflowEvents = {
10411041
/**
10421042
* Emitted when inventory items are deleted.
10431043
*
1044-
* @since 2.17.3
1044+
* @since 2.18.0
10451045
*
10461046
* @eventPayload
10471047
* ```ts
@@ -1061,7 +1061,7 @@ export const InventoryLevelWorkflowEvents = {
10611061
/**
10621062
* Emitted when inventory levels are created.
10631063
*
1064-
* @since 2.17.3
1064+
* @since 2.18.0
10651065
*
10661066
* @eventPayload
10671067
* ```ts
@@ -1075,7 +1075,7 @@ export const InventoryLevelWorkflowEvents = {
10751075
* Emitted when inventory levels are updated. This includes adjustments to
10761076
* the stocked or reserved quantity, such as during order fulfillment.
10771077
*
1078-
* @since 2.17.3
1078+
* @since 2.18.0
10791079
*
10801080
* @eventPayload
10811081
* ```ts
@@ -1089,7 +1089,7 @@ export const InventoryLevelWorkflowEvents = {
10891089
/**
10901090
* Emitted when inventory levels are deleted.
10911091
*
1092-
* @since 2.17.3
1092+
* @since 2.18.0
10931093
*
10941094
* @eventPayload
10951095
* ```ts
@@ -1109,7 +1109,7 @@ export const ReservationItemWorkflowEvents = {
11091109
/**
11101110
* Emitted when reservations are created.
11111111
*
1112-
* @since 2.17.3
1112+
* @since 2.18.0
11131113
*
11141114
* @eventPayload
11151115
* ```ts
@@ -1123,7 +1123,7 @@ export const ReservationItemWorkflowEvents = {
11231123
/**
11241124
* Emitted when reservations are updated.
11251125
*
1126-
* @since 2.17.3
1126+
* @since 2.18.0
11271127
*
11281128
* @eventPayload
11291129
* ```ts
@@ -1137,7 +1137,7 @@ export const ReservationItemWorkflowEvents = {
11371137
/**
11381138
* Emitted when reservations are deleted.
11391139
*
1140-
* @since 2.17.3
1140+
* @since 2.18.0
11411141
*
11421142
* @eventPayload
11431143
* ```ts

‎packages/medusa/src/api/admin/orders/[id]/payment-sessions/authorize/route.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ import {
88
MedusaResponse,
99
} from "@medusajs/framework/http"
1010

11+
/**
12+
* @since 2.17.0
13+
*/
1114
export const POST = async (
1215
req: AuthenticatedMedusaRequest<HttpTypes.AdminAuthorizeOrderPaymentSession>,
1316
res: MedusaResponse<HttpTypes.AdminAuthorizeOrderPaymentSessionResponse>

‎packages/medusa/src/api/admin/product-options/[id]/values/[value_id]/route.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ const retrieveProductOptionValue = async (
3838
return product_option_value
3939
}
4040

41+
/**
42+
* @since 2.16.0
43+
*/
4144
export const GET = async (
4245
req: AuthenticatedMedusaRequest<{}, HttpTypes.SelectParams>,
4346
res: MedusaResponse<HttpTypes.AdminProductOptionValueResponse>
@@ -50,6 +53,9 @@ export const GET = async (
5053
res.status(200).json({ product_option_value })
5154
}
5255

56+
/**
57+
* @since 2.17.0
58+
*/
5359
export const POST = async (
5460
req: AuthenticatedMedusaRequest<HttpTypes.AdminUpdateProductOptionValue>,
5561
res: MedusaResponse<HttpTypes.AdminProductOptionValueResponse>
@@ -78,6 +84,9 @@ export const POST = async (
7884
res.status(200).json({ product_option_value: updatedProductOptionValue })
7985
}
8086

87+
/**
88+
* @since 2.17.0
89+
*/
8190
export const DELETE = async (
8291
req: AuthenticatedMedusaRequest,
8392
res: MedusaResponse<HttpTypes.AdminProductOptionValueDeleteResponse>

‎packages/medusa/src/api/admin/product-options/[id]/values/route.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ import {
55
import { HttpTypes } from "@medusajs/framework/types"
66
import { ContainerRegistrationKeys } from "@medusajs/framework/utils"
77

8+
/**
9+
* @since 2.16.0
10+
*/
811
export const GET = async (
912
req: AuthenticatedMedusaRequest<HttpTypes.AdminProductOptionValueListParams>,
1013
res: MedusaResponse<HttpTypes.AdminProductOptionValueListResponse>

‎packages/medusa/src/api/admin/products/[id]/options/batch/route.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ import { createAndLinkProductOptionsToProductWorkflow } from "@medusajs/core-flo
77
import { ContainerRegistrationKeys } from "@medusajs/framework/utils"
88
import { remapKeysForProduct, remapProductResponse } from "../../../helpers"
99

10+
/**
11+
* @since 2.17.0
12+
*/
1013
export const POST = async (
1114
req: AuthenticatedMedusaRequest<HttpTypes.AdminLinkProductOptions>,
1215
res: MedusaResponse<HttpTypes.AdminProductResponse>

‎packages/medusa/src/api/auth/mfa/challenges/[id]/verify/route.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ import {
1111
import { generateJwtTokenForAuthIdentity } from "../../../../utils/generate-jwt-token"
1212
import { AuthMfaVerifyChallengeRequestType } from "../../../../validators"
1313

14+
/**
15+
* @since 2.15.3
16+
*/
1417
export const POST = async (
1518
req: AuthenticatedMedusaRequest<AuthMfaVerifyChallengeRequestType>,
1619
res: MedusaResponse

‎packages/medusa/src/api/auth/mfa/factors/[id]/route.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ import { IAuthModuleService } from "@medusajs/framework/types"
66
import { AuthEvents, Modules } from "@medusajs/framework/utils"
77
import { AuthMfaDisableFactorRequestType } from "../../../validators"
88

9+
/**
10+
* @since 2.15.3
11+
*/
912
export const DELETE = async (
1013
req: AuthenticatedMedusaRequest<AuthMfaDisableFactorRequestType>,
1114
res: MedusaResponse

‎packages/medusa/src/api/auth/mfa/factors/[id]/verify/route.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ import { IAuthModuleService } from "@medusajs/framework/types"
66
import { AuthEvents, Modules } from "@medusajs/framework/utils"
77
import { AuthMfaVerifyFactorRequestType } from "../../../../validators"
88

9+
/**
10+
* @since 2.15.3
11+
*/
912
export const POST = async (
1013
req: AuthenticatedMedusaRequest<AuthMfaVerifyFactorRequestType>,
1114
res: MedusaResponse

0 commit comments

Comments
 (0)