Skip to content

Commit 9997809

Browse files
pgayvalletpgayvallet
committed
update generated doc
1 parent 8828c18 commit 9997809

File tree

2 files changed

+36
-145
lines changed

2 files changed

+36
-145
lines changed

‎src/core/public/public.api.md‎

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
import { Action } from 'history';
88
import { ApiResponse } from '@elastic/elasticsearch/lib/Transport';
99
import Boom from 'boom';
10+
import { ConfigPath } from '@kbn/config';
11+
import { EnvironmentMode } from '@kbn/config';
1012
import { EuiBreadcrumb } from '@elastic/eui';
1113
import { EuiButtonEmptyProps } from '@elastic/eui';
1214
import { EuiConfirmModalProps } from '@elastic/eui';
@@ -19,8 +21,11 @@ import { KibanaClient } from '@elastic/elasticsearch/api/kibana';
1921
import { KibanaConfigType } from 'src/core/server/kibana_config';
2022
import { Location } from 'history';
2123
import { LocationDescriptorObject } from 'history';
24+
import { Logger } from '@kbn/logging';
25+
import { LogMeta } from '@kbn/logging';
2226
import { MaybePromise } from '@kbn/utility-types';
2327
import { Observable } from 'rxjs';
28+
import { PackageInfo } from '@kbn/config';
2429
import { Path } from 'history';
2530
import { PublicMethodsOf } from '@kbn/utility-types';
2631
import { PublicUiSettingsParams as PublicUiSettingsParams_2 } from 'src/core/server/types';
@@ -576,15 +581,7 @@ export interface DocLinksStart {
576581
};
577582
}
578583

579-
// @public (undocumented)
580-
export interface EnvironmentMode {
581-
// (undocumented)
582-
dev: boolean;
583-
// (undocumented)
584-
name: 'development' | 'production';
585-
// (undocumented)
586-
prod: boolean;
587-
}
584+
export { EnvironmentMode }
588585

589586
// @public
590587
export interface ErrorToastOptions extends ToastOptions {
@@ -912,19 +909,7 @@ export interface OverlayStart {
912909
openModal: OverlayModalStart['open'];
913910
}
914911

915-
// @public (undocumented)
916-
export interface PackageInfo {
917-
// (undocumented)
918-
branch: string;
919-
// (undocumented)
920-
buildNum: number;
921-
// (undocumented)
922-
buildSha: string;
923-
// (undocumented)
924-
dist: boolean;
925-
// (undocumented)
926-
version: string;
927-
}
912+
export { PackageInfo }
928913

929914
// @public
930915
export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends object = object, TPluginsStart extends object = object> {

‎src/core/server/server.api.md‎

Lines changed: 29 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import { CatSnapshotsParams } from 'elasticsearch';
2121
import { CatTasksParams } from 'elasticsearch';
2222
import { CatThreadPoolParams } from 'elasticsearch';
2323
import { ClearScrollParams } from 'elasticsearch';
24+
import { CliArgs } from '@kbn/config';
2425
import { Client } from 'elasticsearch';
2526
import { ClientOptions } from '@elastic/elasticsearch';
2627
import { ClusterAllocationExplainParams } from 'elasticsearch';
@@ -31,7 +32,13 @@ import { ClusterPutSettingsParams } from 'elasticsearch';
3132
import { ClusterRerouteParams } from 'elasticsearch';
3233
import { ClusterStateParams } from 'elasticsearch';
3334
import { ClusterStatsParams } from 'elasticsearch';
35+
import { ConfigDeprecation } from '@kbn/config';
36+
import { ConfigDeprecationFactory } from '@kbn/config';
37+
import { ConfigDeprecationLogger } from '@kbn/config';
38+
import { ConfigDeprecationProvider } from '@kbn/config';
3439
import { ConfigOptions } from 'elasticsearch';
40+
import { ConfigPath } from '@kbn/config';
41+
import { ConfigService } from '@kbn/config';
3542
import { CountParams } from 'elasticsearch';
3643
import { CreateDocumentParams } from 'elasticsearch';
3744
import { DeleteDocumentByQueryParams } from 'elasticsearch';
@@ -40,6 +47,7 @@ import { DeleteScriptParams } from 'elasticsearch';
4047
import { DeleteTemplateParams } from 'elasticsearch';
4148
import { DetailedPeerCertificate } from 'tls';
4249
import { Duration } from 'moment';
50+
import { EnvironmentMode } from '@kbn/config';
4351
import { ExistsParams } from 'elasticsearch';
4452
import { ExplainParams } from 'elasticsearch';
4553
import { FieldStatsParams } from 'elasticsearch';
@@ -94,6 +102,11 @@ import { IngestPutPipelineParams } from 'elasticsearch';
94102
import { IngestSimulateParams } from 'elasticsearch';
95103
import { KibanaClient } from '@elastic/elasticsearch/api/kibana';
96104
import { KibanaConfigType } from 'src/core/server/kibana_config';
105+
import { Logger } from '@kbn/logging';
106+
import { LoggerFactory } from '@kbn/logging';
107+
import { LogLevel } from '@kbn/logging';
108+
import { LogMeta } from '@kbn/logging';
109+
import { LogRecord } from '@kbn/logging';
97110
import { MGetParams } from 'elasticsearch';
98111
import { MGetResponse } from 'elasticsearch';
99112
import { MSearchParams } from 'elasticsearch';
@@ -105,6 +118,7 @@ import { NodesInfoParams } from 'elasticsearch';
105118
import { NodesStatsParams } from 'elasticsearch';
106119
import { ObjectType } from '@kbn/config-schema';
107120
import { Observable } from 'rxjs';
121+
import { PackageInfo } from '@kbn/config';
108122
import { PeerCertificate } from 'tls';
109123
import { PingParams } from 'elasticsearch';
110124
import { PutScriptParams } from 'elasticsearch';
@@ -362,45 +376,17 @@ export const config: {
362376
};
363377
};
364378

365-
// @public
366-
export type ConfigDeprecation = (config: Record<string, any>, fromPath: string, logger: ConfigDeprecationLogger) => Record<string, any>;
379+
export { ConfigDeprecation }
367380

368-
// @public
369-
export interface ConfigDeprecationFactory {
370-
rename(oldKey: string, newKey: string): ConfigDeprecation;
371-
renameFromRoot(oldKey: string, newKey: string, silent?: boolean): ConfigDeprecation;
372-
unused(unusedKey: string): ConfigDeprecation;
373-
unusedFromRoot(unusedKey: string): ConfigDeprecation;
374-
}
381+
export { ConfigDeprecationFactory }
375382

376-
// @public
377-
export type ConfigDeprecationLogger = (message: string) => void;
383+
export { ConfigDeprecationLogger }
378384

379-
// @public
380-
export type ConfigDeprecationProvider = (factory: ConfigDeprecationFactory) => ConfigDeprecation[];
385+
export { ConfigDeprecationProvider }
381386

382-
// @public (undocumented)
383-
export type ConfigPath = string | string[];
387+
export { ConfigPath }
384388

385-
// @internal (undocumented)
386-
export class ConfigService {
387-
// Warning: (ae-forgotten-export) The symbol "RawConfigurationProvider" needs to be exported by the entry point index.d.ts
388-
// Warning: (ae-forgotten-export) The symbol "Env" needs to be exported by the entry point index.d.ts
389-
constructor(rawConfigProvider: RawConfigurationProvider, env: Env, logger: LoggerFactory);
390-
addDeprecationProvider(path: ConfigPath, provider: ConfigDeprecationProvider): void;
391-
atPath<TSchema>(path: ConfigPath): Observable<TSchema>;
392-
// Warning: (ae-forgotten-export) The symbol "Config" needs to be exported by the entry point index.d.ts
393-
getConfig$(): Observable<Config>;
394-
// (undocumented)
395-
getUnusedPaths(): Promise<string[]>;
396-
// (undocumented)
397-
getUsedPaths(): Promise<string[]>;
398-
// (undocumented)
399-
isEnabledAtPath(path: ConfigPath): Promise<boolean>;
400-
optionalAtPath<TSchema>(path: ConfigPath): Observable<TSchema | undefined>;
401-
setSchema(path: ConfigPath, schema: Type<unknown>): Promise<void>;
402-
validate(): Promise<void>;
403-
}
389+
export { ConfigService }
404390

405391
// @public
406392
export interface ContextSetup {
@@ -672,15 +658,7 @@ export interface ElasticsearchStatusMeta {
672658
warningNodes: NodesVersionCompatibility['warningNodes'];
673659
}
674660

675-
// @public (undocumented)
676-
export interface EnvironmentMode {
677-
// (undocumented)
678-
dev: boolean;
679-
// (undocumented)
680-
name: 'development' | 'production';
681-
// (undocumented)
682-
prod: boolean;
683-
}
661+
export { EnvironmentMode }
684662

685663
// @public
686664
export interface ErrorHttpResponseOptions {
@@ -1418,18 +1396,7 @@ export interface LegacyUiExports {
14181396
// @public
14191397
export type LifecycleResponseFactory = typeof lifecycleResponseFactory;
14201398

1421-
// @public
1422-
export interface Logger {
1423-
debug(message: string, meta?: LogMeta): void;
1424-
error(errorOrMessage: string | Error, meta?: LogMeta): void;
1425-
fatal(errorOrMessage: string | Error, meta?: LogMeta): void;
1426-
get(...childContextPaths: string[]): Logger;
1427-
info(message: string, meta?: LogMeta): void;
1428-
// @internal (undocumented)
1429-
log(record: LogRecord): void;
1430-
trace(message: string, meta?: LogMeta): void;
1431-
warn(errorOrMessage: string | Error, meta?: LogMeta): void;
1432-
}
1399+
export { Logger }
14331400

14341401
// Warning: (ae-forgotten-export) The symbol "loggerSchema" needs to be exported by the entry point index.d.ts
14351402
//
@@ -1444,69 +1411,18 @@ export interface LoggerContextConfigInput {
14441411
loggers?: LoggerConfigType[];
14451412
}
14461413

1447-
// @public
1448-
export interface LoggerFactory {
1449-
get(...contextParts: string[]): Logger;
1450-
}
1414+
export { LoggerFactory }
14511415

14521416
// @public
14531417
export interface LoggingServiceSetup {
14541418
configure(config$: Observable<LoggerContextConfigInput>): void;
14551419
}
14561420

1457-
// @internal
1458-
export class LogLevel {
1459-
// (undocumented)
1460-
static readonly All: LogLevel;
1461-
// (undocumented)
1462-
static readonly Debug: LogLevel;
1463-
// (undocumented)
1464-
static readonly Error: LogLevel;
1465-
// (undocumented)
1466-
static readonly Fatal: LogLevel;
1467-
static fromId(level: LogLevelId): LogLevel;
1468-
// Warning: (ae-forgotten-export) The symbol "LogLevelId" needs to be exported by the entry point index.d.ts
1469-
//
1470-
// (undocumented)
1471-
readonly id: LogLevelId;
1472-
// (undocumented)
1473-
static readonly Info: LogLevel;
1474-
// (undocumented)
1475-
static readonly Off: LogLevel;
1476-
supports(level: LogLevel): boolean;
1477-
// (undocumented)
1478-
static readonly Trace: LogLevel;
1479-
// (undocumented)
1480-
readonly value: number;
1481-
// (undocumented)
1482-
static readonly Warn: LogLevel;
1483-
}
1421+
export { LogLevel }
14841422

1485-
// @public
1486-
export interface LogMeta {
1487-
// (undocumented)
1488-
[key: string]: any;
1489-
}
1423+
export { LogMeta }
14901424

1491-
// @internal
1492-
export interface LogRecord {
1493-
// (undocumented)
1494-
context: string;
1495-
// (undocumented)
1496-
error?: Error;
1497-
// (undocumented)
1498-
level: LogLevel;
1499-
// (undocumented)
1500-
message: string;
1501-
// (undocumented)
1502-
meta?: {
1503-
[name: string]: any;
1504-
};
1505-
// (undocumented)
1506-
pid: number;
1507-
// (undocumented)
1508-
timestamp: Date;
1509-
}
1425+
export { LogRecord }
15101426

15111427
// @public
15121428
export interface MetricsServiceSetup {
@@ -1665,19 +1581,7 @@ export interface OpsServerMetrics {
16651581
};
16661582
}
16671583

1668-
// @public (undocumented)
1669-
export interface PackageInfo {
1670-
// (undocumented)
1671-
branch: string;
1672-
// (undocumented)
1673-
buildNum: number;
1674-
// (undocumented)
1675-
buildSha: string;
1676-
// (undocumented)
1677-
dist: boolean;
1678-
// (undocumented)
1679-
version: string;
1680-
}
1584+
export { PackageInfo }
16811585

16821586
// @public
16831587
export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends object = object, TPluginsStart extends object = object> {
@@ -1691,6 +1595,7 @@ export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends obje
16911595

16921596
// @public
16931597
export interface PluginConfigDescriptor<T = any> {
1598+
// Warning: (ae-unresolved-link) The @link reference could not be resolved: Reexported declarations are not supported
16941599
deprecations?: ConfigDeprecationProvider;
16951600
exposeToBrowser?: {
16961601
[P in keyof T]?: boolean;
@@ -1728,6 +1633,7 @@ export interface PluginInitializerContext<ConfigSchema = unknown> {
17281633

17291634
// @public
17301635
export interface PluginManifest {
1636+
// Warning: (ae-unresolved-link) The @link reference could not be resolved: Reexported declarations are not supported
17311637
readonly configPath: ConfigPath;
17321638
// @deprecated
17331639
readonly extraPublicDirs?: string[];

0 commit comments

Comments
 (0)