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

Newplatform/data plugin/data plugin deps #3

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
154 commits
Select commit Hold shift + click to select a range
e5f6f9c
kbn top nav in discover
Jun 19, 2019
d5d7e38
New top nav in dashboard and vis editor
Jun 19, 2019
3b97926
change kbn top nav directive
Jun 19, 2019
1ea5b7b
Stop using template feature of kbn top nav
Jun 26, 2019
8a7ba6b
Combined css
Jun 27, 2019
c4b84bf
Merge remote-tracking branch 'upstream/master' into newplatform/kbn-t…
Jun 27, 2019
2e90a18
Merge branch 'newplatform/kbn-top-nav/graph' into newplatform/kbn-top…
Jun 27, 2019
344b055
console top nav
Jun 27, 2019
3c5878b
Removed unnecessary use of kbn-top-nav in dev tools app (wrapping tabs)
Jun 27, 2019
d01d882
Merge branch 'newplatform/kbn-top-nav/devtools-2' into newplatform/kb…
Jun 27, 2019
366b03a
Changed console menu to new directive
Jun 27, 2019
5b0a63d
Merge remote-tracking branch 'upstream/master' into newplatform/kbn-t…
Jun 30, 2019
9599e15
Merge remote-tracking branch 'upstream/master' into newplatform/kbn-t…
Jul 1, 2019
4766510
CSS adjustments + functional implementation of top nav menu item
Jul 1, 2019
b23d0c3
Merge remote-tracking branch 'upstream/master' into newplatform/kbn-t…
Jul 1, 2019
929ed9c
Fixed DevTools top nav toggle
Jul 2, 2019
6adc512
Optional show-border
Jul 2, 2019
0f24457
timelion menu works
Jul 2, 2019
f6906b7
Improve filter sorting logic to be more stable
Jul 3, 2019
c5d3a14
Merge branch 'bug/filter-manager/sorting-logic-failure' into newplatf…
Jul 3, 2019
20a9922
Support showing filter bar as part of top nav
Jul 3, 2019
daf6f98
Use search bar in top nav in discover and maps
Jul 3, 2019
c580fe7
tmp revert
Jul 4, 2019
78ea450
Merge remote-tracking branch 'upstream/master' into newplatform/kbn-t…
Jul 4, 2019
b3711e6
Align search bar settings accross apps
Jul 4, 2019
3117fce
Reverted change in ML, removed unused css
Jul 4, 2019
3cfa5c7
Merge remote-tracking branch 'upstream/master' into newplatform/kbn-t…
Jul 4, 2019
e749bd4
Added data test subj to top nav menu items
Jul 4, 2019
fa5332d
Watch config by value
Jul 4, 2019
833d49f
Some directive magic to make sure that disabledButtons functions are …
Jul 5, 2019
8fee73a
Fix missing controls from new top nav in some visualizations
Jul 7, 2019
cc5dbff
Merge remote-tracking branch 'upstream/master' into newplatform/kbn-t…
Jul 7, 2019
d368c94
showAutoRefreshOnly in input controls visualization
Jul 7, 2019
000eeb2
Fixed inspector disabled test
Jul 7, 2019
efe00bf
Fix dashboard action links
Jul 7, 2019
97496c6
snapshots
Jul 7, 2019
d52e581
Fixed maps filter bar
Jul 7, 2019
8c06d39
Remvoed comment
Jul 7, 2019
afd9933
Merge remote-tracking branch 'upstream/master' into newplatform/kbn-t…
Jul 8, 2019
5f71b4e
Update Query Bar defaults
Jul 8, 2019
86dbbbc
Top nav menu item tests
Jul 8, 2019
e6260ea
Moved storage instantiation to angular directive
Jul 8, 2019
ddcdda0
SearchBar jest tests
Jul 8, 2019
9a68d7a
Query bar additional tests
Jul 8, 2019
c2bc4d3
Top nav menu tests
Jul 8, 2019
144d8bb
Merge remote-tracking branch 'upstream/master' into newplatform/kbn-t…
Jul 8, 2019
247a4f7
Pass store into top nav menu correctly
Jul 9, 2019
e5fb6d8
watch store by reference
Jul 9, 2019
1856e8f
Merge remote-tracking branch 'upstream/master' into newplatform/kbn-t…
Jul 9, 2019
7786fa9
Added not null assertion
Jul 9, 2019
bcb6674
Make index patterns optional (for timepicker only setup)
Jul 9, 2019
60f1643
QueryBar tests again
Jul 9, 2019
d7b9941
Search bar tests
Jul 9, 2019
362d322
Top nav tests
Jul 9, 2019
01b359c
Top nav menu tests
Jul 9, 2019
541c813
removed unnecessary ui/new_platform mock
Jul 9, 2019
d7fe175
Merge remote-tracking branch 'upstream/master' into newplatform/kbn-t…
Jul 10, 2019
caad37f
Merge remote-tracking branch 'upstream/master' into newplatform/kbn-t…
Jul 11, 2019
5cac8c9
Moved discover result count away from top nav
Jul 11, 2019
3316b4a
Moved and improved top nav menu css
Jul 11, 2019
4d64d66
remove unused translations
Jul 11, 2019
0401c7f
Merge remote-tracking branch 'upstream/master' into newplatform/kbn-t…
Jul 14, 2019
df1f06d
Move timepicker (to be deprecated) into old kbn_top_nav
Jul 9, 2019
eaf21a7
Deleted search-bar and query-bar directives!
Jul 11, 2019
cef0742
moved search bar to kibana_react (it's a generic react component, not…
Jul 11, 2019
938c5c0
translations
Jul 11, 2019
83ff3c3
Moved superDatePicker directive to kbn_top_nav (to be deprecated)
Jul 11, 2019
50fc77f
Use index patterns from data plugin itself instead of importing from …
Jul 11, 2019
008bc6f
Pass uiSettings from top level of data plugin
Jul 13, 2019
abaa9dc
Pass saved objects client from top level
Jul 14, 2019
f5ad6ad
query bar input to rely on provided localStorage (?)
Jul 14, 2019
4dba9c2
import QueryBarInput correctly from vis ediror
Jul 14, 2019
2a91ea6
Query bar input tests - uiSettings
Jul 14, 2019
e95bbd2
Query bar - uiSettings tests
Jul 14, 2019
ff36393
import QueryBar from data plugin correctly
Jul 14, 2019
c9850b0
Use provider to pass config to TSVB query bar inputs
Jul 14, 2019
665007a
Add query bar input parms to agg types
Jul 14, 2019
90bbba4
Standardize shape data plugin and use it to pass uiSettings in.
Jul 15, 2019
573a8bc
Removed unnecessary mocks
Jul 15, 2019
d5e07ab
Merge remote-tracking branch 'upstream/master' into newplatform/kbn-t…
Jul 15, 2019
b14dd9f
Fixed test typo
Jul 15, 2019
ff59ab8
Merge remote-tracking branch 'upstream/master' into newplatform/kbn-t…
Jul 17, 2019
209797d
Code review part 1
Jul 17, 2019
37d7a98
Code review part 2 - clean up top nav menu item run interface
Jul 17, 2019
8729b57
Give top nav items better keys
Jul 17, 2019
d6f904f
Simplified top nav construction logic in editor
Jul 17, 2019
d6b1112
Merge branch 'newplatform/kbn-top-nav/new-directive' into newplatform…
Jul 17, 2019
c2ed904
Fixed mock of search bar in top nav test
Jul 17, 2019
c6f6ca5
Merge remote-tracking branch 'upstream/master' into newplatform/kbn-t…
Jul 17, 2019
8881518
Merge remote-tracking branch 'upstream/master' into newplatform/kbn-t…
Jul 17, 2019
0f41c0c
Merge branch 'newplatform/kbn-top-nav/new-directive' into newplatform…
Jul 18, 2019
d127cfd
Moved filter trigger button rendering to helper function
Jul 18, 2019
541a779
Remove responsiveness from top nav items
Jul 18, 2019
a6ba593
vertical align for cases where showSearchBarInline is true
Jul 18, 2019
f5ea79d
Export TopNavMenuData type
Jul 18, 2019
045efb0
Removed unused name attribute in top nav. Use app-name instead.
Jul 18, 2019
b8ff540
Merge branch 'newplatform/kbn-top-nav/new-directive' into newplatform…
Jul 18, 2019
0d34cd1
Merge branch 'newplatform/kbn-top-nav/new-directive-cleanup' into new…
Jul 18, 2019
66e85fc
Merge remote-tracking branch 'upstream/master' into newplatform/data-…
Jul 29, 2019
f9ced92
Minor merge fixes
Jul 29, 2019
5256b3b
Merge remote-tracking branch 'upstream/master' into newplatform/data-…
Jul 30, 2019
672ed4f
Merge new-shape branch in
Jul 30, 2019
a5680b1
Merge branch 'newplatform/data-plugin/new-shape' into newplatform/dat…
Jul 30, 2019
b7691ea
Merge branch 'newplatform/data-plugin/new-shape' into newplatform/dat…
Jul 30, 2019
e20b60c
Merge branch 'newplatform/data-plugin/new-shape' into newplatform/dat…
Jul 31, 2019
92ae0f1
create wrapper for QueryBarInput
alexwizp Jul 31, 2019
144203b
Merge branch 'newplatform/data-plugin/new-shape' into newplatform/dat…
Aug 1, 2019
5f415ab
Merge remote-tracking branch 'upstream/master' into newplatform/data-…
Aug 1, 2019
897fdd2
Changed context provider based on feedback from @alexwizp
Aug 1, 2019
6391caa
Code review fixes
Aug 1, 2019
534df7a
Merge branch 'newplatform/data-plugin/new-shape' into newplatform/dat…
Aug 1, 2019
eeae74a
revert PR 36804 (#42333)
mshustov Aug 1, 2019
818da9a
Refactors action http request and response bodies (#42273)
pmuellr Aug 1, 2019
cf39c7f
inject uiSettings into filter-bar directive
Aug 1, 2019
9bf9ac3
Shape data plugin into standard shim form (#42238)
Aug 1, 2019
a44ca5e
Correct the I18n service definition of euiStat.loadingText (#42354)
chandlerprall Aug 1, 2019
95175e9
[basePathProxy] add __UNSAFE_bypassBasePath route (#41208)
Aug 1, 2019
a19a7fc
Merge remote-tracking branch 'upstream/master' into newplatform/data-…
Aug 1, 2019
569c41f
Fix some type errors
Aug 1, 2019
459514f
[ML] Adding job cloning to new wizards (#42370)
jgowdyelastic Aug 1, 2019
f36cc0b
Expose saved object import/export from core (#42022)
legrego Aug 1, 2019
65faff4
Change http result of action/alerts find api (#42393)
pmuellr Aug 1, 2019
1b465de
Move SearchBar back to data plugin. (#42449)
Aug 1, 2019
d1f75bb
[Reporting/Performance] Convert some RxJS to Typescript (#42102)
tsullivan Aug 1, 2019
269f5a8
Switched order of tests so license downgrade test runs last. (#42312)
Aug 1, 2019
4a60e75
[Reporting/React] Convert setState calls to async in table listing (#…
tsullivan Aug 1, 2019
efcf0df
[Code] Add doc for 7.3 (#42392)
chongzhe Aug 1, 2019
dd75d83
Put filters back in the filter context where they belong (#42095)
Bargs Aug 1, 2019
3562683
Add missing doc for dateNanosFormat (#42459)
kertal Aug 2, 2019
42cd4f3
[ML] Use context and custom hooks to manage legacy dependencies. (#42…
walterra Aug 2, 2019
7c45d58
[Vis Default Editor] Add unit tests for DefaultEditorAgg, DefaultEdit…
maryia-lapata Aug 2, 2019
658ee17
[InfraUI] [LogsUI] Accessibility fixes (#41883)
Kerry350 Aug 2, 2019
a42c12d
[ML] [Job wizards] switching to new kibana context provider (#42512)
jgowdyelastic Aug 2, 2019
e6d4d97
[SIEM] Adds Machine Learning section to 'Using the SIEM UI' docs (#42…
spong Aug 2, 2019
2ad9efe
Add 'task:' prefix to maps and oss vis telemetry _id (#42460)
Aug 2, 2019
0407c7f
[Maps][File upload] Set geojson indexed layer defaults for bounds and…
Aug 2, 2019
b94e94e
Make alerting properly space aware (#42081)
mikecote Aug 2, 2019
39b233a
Inspector 👉 New Platform (#42164)
streamich Aug 2, 2019
a9e0f25
[Logs UI][a11y] Announce name of column on remove column button (#41695)
Zacqary Aug 2, 2019
cf21757
[Infra UI] Add cloud metrics and cloud/host info to metadata endpoint…
simianhacker Aug 2, 2019
4a234b9
Increase max-old-space-size for builds (#42218)
Aug 2, 2019
da99d45
Upgraded EUI 13.0.0 -> 13.1.1 (#42298)
chandlerprall Aug 2, 2019
f4e3915
[ftr/cheerio] improve cheerio types to include test subject me… (#42534)
Aug 2, 2019
2ce39cf
[Infra UI][Logs UI] Fix autocomplete to use proper derived index patt…
simianhacker Aug 2, 2019
f6cb00a
Allow sorting on multiple columns in Discover (#41918)
Bargs Aug 2, 2019
7a89b7a
[DOCS] Updates images and content in Dashboard docs (#42500)
gchaps Aug 2, 2019
d66b3c7
[x-pack/ftr] refactor types to be more accurate/consistent wit… (#42407)
Aug 2, 2019
9fbb95f
[docs][skip ci] Maps read only access (#35561)
kobelb Aug 2, 2019
c9e2a22
[Reporting] Sanitize 409 error log message (#42495)
tsullivan Aug 3, 2019
d394ded
Document HTTP service (#42331)
mshustov Aug 3, 2019
392b8e1
[SIEM] Add chart interactions - update date picker after brush select…
angorayc Aug 3, 2019
15c43b7
Add disk space percentage to node listing (#42145)
cachedout Aug 3, 2019
94151fe
Merge remote-tracking branch 'upstream/master' into newplatform/data-…
Aug 4, 2019
7fdf463
Fixes
Aug 4, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 4 additions & 2 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -186,8 +186,10 @@ module.exports = {
'x-pack/legacy/plugins/apm/**/*.js',
'test/*/config.ts',
'test/visual_regression/tests/**/*',
'x-pack/test/visual_regression/tests/**/*',
'x-pack/test/*/config.ts',
'x-pack/test/*/{tests,test_suites,apis,apps}/**/*',
'x-pack/test/*/*config.*ts',
'x-pack/test/saved_object_api_integration/*/apis/**/*',
'x-pack/test/ui_capabilities/*/tests/**/*',
],
rules: {
'import/no-default-export': 'off',
Expand Down
3 changes: 2 additions & 1 deletion .i18nrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@
"timelion": "src/legacy/core_plugins/timelion",
"tagCloud": "src/legacy/core_plugins/tagcloud",
"tsvb": "src/legacy/core_plugins/metrics",
"kbnESQuery": "packages/kbn-es-query"
"kbnESQuery": "packages/kbn-es-query",
"inspector": "src/plugins/inspector"
},
"exclude": ["src/legacy/ui/ui_render/ui_render_mixin.js"],
"translations": []
Expand Down
5 changes: 5 additions & 0 deletions docs/code/code-basic-nav.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,9 @@ Clicking *Blame* shows the most recent commit per line.
[role="screenshot"]
image::images/code-blame.png[]

[float]
==== Branch selector
You can use the Branch selector to view different branches of a repo. Note that code intelligence and search index are not available for any branch other than master branch.


include::code-semantic-nav.asciidoc[]
4 changes: 4 additions & 0 deletions docs/code/code-install-lang-server.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ You can check the status of the language servers and get installation instructio
[role="screenshot"]
image::images/code-lang-server-status.png[]

[float]
=== Ctag language server
*Code* also uses a Ctag language server to generate symbol information and code intelligence when a dedicated language server is not available. The code intelligence information generated by the Ctag language server is less accurate but covers more languages.



include::code-basic-nav.asciidoc[]
161 changes: 92 additions & 69 deletions docs/dashboard.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,66 +3,84 @@

[partintro]
--
A Kibana _dashboard_ displays a collection of visualizations, searches, and {kibana-ref}/maps.html[maps].
You can arrange, resize, and edit the dashboard content and then save the dashboard
so you can share it.

[role="screenshot"]
image:images/Dashboard_example.png[Example dashboard]
A {kib} _dashboard_ is a collection of visualizations, searches, and
maps, typically in real-time. Dashboards provide
at-a-glance insights into your data and enable you to drill down into details.

--
To start working with dashboards, click *Dashboard* in the side navigation.
With *Dashboard*, you can:

[[dashboard-getting-started]]
== Building a Dashboard
* <<dashboard-create-new-dashboard, Create a dashboard>>
* <<customizing-your-dashboard, Arrange dashboard elements>>
* <<sharing-dashboards, Share a dashboard>>
* <<import-dashboards, Import and export dashboards>>
* <<viewing-detailed-information, Inspect and edit dashboard elements>>


[role="screenshot"]
image:images/Dashboard_example.png[Example dashboard]

If you haven't yet indexed data into {es} or created an index pattern,
you'll be prompted to do so as you follow the steps for creating a dashboard.
Or, you can use one of the prebuilt sample data sets, available from the
Kibana home page.

[float]
[[dashboard-read-only-access]]
=== [xpack]#Read only access#
When you have insufficient privileges to create or save dashboards, the following
indicator in Kibana will be displayed. The buttons to create new dashboards or edit
existing dashboard won't be visible. For more information on granting access to
Kibana see <<xpack-security-authorization>>.
If you see
the read-only icon in the application header,
then you don't have sufficient privileges to create and save dashboards. The buttons to create and edit
dashboards are not visible. For more information, see <<xpack-security-authorization>>.

[role="screenshot"]
image::images/dashboard-read-only-badge.png[Example of Dashboard's read only access indicator in Kibana's header]

[float]
[[dashboard-getting-started]]
=== Interact with dashboards

When you open *Dashhboard*, you're presented an overview of your dashboards.
If you don't have any dashboards, you can add
<<add-sample-data, sample data sets>>,
which include pre-built dashboards.

Once you open a dashboard, you can filter the data
by entering a search query, changing the time filter, or clicking
in the visualizations, searches, and maps. If a dashboard element has a stored query,
both queries are applied.

--

[[dashboard-create-new-dashboard]]
=== Creating a new Dashboard
== Create a dashboard

To create a dashboard, you must have data indexed into {es}, an index pattern
to retrieve the data from {es}, and
visualizations, saved searches, or maps. If these don't exist, you're prompted to
add them as you create the dashboard.

. In the side navigation, click *Dashboard*.
For an end-to-end example, see <<tutorial-build-dashboard, Building your own dashboard>>.

. Open *Dashboard.*
. Click *Create new dashboard.*
. Click *Add*.
. [[adding-visualizations-to-a-dashboard]]Use *Add Panels* to add visualizations
and saved searches to the dashboard. If you have a large number of
visualizations, you can filter the lists.
. Use *Add panels* to add elements to the dashboard.
+
The visualizations, saved searches, and maps
are stored in panels that you can move and resize. A
menu in the upper right of the panel has options for customizing
the panel. You can add elements from
multiple indices, and the same element can appear in multiple dashboards.
+
[role="screenshot"]
image:images/Dashboard_add_visualization.png[Example add visualization to dashboard]

. [[saving-dashboards]]When you're finished adding and arranging the panels,
go to the menu bar and click *Save*.

. In *Save Dashboard*, enter a dashboard title and optionally a description.

. To store the time period specified in the time filter, enable *Store time
with dashboard*.

. Click *Save*.

[[loading-a-saved-dashboard]]
To import, export, and delete dashboards, see <<managing-saved-objects>>.
. When you're finished adding and arranging the panels,
*Save* the dashboard.

[float]
[[customizing-your-dashboard]]
== Arranging Dashboard Elements
=== Arrange dashboard elements

The visualizations and searches in a dashboard are stored in panels that you can move,
resize, edit, and delete. To start editing, click *Edit* in the menu bar.
In *Edit* mode, you can move, resize, customize, and delete panels to suit your needs.

[[moving-containers]]
* To move a panel, click and hold the panel header and drag to the new location.
Expand All @@ -71,53 +89,58 @@ resize, edit, and delete. To start editing, click *Edit* in the menu bar.
* To resize a panel, click the resize control on the lower right and drag
to the new dimensions.

[[removing-containers]]
Additional commands for managing the panel and its contents
are in the gear menu in the upper right.

[role="screenshot"]
image:images/Dashboard_Resize_Menu.png[Example dashboard]
* To toggle the use of margins and panel titles, use the *Options* menu in the upper left.

NOTE: Deleting a panel from a
* To delete a panel, open the panel menu and select *Delete from dashboard.* Deleting a panel from a
dashboard does *not* delete the saved visualization or search.

[[viewing-detailed-information]]
== Inspecting a Visualization from the Dashboard

Many visualizations allow you to inspect the data and requests behind the
visualization.
[float]
[[sharing-dashboards]]
=== Share a dashboard

[[embedding-dashboards]]
When you've finished your dashboard, you can share it with your teammates.
From the *Share* menu, you can:

* Embed the code in a web page. Users must have Kibana access
to view an embedded dashboard.
* Share a direct link to a {kib} dashboard
* Generate a PDF report
* Generate a PNG report

TIP: You can create a link to a dashboard by title by doing this: +
`${domain}/${basepath?}/app/kibana#/dashboards?title=${yourdashboardtitle}`

TIP: When sharing a link to a dashboard snapshot, use the *Short URL*. Snapshot
URLs are long and can be problematic for Internet Explorer and other
tools. To create a short URL, you must have write access to {kib}.

[float]
[[import-dashboards]]
=== Import and export dashboards

In the dashboard, expand the visualization's panel menu (or gear menu if in
*Edit* mode) and select *Inspect*.
To import and export dashboards, go to *Management > Saved Objects*. For details,
see <<managing-saved-objects, Managing saved objects>>.

The initial view shows the underlying data for the visualization. To view the
requests that were made for the visualization, choose *Requests* from the *View*
menu.
[float]
[[viewing-detailed-information]]
=== Inspect and edit elements

The views you'll see depend on the element that you inspect.
Many dashboard elements allow you to drill down into the data and requests
behind the element. Open the menu in the upper right of the panel and select *Inspect*.
The views you see depend on the element that you inspect.

[role="screenshot"]
image:images/Dashboard_visualization_data.png[Example of visualization data]
image:images/Dashboard_inspect.png[Inspect in dashboard]

To open an element for editing, put the dashboard in *Edit* mode,
and then select *Edit* from the panel menu. The changes you make appear in
every dashboard that uses the element.


[[sharing-dashboards]]
== Sharing a Dashboard

You can either share a direct link to a Kibana dashboard,
or embed the dashboard in a web page. Users must have Kibana access
to view an embedded dashboard.

[[embedding-dashboards]]

. Open the dashboard you want to share.
. In the menu bar, click *Share*.
. Copy the link you want to share or the iframe you want to embed. You can
share the live dashboard or a static snapshot of the current point in time.

TIP: You can create a link to a dashboard by title by doing this: +
`${domain}/${basepath?}/app/kibana#/dashboards?title=${yourdashboardtitle}`

TIP: When sharing a link to a dashboard snapshot, use the *Short URL*. Snapshot
URLs are long and can be problematic for Internet Explorer and other
tools. To create a short URL, you must have write access to {kib}.
9 changes: 9 additions & 0 deletions docs/development/core/development-basepath.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,15 @@ To accomplish this the `serve` task does a few things:
- redirects from `/{any}/app/{appName}` to `/{randomBasePath}/app/{appName}` so that refreshes should work
- proxies all requests starting with `/{randomBasePath}/` to the Kibana server

If you're writing scripts that interact with the Kibana API, the base path proxy will likely
make this difficult. To bypass the base path proxy for a single request, prefix urls with
`__UNSAFE_bypassBasePath` and the request will be routed to the development Kibana server.

["source","shell"]
-----------
curl "http://elastic:changeme@localhost:5601/__UNSAFE_bypassBasePath/api/status"
-----------

This proxy can sometimes have unintended side effects in development, so when
needed you can opt out by passing the `--no-base-path` flag to the `serve` task
or `yarn start`.
Expand Down
22 changes: 22 additions & 0 deletions docs/development/core/server/kibana-plugin-server.authstatus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AuthStatus](./kibana-plugin-server.authstatus.md)

## AuthStatus enum

Status indicating an outcome of the authentication.

<b>Signature:</b>

```typescript
export declare enum AuthStatus
```

## Enumeration Members

| Member | Value | Description |
| --- | --- | --- |
| authenticated | <code>&quot;authenticated&quot;</code> | <code>auth</code> interceptor successfully authenticated a user |
| unauthenticated | <code>&quot;unauthenticated&quot;</code> | <code>auth</code> interceptor failed user authentication |
| unknown | <code>&quot;unknown&quot;</code> | <code>auth</code> interceptor has not been registered |

Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ http: {
registerAuth: HttpServiceSetup['registerAuth'];
registerOnPostAuth: HttpServiceSetup['registerOnPostAuth'];
basePath: HttpServiceSetup['basePath'];
createNewServer: HttpServiceSetup['createNewServer'];
isTlsEnabled: HttpServiceSetup['isTlsEnabled'];
};
```
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ export interface CoreSetup
| Property | Type | Description |
| --- | --- | --- |
| [elasticsearch](./kibana-plugin-server.coresetup.elasticsearch.md) | <code>{</code><br/><code> adminClient$: Observable&lt;ClusterClient&gt;;</code><br/><code> dataClient$: Observable&lt;ClusterClient&gt;;</code><br/><code> createClient: (type: string, clientConfig?: Partial&lt;ElasticsearchClientConfig&gt;) =&gt; ClusterClient;</code><br/><code> }</code> | |
| [http](./kibana-plugin-server.coresetup.http.md) | <code>{</code><br/><code> createCookieSessionStorageFactory: HttpServiceSetup['createCookieSessionStorageFactory'];</code><br/><code> registerOnPreAuth: HttpServiceSetup['registerOnPreAuth'];</code><br/><code> registerAuth: HttpServiceSetup['registerAuth'];</code><br/><code> registerOnPostAuth: HttpServiceSetup['registerOnPostAuth'];</code><br/><code> basePath: HttpServiceSetup['basePath'];</code><br/><code> createNewServer: HttpServiceSetup['createNewServer'];</code><br/><code> isTlsEnabled: HttpServiceSetup['isTlsEnabled'];</code><br/><code> }</code> | |
| [http](./kibana-plugin-server.coresetup.http.md) | <code>{</code><br/><code> createCookieSessionStorageFactory: HttpServiceSetup['createCookieSessionStorageFactory'];</code><br/><code> registerOnPreAuth: HttpServiceSetup['registerOnPreAuth'];</code><br/><code> registerAuth: HttpServiceSetup['registerAuth'];</code><br/><code> registerOnPostAuth: HttpServiceSetup['registerOnPostAuth'];</code><br/><code> basePath: HttpServiceSetup['basePath'];</code><br/><code> isTlsEnabled: HttpServiceSetup['isTlsEnabled'];</code><br/><code> }</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [CustomHttpResponseOptions](./kibana-plugin-server.customhttpresponseoptions.md)

## CustomHttpResponseOptions interface

HTTP response parameters for a response with adjustable status code.

<b>Signature:</b>

```typescript
export interface CustomHttpResponseOptions extends HttpResponseOptions
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [statusCode](./kibana-plugin-server.customhttpresponseoptions.statuscode.md) | <code>number</code> | |

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [CustomHttpResponseOptions](./kibana-plugin-server.customhttpresponseoptions.md) &gt; [statusCode](./kibana-plugin-server.customhttpresponseoptions.statuscode.md)

## CustomHttpResponseOptions.statusCode property

<b>Signature:</b>

```typescript
statusCode: number;
```
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 | Request) => AuthHeaders | undefined;
export declare type GetAuthHeaders = (request: KibanaRequest | LegacyRequest) => AuthHeaders | undefined;
```
16 changes: 16 additions & 0 deletions docs/development/core/server/kibana-plugin-server.getauthstate.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [GetAuthState](./kibana-plugin-server.getauthstate.md)

## GetAuthState type

Get authentication state for a request. Returned by `auth` interceptor.

<b>Signature:</b>

```typescript
export declare type GetAuthState = (request: KibanaRequest | LegacyRequest) => {
status: AuthStatus;
state: unknown;
};
```
7 changes: 6 additions & 1 deletion docs/development/core/server/kibana-plugin-server.headers.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,14 @@

## Headers type

Http request headers to read.

<b>Signature:</b>

```typescript
export declare type Headers = Record<string, string | string[] | undefined>;
export declare type Headers = {
[header in KnownHeaders]?: string | string[] | undefined;
} & {
[header: string]: string | string[] | undefined;
};
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [HttpResponseOptions](./kibana-plugin-server.httpresponseoptions.md) &gt; [headers](./kibana-plugin-server.httpresponseoptions.headers.md)

## HttpResponseOptions.headers property

HTTP Headers with additional information about response

<b>Signature:</b>

```typescript
headers?: ResponseHeaders;
```
Loading