updated doc comments

elastic · Nov 8, 2023 · d9bf5a5 · d9bf5a5
1 parent 552e87b
commit d9bf5a5
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 24 deletions.
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
@@ -15,15 +15,15 @@ import type {
 
 export type Method = Exclude<RouteMethod, 'options'>;
 
-/** @experimental */
+/** @internal */
 export interface VersionedRouterRoute {
-  /** @experimental */
+  /** @internal */
   method: string;
-  /** @experimental */
+  /** @internal */
   path: string;
-  /** @experimental */
+  /** @internal */
   options: VersionedRouteConfig<RouteMethod>;
-  /** @experimental */
+  /** @internal */
   handlers: Array<{
     fn: RequestHandler;
     options: AddVersionOpts<unknown, unknown, unknown>;

diff --git 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<Method extends RouteMethod> = Omit<
   RouteConfig<unknown, unknown, unknown, Method>,
@@ -49,7 +49,7 @@ export type VersionedRouteConfig<Method extends RouteMethod> = 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<Method extends RouteMethod> = Omit<
  *
  * @param config - The route configuration
  * @returns A versioned route
- * @experimental
+ * @public
  */
 export type VersionedRouteRegistrar<Method extends RouteMethod, Ctx extends RqCtx = RqCtx> = (
   config: VersionedRouteConfig<Method>
@@ -155,85 +155,85 @@ export type VersionedRouteRegistrar<Method extends RouteMethod, Ctx extends RqCt
  *     }
  *   );
 
- * @experimental
+ * @public
  */
 export interface VersionedRouter<Ctx extends RqCtx = RqCtx> {
   /**
-   * @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<P, Q, B> = RouteValidatorFullConfig<P, Q, B>;
 
-/** @experimental */
+/** @public */
 export interface VersionedRouteResponseValidation {
   [statusCode: number]: { body: RouteValidationFunction<unknown> | Type<unknown> };
   unsafe?: { body?: boolean };
 }
 
 /**
  * Versioned route validation
- * @experimental
+ * @public
  */
 export interface FullValidationConfig<P, Q, B> {
   /**
    * Validation to run against route inputs: params, query and body
-   * @experimental
+   * @public
    */
   request?: VersionedRouteRequestValidation<P, Q, B>;
   /**
    * 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;
 }
 
 /**
  * Options for a versioned route. Probably needs a lot more options like sunsetting
  * of an endpoint etc.
- * @experimental
+ * @public
  */
 export interface AddVersionOpts<P, Q, B> {
   /**
    * Version to assign to this route
-   * @experimental
+   * @public
    */
   version: ApiVersion;
   /**
    * Validation for this version of a route
-   * @experimental
+   * @public
    */
   validate: false | FullValidationConfig<P, Q, B>;
 }
 
 /**
  * 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<P = unknown, Q = unknown, B = unknown>(
     options: AddVersionOpts<P, Q, B>,