Skip to content

Commit

Permalink
[DOCS] API intro (#47164)
Browse files Browse the repository at this point in the history
* [DOCS] API intro

* Logstash configuration management

* Reformatting

* Comments from Josh

* Commets from Gail

* Fixed broken things
  • Loading branch information
KOTungseth authored Oct 16, 2019
1 parent 47fef4e commit 1e3f143
Show file tree
Hide file tree
Showing 37 changed files with 433 additions and 377 deletions.
17 changes: 17 additions & 0 deletions docs/api/dashboard-api.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[[dashboard-api]]
== Import and export dashboard APIs

Import and export dashboards with the corresponding saved objects, such as visualizations, saved
searches, and index patterns.

WARNING: Do not write documents directly to the `.kibana` index. When you write directly
to the `.kibana` index, the data becomes corrupted and permanently breaks future {kib} versions.

The following import and export dashboard APIs are available:

* <<dashboard-import-api, Import dashboard API>> to import dashboards and corresponding saved objects

* <<dashboard-api-export, Export dashboard API>> to export dashboards and corresponding saved objects

include::dashboard/import-dashboard.asciidoc[]
include::dashboard/export-dashboard.asciidoc[]
14 changes: 0 additions & 14 deletions docs/api/dashboard-import.asciidoc

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[dashboard-api-export]]
=== Export dashboard API
++++
<titleabbrev>Dashboard export</titleabbrev>
<titleabbrev>Export dashboard</titleabbrev>
++++

experimental[] Export dashboards and corresponding saved objects.
Expand All @@ -21,7 +21,7 @@ experimental[] Export dashboards and corresponding saved objects.
==== Response body

`objects`::
(array) A top level property that includes the saved objects. The order of the objects is not guaranteed. Use the exact response body as the request body for the corresponding <<dashboard-import-api-import, Import dashboard API>>.
(array) A top level property that includes the saved objects. The order of the objects is not guaranteed. Use the exact response body as the request body for the corresponding <<dashboard-import-api, Import dashboard API>>.

[[dashboard-api-export-codes]]
==== Response code
Expand All @@ -39,4 +39,4 @@ GET api/kibana/dashboards/export?dashboard=942dcef0-b2cd-11e8-ad8e-85441f0c2e5c
--------------------------------------------------
// KIBANA

<1> In this example, `942dcef0-b2cd-11e8-ad8e-85441f0c2e5c` is the dashboard ID.
<1> The dashboard ID is `942dcef0-b2cd-11e8-ad8e-85441f0c2e5c`.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[[dashboard-import-api-import]]
[[dashboard-import-api]]
=== Import dashboard API
++++
<titleabbrev>Import dashboard</titleabbrev>
Expand Down
218 changes: 213 additions & 5 deletions docs/api/features.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,217 @@
[role="xpack"]
[[features-api]]
== Features API
[[features-api-get]]
== Get features API

View information about the available features in {kib}. Features are used by spaces and security to refine and secure access to {kib}.
experimental[] Retrieves all {kib} features. Features are used by spaces and security to refine and secure access to {kib}.

* <<features-api-get, Get features API>>
[float]
[[features-api-get-request]]
=== Request

include::features/get.asciidoc[]
`GET /api/features`

[float]
[[features-api-get-codes]]
=== Response code

`200`::
Indicates a successful call.

[float]
[[features-api-get-example]]
=== Example

The API returns the following:

[source,js]
--------------------------------------------------
{
"id": "discover",
"name": "Discover",
"icon": "discoverApp",
"navLinkId": "kibana:discover",
"app": [
"kibana"
],
"catalogue": [
"discover"
],
"privileges": {
"all": {
"savedObject": {
"all": [
"search",
"url"
],
"read": [
"config",
"index-pattern"
]
},
"ui": [
"show",
"createShortUrl",
"save"
]
},
"read": {
"savedObject": {
"all": [],
"read": [
"config",
"index-pattern",
"search",
"url"
]
},
"ui": [
"show"
]
}
}
},
{
"id": "visualize",
"name": "Visualize",
"icon": "visualizeApp",
"navLinkId": "kibana:visualize",
"app": [
"kibana"
],
"catalogue": [
"visualize"
],
"privileges": {
"all": {
"savedObject": {
"all": [
"visualization",
"url"
],
"read": [
"config",
"index-pattern",
"search"
]
},
"ui": [
"show",
"createShortUrl",
"delete",
"save"
]
},
"read": {
"savedObject": {
"all": [],
"read": [
"config",
"index-pattern",
"search",
"visualization"
]
},
"ui": [
"show"
]
}
}
},
{
"id": "dashboard",
"name": "Dashboard",
"icon": "dashboardApp",
"navLinkId": "kibana:dashboard",
"app": [
"kibana"
],
"catalogue": [
"dashboard"
],
"privileges": {
"all": {
"savedObject": {
"all": [
"dashboard",
"url"
],
"read": [
"config",
"index-pattern",
"search",
"visualization",
"timelion-sheet",
"canvas-workpad"
]
},
"ui": [
"createNew",
"show",
"showWriteControls"
]
},
"read": {
"savedObject": {
"all": [],
"read": [
"config",
"index-pattern",
"search",
"visualization",
"timelion-sheet",
"canvas-workpad",
"dashboard"
]
},
"ui": [
"show"
]
}
}
},
{
"id": "dev_tools",
"name": "Dev Tools",
"icon": "devToolsApp",
"navLinkId": "kibana:dev_tools",
"app": [
"kibana"
],
"catalogue": [
"console",
"searchprofiler",
"grokdebugger"
],
"privileges": {
"all": {
"api": [
"console"
],
"savedObject": {
"all": [],
"read": [
"config"
]
},
"ui": [
"show"
]
},
"read": {
"api": [
"console"
],
"savedObject": {
"all": [],
"read": [
"config"
]
},
"ui": [
"show"
]
}
},
"privilegesTooltip": "User should also be granted the appropriate Elasticsearch cluster and index privileges"
},
--------------------------------------------------
Loading

0 comments on commit 1e3f143

Please sign in to comment.