diff --git a/packages/core/http/core-http-router-server-internal/src/versioned_router/types.ts b/packages/core/http/core-http-router-server-internal/src/versioned_router/types.ts index 4004004036c53c..b085593cb0a5e3 100644 --- a/packages/core/http/core-http-router-server-internal/src/versioned_router/types.ts +++ b/packages/core/http/core-http-router-server-internal/src/versioned_router/types.ts @@ -15,15 +15,15 @@ import type { export type Method = Exclude; -/** @experimental */ +/** @internal */ export interface VersionedRouterRoute { - /** @experimental */ + /** @internal */ method: string; - /** @experimental */ + /** @internal */ path: string; - /** @experimental */ + /** @internal */ options: VersionedRouteConfig; - /** @experimental */ + /** @internal */ handlers: Array<{ fn: RequestHandler; options: AddVersionOpts; diff --git a/packages/core/http/core-http-server/src/versioning/types.ts b/packages/core/http/core-http-server/src/versioning/types.ts index 265a99eb33db7c..f295fbaf0e5347 100644 --- a/packages/core/http/core-http-server/src/versioning/types.ts +++ b/packages/core/http/core-http-server/src/versioning/types.ts @@ -26,7 +26,7 @@ export type { ApiVersion }; /** * Configuration for a versioned route - * @experimental + * @public */ export type VersionedRouteConfig = Omit< RouteConfig, @@ -49,7 +49,7 @@ export type VersionedRouteConfig = Omit< * @note When enabled `apiVersion` is a reserved query parameter and will not * be passed to the route handler or handler validation. * @note `apiVersion` is a reserved query parameter, avoid using it - * @experimental + * @public * @default false */ enableQueryVersion?: boolean; @@ -60,7 +60,7 @@ export type VersionedRouteConfig = Omit< * * @param config - The route configuration * @returns A versioned route - * @experimental + * @public */ export type VersionedRouteRegistrar = ( config: VersionedRouteConfig @@ -155,40 +155,40 @@ export type VersionedRouteRegistrar { /** - * @experimental + * @public * @track-adoption */ get: VersionedRouteRegistrar<'get', Ctx>; /** - * @experimental + * @public * @track-adoption */ put: VersionedRouteRegistrar<'put', Ctx>; /** - * @experimental + * @public * @track-adoption */ post: VersionedRouteRegistrar<'post', Ctx>; /** - * @experimental + * @public * @track-adoption */ patch: VersionedRouteRegistrar<'patch', Ctx>; /** - * @experimental + * @public * @track-adoption */ delete: VersionedRouteRegistrar<'delete', Ctx>; } -/** @experimental */ +/** @public */ export type VersionedRouteRequestValidation = RouteValidatorFullConfig; -/** @experimental */ +/** @public */ export interface VersionedRouteResponseValidation { [statusCode: number]: { body: RouteValidationFunction | Type }; unsafe?: { body?: boolean }; @@ -196,19 +196,19 @@ export interface VersionedRouteResponseValidation { /** * Versioned route validation - * @experimental + * @public */ export interface FullValidationConfig { /** * Validation to run against route inputs: params, query and body - * @experimental + * @public */ request?: VersionedRouteRequestValidation; /** * Validation to run against route output * @note This validation is only intended to run in development. Do not use this * for setting default values! - * @experimental + * @public */ response?: VersionedRouteResponseValidation; } @@ -216,24 +216,24 @@ export interface FullValidationConfig { /** * Options for a versioned route. Probably needs a lot more options like sunsetting * of an endpoint etc. - * @experimental + * @public */ export interface AddVersionOpts { /** * Version to assign to this route - * @experimental + * @public */ version: ApiVersion; /** * Validation for this version of a route - * @experimental + * @public */ validate: false | FullValidationConfig; } /** * A versioned route - * @experimental + * @public */ export interface VersionedRoute< Method extends RouteMethod = RouteMethod, @@ -244,7 +244,7 @@ export interface VersionedRoute< * @param opts {@link AddVersionOpts | Options} for this version of a route * @param handler The request handler for this version of a route * @returns A versioned route, allows for fluent chaining of version declarations - * @experimental + * @public */ addVersion

( options: AddVersionOpts,