Skip to content

Commit

Permalink
update generated doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@pgayvallet
pgayvallet committed Sep 15, 2020
1 parent 8828c18 commit 9997809
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 145 deletions.
29 changes: 7 additions & 22 deletions src/core/public/public.api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
import { Action } from 'history';
import { ApiResponse } from '@elastic/elasticsearch/lib/Transport';
import Boom from 'boom';
import { ConfigPath } from '@kbn/config';
import { EnvironmentMode } from '@kbn/config';
import { EuiBreadcrumb } from '@elastic/eui';
import { EuiButtonEmptyProps } from '@elastic/eui';
import { EuiConfirmModalProps } from '@elastic/eui';
Expand All @@ -19,8 +21,11 @@ import { KibanaClient } from '@elastic/elasticsearch/api/kibana';
import { KibanaConfigType } from 'src/core/server/kibana_config';
import { Location } from 'history';
import { LocationDescriptorObject } from 'history';
import { Logger } from '@kbn/logging';
import { LogMeta } from '@kbn/logging';
import { MaybePromise } from '@kbn/utility-types';
import { Observable } from 'rxjs';
import { PackageInfo } from '@kbn/config';
import { Path } from 'history';
import { PublicMethodsOf } from '@kbn/utility-types';
import { PublicUiSettingsParams as PublicUiSettingsParams_2 } from 'src/core/server/types';
Expand Down Expand Up @@ -576,15 +581,7 @@ export interface DocLinksStart {
};
}

// @public (undocumented)
export interface EnvironmentMode {
// (undocumented)
dev: boolean;
// (undocumented)
name: 'development' | 'production';
// (undocumented)
prod: boolean;
}
export { EnvironmentMode }

// @public
export interface ErrorToastOptions extends ToastOptions {
Expand Down Expand Up @@ -912,19 +909,7 @@ export interface OverlayStart {
openModal: OverlayModalStart['open'];
}

// @public (undocumented)
export interface PackageInfo {
// (undocumented)
branch: string;
// (undocumented)
buildNum: number;
// (undocumented)
buildSha: string;
// (undocumented)
dist: boolean;
// (undocumented)
version: string;
}
export { PackageInfo }

// @public
export interface Plugin<TSetup = void, TStart = void, TPluginsSetup extends object = object, TPluginsStart extends object = object> {
Expand Down
152 changes: 29 additions & 123 deletions src/core/server/server.api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import { CatSnapshotsParams } from 'elasticsearch';
import { CatTasksParams } from 'elasticsearch';
import { CatThreadPoolParams } from 'elasticsearch';
import { ClearScrollParams } from 'elasticsearch';
import { CliArgs } from '@kbn/config';
import { Client } from 'elasticsearch';
import { ClientOptions } from '@elastic/elasticsearch';
import { ClusterAllocationExplainParams } from 'elasticsearch';
Expand All @@ -31,7 +32,13 @@ import { ClusterPutSettingsParams } from 'elasticsearch';
import { ClusterRerouteParams } from 'elasticsearch';
import { ClusterStateParams } from 'elasticsearch';
import { ClusterStatsParams } from 'elasticsearch';
import { ConfigDeprecation } from '@kbn/config';
import { ConfigDeprecationFactory } from '@kbn/config';
import { ConfigDeprecationLogger } from '@kbn/config';
import { ConfigDeprecationProvider } from '@kbn/config';
import { ConfigOptions } from 'elasticsearch';
import { ConfigPath } from '@kbn/config';
import { ConfigService } from '@kbn/config';
import { CountParams } from 'elasticsearch';
import { CreateDocumentParams } from 'elasticsearch';
import { DeleteDocumentByQueryParams } from 'elasticsearch';
Expand All @@ -40,6 +47,7 @@ import { DeleteScriptParams } from 'elasticsearch';
import { DeleteTemplateParams } from 'elasticsearch';
import { DetailedPeerCertificate } from 'tls';
import { Duration } from 'moment';
import { EnvironmentMode } from '@kbn/config';
import { ExistsParams } from 'elasticsearch';
import { ExplainParams } from 'elasticsearch';
import { FieldStatsParams } from 'elasticsearch';
Expand Down Expand Up @@ -94,6 +102,11 @@ import { IngestPutPipelineParams } from 'elasticsearch';
import { IngestSimulateParams } from 'elasticsearch';
import { KibanaClient } from '@elastic/elasticsearch/api/kibana';
import { KibanaConfigType } from 'src/core/server/kibana_config';
import { Logger } from '@kbn/logging';
import { LoggerFactory } from '@kbn/logging';
import { LogLevel } from '@kbn/logging';
import { LogMeta } from '@kbn/logging';
import { LogRecord } from '@kbn/logging';
import { MGetParams } from 'elasticsearch';
import { MGetResponse } from 'elasticsearch';
import { MSearchParams } from 'elasticsearch';
Expand All @@ -105,6 +118,7 @@ import { NodesInfoParams } from 'elasticsearch';
import { NodesStatsParams } from 'elasticsearch';
import { ObjectType } from '@kbn/config-schema';
import { Observable } from 'rxjs';
import { PackageInfo } from '@kbn/config';
import { PeerCertificate } from 'tls';
import { PingParams } from 'elasticsearch';
import { PutScriptParams } from 'elasticsearch';
Expand Down Expand Up @@ -362,45 +376,17 @@ export const config: {
};
};

// @public
export type ConfigDeprecation = (config: Record<string, any>, fromPath: string, logger: ConfigDeprecationLogger) => Record<string, any>;
export { ConfigDeprecation }

// @public
export interface ConfigDeprecationFactory {
rename(oldKey: string, newKey: string): ConfigDeprecation;
renameFromRoot(oldKey: string, newKey: string, silent?: boolean): ConfigDeprecation;
unused(unusedKey: string): ConfigDeprecation;
unusedFromRoot(unusedKey: string): ConfigDeprecation;
}
export { ConfigDeprecationFactory }

// @public
export type ConfigDeprecationLogger = (message: string) => void;
export { ConfigDeprecationLogger }

// @public
export type ConfigDeprecationProvider = (factory: ConfigDeprecationFactory) => ConfigDeprecation[];
export { ConfigDeprecationProvider }

// @public (undocumented)
export type ConfigPath = string | string[];
export { ConfigPath }

// @internal (undocumented)
export class ConfigService {
// Warning: (ae-forgotten-export) The symbol "RawConfigurationProvider" needs to be exported by the entry point index.d.ts
// Warning: (ae-forgotten-export) The symbol "Env" needs to be exported by the entry point index.d.ts
constructor(rawConfigProvider: RawConfigurationProvider, env: Env, logger: LoggerFactory);
addDeprecationProvider(path: ConfigPath, provider: ConfigDeprecationProvider): void;
atPath<TSchema>(path: ConfigPath): Observable<TSchema>;
// Warning: (ae-forgotten-export) The symbol "Config" needs to be exported by the entry point index.d.ts
getConfig$(): Observable<Config>;
// (undocumented)
getUnusedPaths(): Promise<string[]>;
// (undocumented)
getUsedPaths(): Promise<string[]>;
// (undocumented)
isEnabledAtPath(path: ConfigPath): Promise<boolean>;
optionalAtPath<TSchema>(path: ConfigPath): Observable<TSchema | undefined>;
setSchema(path: ConfigPath, schema: Type<unknown>): Promise<void>;
validate(): Promise<void>;
}
export { ConfigService }

// @public
export interface ContextSetup {
Expand Down Expand Up @@ -672,15 +658,7 @@ export interface ElasticsearchStatusMeta {
warningNodes: NodesVersionCompatibility['warningNodes'];
}

// @public (undocumented)
export interface EnvironmentMode {
// (undocumented)
dev: boolean;
// (undocumented)
name: 'development' | 'production';
// (undocumented)
prod: boolean;
}
export { EnvironmentMode }

// @public
export interface ErrorHttpResponseOptions {
Expand Down Expand Up @@ -1418,18 +1396,7 @@ export interface LegacyUiExports {
// @public
export type LifecycleResponseFactory = typeof lifecycleResponseFactory;

// @public
export interface Logger {
debug(message: string, meta?: LogMeta): void;
error(errorOrMessage: string | Error, meta?: LogMeta): void;
fatal(errorOrMessage: string | Error, meta?: LogMeta): void;
get(...childContextPaths: string[]): Logger;
info(message: string, meta?: LogMeta): void;
// @internal (undocumented)
log(record: LogRecord): void;
trace(message: string, meta?: LogMeta): void;
warn(errorOrMessage: string | Error, meta?: LogMeta): void;
}
export { Logger }

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

// @public
export interface LoggerFactory {
get(...contextParts: string[]): Logger;
}
export { LoggerFactory }

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

// @internal
export class LogLevel {
// (undocumented)
static readonly All: LogLevel;
// (undocumented)
static readonly Debug: LogLevel;
// (undocumented)
static readonly Error: LogLevel;
// (undocumented)
static readonly Fatal: LogLevel;
static fromId(level: LogLevelId): LogLevel;
// Warning: (ae-forgotten-export) The symbol "LogLevelId" needs to be exported by the entry point index.d.ts
//
// (undocumented)
readonly id: LogLevelId;
// (undocumented)
static readonly Info: LogLevel;
// (undocumented)
static readonly Off: LogLevel;
supports(level: LogLevel): boolean;
// (undocumented)
static readonly Trace: LogLevel;
// (undocumented)
readonly value: number;
// (undocumented)
static readonly Warn: LogLevel;
}
export { LogLevel }

// @public
export interface LogMeta {
// (undocumented)
[key: string]: any;
}
export { LogMeta }

// @internal
export interface LogRecord {
// (undocumented)
context: string;
// (undocumented)
error?: Error;
// (undocumented)
level: LogLevel;
// (undocumented)
message: string;
// (undocumented)
meta?: {
[name: string]: any;
};
// (undocumented)
pid: number;
// (undocumented)
timestamp: Date;
}
export { LogRecord }

// @public
export interface MetricsServiceSetup {
Expand Down Expand Up @@ -1665,19 +1581,7 @@ export interface OpsServerMetrics {
};
}

// @public (undocumented)
export interface PackageInfo {
// (undocumented)
branch: string;
// (undocumented)
buildNum: number;
// (undocumented)
buildSha: string;
// (undocumented)
dist: boolean;
// (undocumented)
version: string;
}
export { PackageInfo }

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

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

// @public
export interface PluginManifest {
// Warning: (ae-unresolved-link) The @link reference could not be resolved: Reexported declarations are not supported
readonly configPath: ConfigPath;
// @deprecated
readonly extraPublicDirs?: string[];
Expand Down

0 comments on commit 9997809

Please sign in to comment.