chore: add tsdocs for latest changes (#13539)

This commit is contained in:
Shahed Nasser
2025-09-18 18:04:24 +03:00
committed by GitHub
parent 57897c232e
commit aa7ea4d9a6
8 changed files with 133 additions and 42 deletions
@@ -10,11 +10,8 @@ import { generateEntityColumns } from "./helpers"
import { ENTITY_MAPPINGS } from "./entity-mappings"
/**
* @ignore
*
* @privateRemarks
* Remove the `ignore` tag once the feature is ready. Otherwise,
* it will be generated in the documentation.
* @since 2.10.3
* @featureFlag view_configurations
*/
export const GET = async (
req: AuthenticatedMedusaRequest,
@@ -8,11 +8,8 @@ import { MedusaError, Modules } from "@medusajs/framework/utils"
import { updateViewConfigurationWorkflow } from "@medusajs/core-flows"
/**
* @ignore
*
* @privateRemarks
* Remove the `ignore` tag once the feature is ready. Otherwise,
* it will be generated in the documentation.
* @since 2.10.3
* @featureFlag view_configurations
*/
export const GET = async (
req: AuthenticatedMedusaRequest<HttpTypes.AdminGetViewConfigurationParams>,
@@ -40,11 +37,8 @@ export const GET = async (
}
/**
* @ignore
*
* @privateRemarks
* Remove the `ignore` tag once the feature is ready. Otherwise,
* it will be generated in the documentation.
* @since 2.10.3
* @featureFlag view_configurations
*/
export const POST = async (
req: AuthenticatedMedusaRequest<AdminUpdateViewConfigurationType>,
@@ -78,11 +72,8 @@ export const POST = async (
}
/**
* @ignore
*
* @privateRemarks
* Remove the `ignore` tag once the feature is ready. Otherwise,
* it will be generated in the documentation.
* @since 2.10.3
* @featureFlag view_configurations
*/
export const DELETE = async (
req: AuthenticatedMedusaRequest,
@@ -10,11 +10,8 @@ import { HttpTypes } from "@medusajs/framework/types"
import { Modules } from "@medusajs/framework/utils"
/**
* @ignore
*
* @privateRemarks
* Remove the `ignore` tag once the feature is ready. Otherwise,
* it will be generated in the documentation.
* @since 2.10.3
* @featureFlag view_configurations
*/
export const GET = async (
req: AuthenticatedMedusaRequest<AdminGetActiveViewConfigurationParamsType>,
@@ -49,11 +46,8 @@ export const GET = async (
}
/**
* @ignore
*
* @privateRemarks
* Remove the `ignore` tag once the feature is ready. Otherwise,
* it will be generated in the documentation.
* @since 2.10.3
* @featureFlag view_configurations
*/
export const POST = async (
req: AuthenticatedMedusaRequest<AdminSetActiveViewConfigurationType>,
@@ -8,11 +8,8 @@ import { MedusaError, Modules } from "@medusajs/framework/utils"
import { createViewConfigurationWorkflow } from "@medusajs/core-flows"
/**
* @ignore
*
* @privateRemarks
* Remove the `ignore` tag once the feature is ready. Otherwise,
* it will be generated in the documentation.
* @since 2.10.3
* @featureFlag view_configurations
*/
export const GET = async (
req: AuthenticatedMedusaRequest<HttpTypes.AdminGetViewConfigurationsParams>,
@@ -41,11 +38,8 @@ export const GET = async (
}
/**
* @ignore
*
* @privateRemarks
* Remove the `ignore` tag once the feature is ready. Otherwise,
* it will be generated in the documentation.
* @since 2.10.3
* @featureFlag view_configurations
*/
export const POST = async (
req: AuthenticatedMedusaRequest<AdminCreateViewConfigurationType>,