Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mshustov committed Aug 19, 2021
1 parent d84d4d8 commit 8890e72
Show file tree
Hide file tree
Showing 10 changed files with 14 additions and 35 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ returns `basePath` value, specific for an incoming request.
<b>Signature:</b>

```typescript
get: (request: KibanaRequest | LegacyRequest) => string;
get: (request: KibanaRequest) => string;
```
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ The constructor for this class is marked as internal. Third-party code should no

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [get](./kibana-plugin-core-server.basepath.get.md) | | <code>(request: KibanaRequest &#124; LegacyRequest) =&gt; string</code> | returns <code>basePath</code> value, specific for an incoming request. |
| [get](./kibana-plugin-core-server.basepath.get.md) | | <code>(request: KibanaRequest) =&gt; string</code> | returns <code>basePath</code> value, specific for an incoming request. |
| [prepend](./kibana-plugin-core-server.basepath.prepend.md) | | <code>(path: string) =&gt; string</code> | Prepends <code>path</code> with the basePath. |
| [publicBaseUrl](./kibana-plugin-core-server.basepath.publicbaseurl.md) | | <code>string</code> | The server's publicly exposed base URL, if configured. Includes protocol, host, port (optional) and the [BasePath.serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md)<!-- -->. |
| [remove](./kibana-plugin-core-server.basepath.remove.md) | | <code>(path: string) =&gt; string</code> | Removes the prepended basePath from the <code>path</code>. |
| [serverBasePath](./kibana-plugin-core-server.basepath.serverbasepath.md) | | <code>string</code> | returns the server's basePath<!-- -->See [BasePath.get](./kibana-plugin-core-server.basepath.get.md) for getting the basePath value for a specific request |
| [set](./kibana-plugin-core-server.basepath.set.md) | | <code>(request: KibanaRequest &#124; LegacyRequest, requestSpecificBasePath: string) =&gt; void</code> | sets <code>basePath</code> value, specific for an incoming request. |
| [set](./kibana-plugin-core-server.basepath.set.md) | | <code>(request: KibanaRequest, requestSpecificBasePath: string) =&gt; void</code> | sets <code>basePath</code> value, specific for an incoming request. |

Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ sets `basePath` value, specific for an incoming request.
<b>Signature:</b>

```typescript
set: (request: KibanaRequest | LegacyRequest, requestSpecificBasePath: string) => void;
set: (request: KibanaRequest, requestSpecificBasePath: string) => void;
```
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Get headers to authenticate a user against Elasticsearch.
<b>Signature:</b>

```typescript
export declare type GetAuthHeaders = (request: KibanaRequest | LegacyRequest) => AuthHeaders | undefined;
export declare type GetAuthHeaders = (request: KibanaRequest) => AuthHeaders | undefined;
```
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Gets authentication state for a request. Returned by `auth` interceptor.
<b>Signature:</b>

```typescript
export declare type GetAuthState = <T = unknown>(request: KibanaRequest | LegacyRequest) => {
export declare type GetAuthState = <T = unknown>(request: KibanaRequest) => {
status: AuthStatus;
state: T;
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Returns authentication status for a request.
<b>Signature:</b>

```typescript
export declare type IsAuthenticated = (request: KibanaRequest | LegacyRequest) => boolean;
export declare type IsAuthenticated = (request: KibanaRequest) => boolean;
```

This file was deleted.

1 change: 0 additions & 1 deletion docs/development/core/server/kibana-plugin-core-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,6 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [IUiSettingsClient](./kibana-plugin-core-server.iuisettingsclient.md) | Server-side client that provides access to the advanced settings stored in elasticsearch. The settings provide control over the behavior of the Kibana application. For example, a user can specify how to display numeric or date fields. Users can adjust the settings via Management UI. |
| [KibanaRequestEvents](./kibana-plugin-core-server.kibanarequestevents.md) | Request events. |
| [KibanaRequestRoute](./kibana-plugin-core-server.kibanarequestroute.md) | Request specific route information exposed to a handler. |
| [LegacyRequest](./kibana-plugin-core-server.legacyrequest.md) | |
| [LoggerContextConfigInput](./kibana-plugin-core-server.loggercontextconfiginput.md) | |
| [LoggingServiceSetup](./kibana-plugin-core-server.loggingservicesetup.md) | Provides APIs to plugins for customizing the plugin's logger. |
| [MetricsServiceSetup](./kibana-plugin-core-server.metricsservicesetup.md) | APIs to retrieves metrics gathered and exposed by the core platform. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ See [KibanaRequest](./kibana-plugin-core-server.kibanarequest.md)<!-- -->.
<b>Signature:</b>

```typescript
export declare type ScopeableRequest = KibanaRequest | LegacyRequest | FakeRequest;
export declare type ScopeableRequest = KibanaRequest | FakeRequest;
```
16 changes: 6 additions & 10 deletions src/core/server/server.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,12 +159,12 @@ export interface AuthToolkit {
export class BasePath {
// @internal
constructor(serverBasePath?: string, publicBaseUrl?: string);
get: (request: KibanaRequest | LegacyRequest) => string;
get: (request: KibanaRequest) => string;
prepend: (path: string) => string;
readonly publicBaseUrl?: string;
remove: (path: string) => string;
readonly serverBasePath: string;
set: (request: KibanaRequest | LegacyRequest, requestSpecificBasePath: string) => void;
set: (request: KibanaRequest, requestSpecificBasePath: string) => void;
}

// Warning: (ae-forgotten-export) The symbol "BootstrapArgs" needs to be exported by the entry point index.d.ts
Expand Down Expand Up @@ -896,10 +896,10 @@ export interface FakeRequest {
}

// @public
export type GetAuthHeaders = (request: KibanaRequest | LegacyRequest) => AuthHeaders | undefined;
export type GetAuthHeaders = (request: KibanaRequest) => AuthHeaders | undefined;

// @public
export type GetAuthState = <T = unknown>(request: KibanaRequest | LegacyRequest) => {
export type GetAuthState = <T = unknown>(request: KibanaRequest) => {
status: AuthStatus;
state: T;
};
Expand Down Expand Up @@ -1137,7 +1137,7 @@ export interface IRouter<Context extends RequestHandlerContext = RequestHandlerC
}

// @public
export type IsAuthenticated = (request: KibanaRequest | LegacyRequest) => boolean;
export type IsAuthenticated = (request: KibanaRequest) => boolean;

// @public (undocumented)
export type ISavedObjectsExporter = PublicMethodsOf<SavedObjectsExporter>;
Expand Down Expand Up @@ -1263,10 +1263,6 @@ export const kibanaResponseFactory: {
// @public
export type KnownHeaders = KnownKeys<IncomingHttpHeaders>;

// @public @deprecated (undocumented)
export interface LegacyRequest extends Request {
}

// Warning: (ae-forgotten-export) The symbol "lifecycleResponseFactory" needs to be exported by the entry point index.d.ts
//
// @public
Expand Down Expand Up @@ -2719,7 +2715,7 @@ export class SavedObjectTypeRegistry {
export type SavedObjectUnsanitizedDoc<T = unknown> = SavedObjectDoc<T> & Partial<Referencable>;

// @public
export type ScopeableRequest = KibanaRequest | LegacyRequest | FakeRequest;
export type ScopeableRequest = KibanaRequest | FakeRequest;

// @public (undocumented)
export interface SearchResponse<T = unknown> {
Expand Down

0 comments on commit 8890e72

Please sign in to comment.