Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mshustov committed Mar 4, 2020
1 parent cc3d95c commit e96158b
Show file tree
Hide file tree
Showing 9 changed files with 8 additions and 47 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<b>Signature:</b>

```typescript
export interface AuthNotHandled extends AuthNotHandledResultParams
export interface AuthNotHandled
```

## Properties
Expand Down

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ export interface AuthToolkit
| Property | Type | Description |
| --- | --- | --- |
| [authenticated](./kibana-plugin-server.authtoolkit.authenticated.md) | <code>(data?: AuthResultParams) =&gt; AuthResult</code> | Authentication is successful with given credentials, allow request to pass through |
| [notHandled](./kibana-plugin-server.authtoolkit.nothandled.md) | <code>(data?: AuthNotHandledResultParams) =&gt; AuthResult</code> | User has no credentials |
| [notHandled](./kibana-plugin-server.authtoolkit.nothandled.md) | <code>() =&gt; AuthResult</code> | User has no credentials |

Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ User has no credentials
<b>Signature:</b>

```typescript
notHandled: (data?: AuthNotHandledResultParams) => AuthResult;
notHandled: () => AuthResult;
```
1 change: 0 additions & 1 deletion docs/development/core/server/kibana-plugin-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ The plugin integrates with the core system via lifecycle events: `setup`<!-- -->
| [AssistantAPIClientParams](./kibana-plugin-server.assistantapiclientparams.md) | |
| [Authenticated](./kibana-plugin-server.authenticated.md) | |
| [AuthNotHandled](./kibana-plugin-server.authnothandled.md) | |
| [AuthNotHandledResultParams](./kibana-plugin-server.authnothandledresultparams.md) | Result of unhandled authentication. |
| [AuthResultParams](./kibana-plugin-server.authresultparams.md) | Result of successful authentication. |
| [AuthToolkit](./kibana-plugin-server.authtoolkit.md) | A tool set defining an outcome of Auth interceptor for incoming request. |
| [CallAPIOptions](./kibana-plugin-server.callapioptions.md) | The set of options that defines how API call should be made and result be processed. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
```typescript
core: {
auth: {
isAuthenticated: IsAuthenticated;
isAuthenticated: boolean;
};
rendering: IScopedRenderingClient;
savedObjects: {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ export interface RequestHandlerContext

| Property | Type | Description |
| --- | --- | --- |
| [core](./kibana-plugin-server.requesthandlercontext.core.md) | <code>{</code><br/><code> auth: {</code><br/><code> isAuthenticated: IsAuthenticated;</code><br/><code> };</code><br/><code> rendering: IScopedRenderingClient;</code><br/><code> savedObjects: {</code><br/><code> client: SavedObjectsClientContract;</code><br/><code> };</code><br/><code> elasticsearch: {</code><br/><code> dataClient: IScopedClusterClient;</code><br/><code> adminClient: IScopedClusterClient;</code><br/><code> };</code><br/><code> uiSettings: {</code><br/><code> client: IUiSettingsClient;</code><br/><code> };</code><br/><code> }</code> | |
| [core](./kibana-plugin-server.requesthandlercontext.core.md) | <code>{</code><br/><code> auth: {</code><br/><code> isAuthenticated: boolean;</code><br/><code> };</code><br/><code> rendering: IScopedRenderingClient;</code><br/><code> savedObjects: {</code><br/><code> client: SavedObjectsClientContract;</code><br/><code> };</code><br/><code> elasticsearch: {</code><br/><code> dataClient: IScopedClusterClient;</code><br/><code> adminClient: IScopedClusterClient;</code><br/><code> };</code><br/><code> uiSettings: {</code><br/><code> client: IUiSettingsClient;</code><br/><code> };</code><br/><code> }</code> | |

11 changes: 3 additions & 8 deletions src/core/server/server.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -419,16 +419,11 @@ export type AuthenticationHandler = (request: KibanaRequest, response: Lifecycle
export type AuthHeaders = Record<string, string | string[]>;

// @public (undocumented)
export interface AuthNotHandled extends AuthNotHandledResultParams {
export interface AuthNotHandled {
// (undocumented)
type: AuthResultType.notHandled;
}

// @public
export interface AuthNotHandledResultParams {
responseHeaders?: AuthHeaders;
}

// @public (undocumented)
export type AuthResult = Authenticated | AuthNotHandled;

Expand Down Expand Up @@ -457,7 +452,7 @@ export enum AuthStatus {
// @public
export interface AuthToolkit {
authenticated: (data?: AuthResultParams) => AuthResult;
notHandled: (data?: AuthNotHandledResultParams) => AuthResult;
notHandled: () => AuthResult;
}

// @public
Expand Down Expand Up @@ -1429,7 +1424,7 @@ export interface RequestHandlerContext {
// (undocumented)
core: {
auth: {
isAuthenticated: IsAuthenticated;
isAuthenticated: boolean;
};
rendering: IScopedRenderingClient;
savedObjects: {
Expand Down

0 comments on commit e96158b

Please sign in to comment.