Skip to content

Commit 627d071

Browse files
authored
[8.19] [Docs] Replace @private with @internal (elastic#224835) (elastic#224940)
# Backport This will backport the following commits from `main` to `8.19`: - [[Docs] Replace `@private` with `@internal` (elastic#224835)](elastic#224835) <!--- Backport version: 10.0.1 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Alejandro Fernández Haro","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-06-23T17:59:17Z","message":"[Docs] Replace `@private` with `@internal` (elastic#224835)","sha":"474f8480b7c91573afd6772c94dc9d63c122f069","branchLabelMapping":{"^v9.1.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Core","Team:Operations","Team:Security","Team:Monitoring",":ml","Team:Presentation","Feature:ExpressionLanguage","Team:Visualizations","Team:Kibana Management","release_note:skip","Team:Fleet","Team: SecuritySolution","Team:Defend Workflows","Team:DataDiscovery","Team:ML","Team:SharedUX","Team:ESQL","backport:version","v9.1.0","v8.19.0"],"title":"[Docs] Replace `@private` with `@internal`","number":224835,"url":"https://github.com/elastic/kibana/pull/224835","mergeCommit":{"message":"[Docs] Replace `@private` with `@internal` (elastic#224835)","sha":"474f8480b7c91573afd6772c94dc9d63c122f069"}},"sourceBranch":"main","suggestedTargetBranches":["8.19"],"targetPullRequestStates":[{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/224835","number":224835,"mergeCommit":{"message":"[Docs] Replace `@private` with `@internal` (elastic#224835)","sha":"474f8480b7c91573afd6772c94dc9d63c122f069"}},{"branch":"8.19","label":"v8.19.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT-->
1 parent a7fb669 commit 627d071

File tree

82 files changed

+121
-121
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+121
-121
lines changed

src/core/packages/analytics/browser-internal/src/analytics_service.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ export class AnalyticsService {
8989

9090
/**
9191
* Enriches the events with a session_id, so we can correlate them and understand funnels.
92-
* @private
92+
* @internal
9393
*/
9494
private registerSessionIdContext() {
9595
this.analyticsClient.registerContextProvider({
@@ -107,7 +107,7 @@ export class AnalyticsService {
107107
/**
108108
* Enriches the event with the build information.
109109
* @param core The core context.
110-
* @private
110+
* @internal
111111
*/
112112
private registerBuildInfoAnalyticsContext(core: CoreContext) {
113113
this.analyticsClient.registerContextProvider({
@@ -142,7 +142,7 @@ export class AnalyticsService {
142142

143143
/**
144144
* Enriches events with the current Browser's information
145-
* @private
145+
* @internal
146146
*/
147147
private registerBrowserInfoAnalyticsContext() {
148148
this.analyticsClient.registerContextProvider({
@@ -175,7 +175,7 @@ export class AnalyticsService {
175175
/**
176176
* Enriches the events with the Elasticsearch info (cluster name, uuid and version).
177177
* @param injectedMetadata The injected metadata service.
178-
* @private
178+
* @internal
179179
*/
180180
private registerElasticsearchInfoContext(injectedMetadata: InternalInjectedMetadataSetup) {
181181
this.analyticsClient.registerContextProvider({

src/core/packages/analytics/server-internal/src/analytics_service.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ export class AnalyticsService {
7474
/**
7575
* Enriches the event with the build information.
7676
* @param core The core context.
77-
* @private
77+
* @internal
7878
*/
7979
private registerBuildInfoAnalyticsContext(core: CoreContext) {
8080
this.analyticsClient.registerContextProvider({

src/core/packages/apps/server-internal/src/core_app.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ export class CoreAppsService {
296296
* Registers the HTTP API that allows updating in-memory the settings that opted-in to be dynamically updatable.
297297
* @param router {@link IRouter}
298298
* @param savedObjectClient$ An observable of a {@link SavedObjectsClientContract | savedObjects client} that will be used to update the document
299-
* @private
299+
* @internal
300300
*/
301301
private registerInternalCoreSettingsRoute(
302302
router: IRouter,

src/core/packages/chrome/browser-internal/src/register_analytics_context_provider.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import type { AnalyticsServiceSetup } from '@kbn/core-analytics-browser';
1414
* Registers the Analytics context provider to enrich events with the page title.
1515
* @param analytics Analytics service.
1616
* @param pageTitle$ Observable emitting the page title.
17-
* @private
17+
* @internal
1818
*/
1919
export function registerAnalyticsContextProvider(
2020
analytics: AnalyticsServiceSetup,

src/core/packages/config/server-internal/src/ensure_valid_configuration.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ const legacyInvalidConfigExitCode = 64;
1818
/**
1919
* Parameters for the helper {@link ensureValidConfiguration}
2020
*
21-
* @private
21+
* @internal
2222
*/
2323
export interface EnsureValidConfigurationParameters extends ConfigValidateParameters {
2424
/**
@@ -32,7 +32,7 @@ export interface EnsureValidConfigurationParameters extends ConfigValidateParame
3232
* @param configService The {@link IConfigService} instance that has the raw configuration preloaded.
3333
* @param params {@link EnsureValidConfigurationParameters | Options} to enable/disable extra edge-cases.
3434
*
35-
* @private
35+
* @internal
3636
*/
3737
export async function ensureValidConfiguration(
3838
configService: IConfigService,

src/core/packages/elasticsearch/server-internal/src/get_cluster_info.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import type { Observable } from 'rxjs';
1111
import { defer, map, retry, shareReplay } from 'rxjs';
1212
import type { ElasticsearchClient } from '@kbn/core-elasticsearch-server';
1313

14-
/** @private */
14+
/** @internal */
1515
export interface ClusterInfo {
1616
cluster_name: string;
1717
cluster_uuid: string;
@@ -22,7 +22,7 @@ export interface ClusterInfo {
2222
/**
2323
* Returns the cluster info from the Elasticsearch cluster.
2424
* @param internalClient Elasticsearch client
25-
* @private
25+
* @internal
2626
*/
2727
export function getClusterInfo$(internalClient: ElasticsearchClient): Observable<ClusterInfo> {
2828
return defer(() => internalClient.info()).pipe(

src/core/packages/elasticsearch/server-internal/src/register_analytics_context_provider.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import type { ClusterInfo } from './get_cluster_info';
1515
* Registers the Analytics context provider to enrich events with the cluster info.
1616
* @param analytics Analytics service.
1717
* @param context$ Observable emitting the cluster info.
18-
* @private
18+
* @internal
1919
*/
2020
export function registerAnalyticsContextProvider(
2121
analytics: AnalyticsServiceSetup,

src/core/packages/execution-context/browser-internal/src/execution_context_service.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ export class ExecutionContextService
116116
/**
117117
* Sets the analytics context provider based on the execution context details.
118118
* @param analytics The analytics service
119-
* @private
119+
* @internal
120120
*/
121121
private enrichAnalyticsContext(analytics: AnalyticsServiceSetup) {
122122
analytics.registerContextProvider({

src/core/packages/pricing/common/src/pricing_tiers_client.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export class PricingTiersClient implements IPricingTiersClient {
3737
*
3838
* @param product - The product to check
3939
* @returns True if the product is active, false otherwise
40-
* @private
40+
* @internal
4141
*/
4242
private isActiveProduct = (product: PricingProduct) => {
4343
return Boolean(this.tiers.products?.some((currentProduct) => isEqual(currentProduct, product)));
@@ -47,7 +47,7 @@ export class PricingTiersClient implements IPricingTiersClient {
4747
* Checks if pricing tiers are enabled in the current configuration.
4848
*
4949
* @returns True if pricing tiers are enabled, false otherwise
50-
* @private
50+
* @internal
5151
*/
5252
private isEnabled = () => {
5353
return this.tiers.enabled;

src/core/packages/pricing/common/src/product_features_registry.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import { PricingProductFeature } from './types';
1818
export class ProductFeaturesRegistry {
1919
/**
2020
* Internal storage for registered product features.
21-
* @private
21+
* @internal
2222
*/
2323
private readonly productFeatures: Map<string, PricingProductFeature>;
2424

0 commit comments

Comments
 (0)