Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate core API docs from TSDoc comments #32148

Merged
merged 46 commits into from
Apr 3, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
46 commits
Select commit Hold shift + click to select a range
a3c0b59
Generate core API docs from TSDoc comments
rudolf Feb 27, 2019
ee431ce
Flesh out API docs a little bit
rudolf Feb 28, 2019
70e25d7
Ignore snake_case check for api-extractor.json
rudolf Feb 28, 2019
8bcc4a2
Ignore api-extractor's review file from pre-commit check
rudolf Feb 28, 2019
4cc5f34
Try to fix build failing by using masters yarn.lock
rudolf Mar 1, 2019
9926ab4
I'm being stupid
rudolf Mar 1, 2019
8a0db42
Found a better home for ignoring common/core_api_review/kibana.api.ts
rudolf Mar 1, 2019
57f56a3
Node script for detecting core API changes
rudolf Mar 1, 2019
a286fca
Fix tslint precommit hook ignore condition
rudolf Mar 4, 2019
5d536cd
Write tsdoc-metadata.json into ./build
rudolf Mar 4, 2019
02cc3ee
Add LogMeta and ElasticSearch to exported types & docs
rudolf Mar 5, 2019
3e26615
Merge branch 'master' into rm-core-api-docs
rudolf Mar 5, 2019
c343f80
Suppress logging when running api-extractor from script
rudolf Mar 5, 2019
720c729
Improve check_core_api_changes script and run as test
rudolf Mar 6, 2019
c7f45a9
Inline api-extractor.json config
rudolf Mar 6, 2019
d45d289
Merge branch 'master' into rm-core-api-docs
rudolf Mar 6, 2019
20384da
Fix check_core_api_changes --help flag
rudolf Mar 7, 2019
1797e1e
LogMeta TSDoc comments
rudolf Mar 7, 2019
dcefd8d
check_core_api_changes: fail if api-extractor produces warnings or er…
rudolf Mar 7, 2019
a738bc9
Merge branch 'master' into rm-core-api-docs
rudolf Mar 10, 2019
e397c9a
Move ignored ts files list into dev/file
rudolf Mar 10, 2019
f19380a
Merge branch 'master' into rm-core-api-docs
rudolf Mar 12, 2019
e73167d
Merge branch 'master' into rm-core-api-docs
rudolf Mar 19, 2019
a487c16
Add back build:types since api-exporter cannot operate on source files
rudolf Mar 19, 2019
77f0cb0
Upgrade api-exporter/documenter
rudolf Mar 21, 2019
2352343
api-extractor: independantly analyze core/public and core/server
rudolf Mar 21, 2019
969e2e3
Build types as part of build task
rudolf Mar 22, 2019
cb5ff8f
Include types in typescript browser compilation
rudolf Mar 22, 2019
0ad507e
Force inclusion of core/public for building types
rudolf Mar 22, 2019
9490881
Merge remote-tracking branch 'upstream/master' into rm-core-api-docs
rudolf Mar 22, 2019
5f6c583
Fix api review filename in api-exporter errors
rudolf Mar 22, 2019
463d13c
Update docs and API review files
rudolf Mar 22, 2019
d3665d8
Fix api-extractor warnings
rudolf Mar 22, 2019
0e15328
Merge branch 'master' into rm-core-api-docs
rudolf Mar 26, 2019
3df7d6b
chore(NA): merge and solve conflicts with last master.
mistic Mar 29, 2019
304e533
Remove ts file ignored list since it's no longer necessary
rudolf Mar 29, 2019
51b8bc1
Rename exported api package name
rudolf Mar 29, 2019
e6660ab
Review comments
rudolf Apr 2, 2019
c325a56
Export other missing types
rudolf Apr 2, 2019
21f5abf
Upgrade api-documenter to latest beta
rudolf Apr 2, 2019
c69c601
Export more missing types
rudolf Apr 2, 2019
74bc082
Fix warnings and add api-exporter to Jenkins tests
rudolf Apr 2, 2019
979c57a
Merge remote-tracking branch 'upstream/master' into rm-core-api-docs
rudolf Apr 3, 2019
0615c25
Correctly handle runBuildTypes() exceptions
rudolf Apr 3, 2019
f64751c
Fix another swallowed exception
rudolf Apr 3, 2019
cfcfb4e
Fix api-extractor warnings after master merge
rudolf Apr 3, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/development/core/public/kibana-plugin-public.basepathsetup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[Home](./index) > [kibana-plugin-public](./kibana-plugin-public.md) > [BasePathSetup](./kibana-plugin-public.basepathsetup.md)

## BasePathSetup type


<b>Signature:</b>

```typescript
export declare type BasePathSetup = ReturnType<BasePathService['setup']>;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBrand](./kibana-plugin-public.chromebrand.md) &gt; [logo](./kibana-plugin-public.chromebrand.logo.md)

## ChromeBrand.logo property

<b>Signature:</b>

```typescript
logo?: string;
```
18 changes: 18 additions & 0 deletions docs/development/core/public/kibana-plugin-public.chromebrand.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBrand](./kibana-plugin-public.chromebrand.md)

## ChromeBrand interface


<b>Signature:</b>

```typescript
export interface ChromeBrand
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [logo](./kibana-plugin-public.chromebrand.logo.md) | <code>string</code> | |
| [smallLogo](./kibana-plugin-public.chromebrand.smalllogo.md) | <code>string</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBrand](./kibana-plugin-public.chromebrand.md) &gt; [smallLogo](./kibana-plugin-public.chromebrand.smalllogo.md)

## ChromeBrand.smallLogo property

<b>Signature:</b>

```typescript
smallLogo?: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) &gt; [data-test-subj](./kibana-plugin-public.chromebreadcrumb.data-test-subj.md)

## ChromeBreadcrumb.data-test-subj property

<b>Signature:</b>

```typescript
'data-test-subj'?: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) &gt; [href](./kibana-plugin-public.chromebreadcrumb.href.md)

## ChromeBreadcrumb.href property

<b>Signature:</b>

```typescript
href?: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md)

## ChromeBreadcrumb interface


<b>Signature:</b>

```typescript
export interface ChromeBreadcrumb
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [data-test-subj](./kibana-plugin-public.chromebreadcrumb.data-test-subj.md) | <code>string</code> | |
| [href](./kibana-plugin-public.chromebreadcrumb.href.md) | <code>string</code> | |
| [text](./kibana-plugin-public.chromebreadcrumb.text.md) | <code>string</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) &gt; [text](./kibana-plugin-public.chromebreadcrumb.text.md)

## ChromeBreadcrumb.text property

<b>Signature:</b>

```typescript
text: string;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeHelpExtension](./kibana-plugin-public.chromehelpextension.md)

## ChromeHelpExtension type


<b>Signature:</b>

```typescript
export declare type ChromeHelpExtension = (element: HTMLDivElement) => (() => void);
```
10 changes: 10 additions & 0 deletions docs/development/core/public/kibana-plugin-public.chromesetup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ChromeSetup](./kibana-plugin-public.chromesetup.md)

## ChromeSetup type


<b>Signature:</b>

```typescript
export declare type ChromeSetup = ReturnType<ChromeService['setup']>;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [basePath](./kibana-plugin-public.coresetup.basepath.md)

## CoreSetup.basePath property

<b>Signature:</b>

```typescript
basePath: BasePathSetup;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [chrome](./kibana-plugin-public.coresetup.chrome.md)

## CoreSetup.chrome property

<b>Signature:</b>

```typescript
chrome: ChromeSetup;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [fatalErrors](./kibana-plugin-public.coresetup.fatalerrors.md)

## CoreSetup.fatalErrors property

<b>Signature:</b>

```typescript
fatalErrors: FatalErrorsSetup;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [http](./kibana-plugin-public.coresetup.http.md)

## CoreSetup.http property

<b>Signature:</b>

```typescript
http: HttpSetup;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [i18n](./kibana-plugin-public.coresetup.i18n.md)

## CoreSetup.i18n property

<b>Signature:</b>

```typescript
i18n: I18nSetup;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [injectedMetadata](./kibana-plugin-public.coresetup.injectedmetadata.md)

## CoreSetup.injectedMetadata property

<b>Signature:</b>

```typescript
injectedMetadata: InjectedMetadataSetup;
```
25 changes: 25 additions & 0 deletions docs/development/core/public/kibana-plugin-public.coresetup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md)

## CoreSetup interface

Core services exposed to the start lifecycle

<b>Signature:</b>

```typescript
export interface CoreSetup
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [basePath](./kibana-plugin-public.coresetup.basepath.md) | <code>BasePathSetup</code> | |
| [chrome](./kibana-plugin-public.coresetup.chrome.md) | <code>ChromeSetup</code> | |
| [fatalErrors](./kibana-plugin-public.coresetup.fatalerrors.md) | <code>FatalErrorsSetup</code> | |
| [http](./kibana-plugin-public.coresetup.http.md) | <code>HttpSetup</code> | |
| [i18n](./kibana-plugin-public.coresetup.i18n.md) | <code>I18nSetup</code> | |
| [injectedMetadata](./kibana-plugin-public.coresetup.injectedmetadata.md) | <code>InjectedMetadataSetup</code> | |
| [notifications](./kibana-plugin-public.coresetup.notifications.md) | <code>NotificationsSetup</code> | |
| [uiSettings](./kibana-plugin-public.coresetup.uisettings.md) | <code>UiSettingsSetup</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [notifications](./kibana-plugin-public.coresetup.notifications.md)

## CoreSetup.notifications property

<b>Signature:</b>

```typescript
notifications: NotificationsSetup;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [CoreSetup](./kibana-plugin-public.coresetup.md) &gt; [uiSettings](./kibana-plugin-public.coresetup.uisettings.md)

## CoreSetup.uiSettings property

<b>Signature:</b>

```typescript
uiSettings: UiSettingsSetup;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md)

## FatalErrorsSetup type


<b>Signature:</b>

```typescript
export declare type FatalErrorsSetup = ReturnType<FatalErrorsService['setup']>;
```
10 changes: 10 additions & 0 deletions docs/development/core/public/kibana-plugin-public.httpsetup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [HttpSetup](./kibana-plugin-public.httpsetup.md)

## HttpSetup type


<b>Signature:</b>

```typescript
export declare type HttpSetup = ReturnType<HttpService['setup']>;
```
10 changes: 10 additions & 0 deletions docs/development/core/public/kibana-plugin-public.i18nsetup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [I18nSetup](./kibana-plugin-public.i18nsetup.md)

## I18nSetup type


<b>Signature:</b>

```typescript
export declare type I18nSetup = ReturnType<I18nService['setup']>;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md)

## InjectedMetadataSetup type


<b>Signature:</b>

```typescript
export declare type InjectedMetadataSetup = ReturnType<InjectedMetadataService['setup']>;
```
35 changes: 35 additions & 0 deletions docs/development/core/public/kibana-plugin-public.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md)

## kibana-plugin-public package

## Classes

| Class | Description |
| --- | --- |
| [ToastsSetup](./kibana-plugin-public.toastssetup.md) | |
| [UiSettingsClient](./kibana-plugin-public.uisettingsclient.md) | |

## Interfaces

| Interface | Description |
| --- | --- |
| [ChromeBrand](./kibana-plugin-public.chromebrand.md) | |
| [ChromeBreadcrumb](./kibana-plugin-public.chromebreadcrumb.md) | |
| [CoreSetup](./kibana-plugin-public.coresetup.md) | Core services exposed to the start lifecycle |
| [UiSettingsState](./kibana-plugin-public.uisettingsstate.md) | |

## Type Aliases

| Type Alias | Description |
| --- | --- |
| [BasePathSetup](./kibana-plugin-public.basepathsetup.md) | |
| [ChromeHelpExtension](./kibana-plugin-public.chromehelpextension.md) | |
| [ChromeSetup](./kibana-plugin-public.chromesetup.md) | |
| [FatalErrorsSetup](./kibana-plugin-public.fatalerrorssetup.md) | |
| [HttpSetup](./kibana-plugin-public.httpsetup.md) | |
| [I18nSetup](./kibana-plugin-public.i18nsetup.md) | |
| [InjectedMetadataSetup](./kibana-plugin-public.injectedmetadatasetup.md) | |
| [NotificationsSetup](./kibana-plugin-public.notificationssetup.md) | |
| [ToastInput](./kibana-plugin-public.toastinput.md) | |
| [UiSettingsSetup](./kibana-plugin-public.uisettingssetup.md) | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [NotificationsSetup](./kibana-plugin-public.notificationssetup.md)

## NotificationsSetup type


<b>Signature:</b>

```typescript
export declare type NotificationsSetup = ReturnType<NotificationsService['setup']>;
```
10 changes: 10 additions & 0 deletions docs/development/core/public/kibana-plugin-public.toastinput.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastInput](./kibana-plugin-public.toastinput.md)

## ToastInput type


<b>Signature:</b>

```typescript
export declare type ToastInput = string | Pick<Toast, Exclude<keyof Toast, 'id'>>;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsSetup](./kibana-plugin-public.toastssetup.md) &gt; [add](./kibana-plugin-public.toastssetup.add.md)

## ToastsSetup.add() method

<b>Signature:</b>

```typescript
add(toastOrTitle: ToastInput): Toast;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| toastOrTitle | <code>ToastInput</code> | |

<b>Returns:</b>

`Toast`

Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsSetup](./kibana-plugin-public.toastssetup.md) &gt; [addDanger](./kibana-plugin-public.toastssetup.adddanger.md)

## ToastsSetup.addDanger() method

<b>Signature:</b>

```typescript
addDanger(toastOrTitle: ToastInput): Toast;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| toastOrTitle | <code>ToastInput</code> | |

<b>Returns:</b>

`Toast`

Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[Home](./index) &gt; [kibana-plugin-public](./kibana-plugin-public.md) &gt; [ToastsSetup](./kibana-plugin-public.toastssetup.md) &gt; [addSuccess](./kibana-plugin-public.toastssetup.addsuccess.md)

## ToastsSetup.addSuccess() method

<b>Signature:</b>

```typescript
addSuccess(toastOrTitle: ToastInput): Toast;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| toastOrTitle | <code>ToastInput</code> | |

<b>Returns:</b>

`Toast`

Loading