From 2a56fb976499524177e0128c062cb09959247283 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Wed, 22 May 2019 10:28:24 +0200 Subject: [PATCH] [DOCS] Completed warning text. (#36672) --- docs/api/role-management.asciidoc | 6 +++--- docs/api/role-management/delete.asciidoc | 2 +- docs/api/role-management/get.asciidoc | 6 +++--- docs/api/role-management/put.asciidoc | 10 +++++----- docs/api/spaces-management.asciidoc | 2 +- docs/api/spaces-management/delete.asciidoc | 2 +- docs/api/spaces-management/get.asciidoc | 6 +++--- docs/api/spaces-management/post.asciidoc | 4 ++-- docs/api/spaces-management/put.asciidoc | 4 ++-- 9 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/api/role-management.asciidoc b/docs/api/role-management.asciidoc index ded9db75e615..2f4aa75d46d3 100644 --- a/docs/api/role-management.asciidoc +++ b/docs/api/role-management.asciidoc @@ -2,12 +2,12 @@ [[role-management-api]] == Kibana Role Management API -experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying mechanism of enforcing role based access control is stable, but the APIs for managing the roles are currently experimental.] +experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying mechanism of enforcing role based access control is stable, but the APIs for managing the roles are currently experimental."] The role management API allows people to manage roles that grant <>. It is *not* supported to do so using the -{ref}/security-api.html#security-role-apis[{es} role management APIs], and doing -so will likely cause {kib}'s authorization to behave unexpectedly. +{ref}/security-api.html#security-role-apis[{es} role management APIs], and doing +so will likely cause {kib}'s authorization to behave unexpectedly. NOTE: You cannot access these endpoints via the Console in Kibana. diff --git a/docs/api/role-management/delete.asciidoc b/docs/api/role-management/delete.asciidoc index 4eec3031c1b6..3a2eb6cfb731 100644 --- a/docs/api/role-management/delete.asciidoc +++ b/docs/api/role-management/delete.asciidoc @@ -1,7 +1,7 @@ [[role-management-api-delete]] === Delete role -experimental[This API is experimental and may be changed or removed completely in a future release. Although the underlying mechanism of enforcing role-based access control is stable, the APIs for managing the roles are currently experimental.] +experimental["This API is experimental and may be changed or removed completely in a future release. Although the underlying mechanism of enforcing role-based access control is stable, the APIs for managing the roles are currently experimental."] NOTE: You cannot access this endpoint via the Console in Kibana. diff --git a/docs/api/role-management/get.asciidoc b/docs/api/role-management/get.asciidoc index 48c1b936b3ed..bdc762425f0d 100644 --- a/docs/api/role-management/get.asciidoc +++ b/docs/api/role-management/get.asciidoc @@ -1,7 +1,7 @@ [[role-management-api-get]] === Get Role -experimental[This API is experimental and may be changed or removed completely in a future release. Although the underlying mechanism of enforcing role-based access control is stable, the APIs for managing the roles are currently experimental.] +experimental["This API is experimental and may be changed or removed completely in a future release. Although the underlying mechanism of enforcing role-based access control is stable, the APIs for managing the roles are currently experimental."] Retrieves all {kib} roles, or a specific role. @@ -26,7 +26,7 @@ GET /api/security/role ===== Response -A successful call returns a response code of `200` and a response body containing a JSON +A successful call returns a response code of `200` and a response body containing a JSON representation of the roles. [source,js] @@ -88,7 +88,7 @@ GET /api/security/role/my_kibana_role ===== Response -A successful call returns a response code of `200` and a response body containing a JSON +A successful call returns a response code of `200` and a response body containing a JSON representation of the role. [source,js] diff --git a/docs/api/role-management/put.asciidoc b/docs/api/role-management/put.asciidoc index c369ec644b55..51f2410b7873 100644 --- a/docs/api/role-management/put.asciidoc +++ b/docs/api/role-management/put.asciidoc @@ -1,7 +1,7 @@ [[role-management-api-put]] === Create or Update Role -experimental[This API is experimental and may be changed or removed completely in a future release. Although the underlying mechanism of enforcing role-based access control is stable, the APIs for managing the roles are currently experimental.] +experimental["This API is experimental and may be changed or removed completely in a future release. Although the underlying mechanism of enforcing role-based access control is stable, the APIs for managing the roles are currently experimental."] Creates a new {kib} role or updates the attributes of an existing role. {kib} roles are stored in the {es} native realm. @@ -14,7 +14,7 @@ To use this API, you must have at least the `manage_security` cluster privilege. ==== Request -To create or update a role, issue a PUT request to the +To create or update a role, issue a PUT request to the `/api/security/role/` endpoint. [source,js] @@ -29,10 +29,10 @@ The following parameters can be specified in the body of a PUT request to add or `metadata`:: (object) Optional meta-data. Within the `metadata` object, keys that begin with `_` are reserved for system usage. -`elasticsearch`:: (object) Optional {es} cluster and index privileges, valid keys are +`elasticsearch`:: (object) Optional {es} cluster and index privileges, valid keys are `cluster`, `indices` and `run_as`. For more information, see {xpack-ref}/defining-roles.html[Defining Roles]. -`kibana`:: (object) An object that specifies the <>. Valid keys are `global` and `space`. Privileges defined in the `global` key will apply to all spaces within Kibana, and will take precedent over any privileges defined in the `space` key. For example, specifying `global: ["all"]` will grant full access to all spaces within Kibana, even if the role indicates that a specific space should only have `read` privileges. +`kibana`:: (object) An object that specifies the <>. Valid keys are `global` and `space`. Privileges defined in the `global` key will apply to all spaces within Kibana, and will take precedent over any privileges defined in the `space` key. For example, specifying `global: ["all"]` will grant full access to all spaces within Kibana, even if the role indicates that a specific space should only have `read` privileges. ===== Example @@ -91,7 +91,7 @@ PUT /api/security/role/my_kibana_role "global": [], "space": { "marketing": ["all"], - "engineering": ["read"] + "engineering": ["read"] } } } diff --git a/docs/api/spaces-management.asciidoc b/docs/api/spaces-management.asciidoc index 869f7e722dd3..9d34bbd56fe6 100644 --- a/docs/api/spaces-management.asciidoc +++ b/docs/api/spaces-management.asciidoc @@ -2,7 +2,7 @@ [[spaces-api]] == Kibana Spaces API -experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental.] +experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."] The spaces API allows people to manage their spaces within {kib}. diff --git a/docs/api/spaces-management/delete.asciidoc b/docs/api/spaces-management/delete.asciidoc index fbc20bbf26d0..c5cb284f6689 100644 --- a/docs/api/spaces-management/delete.asciidoc +++ b/docs/api/spaces-management/delete.asciidoc @@ -1,7 +1,7 @@ [[spaces-api-delete]] === Delete space -experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental.] +experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."] [WARNING] ================================================== diff --git a/docs/api/spaces-management/get.asciidoc b/docs/api/spaces-management/get.asciidoc index b7b83426bf7c..a31aad4c1d6f 100644 --- a/docs/api/spaces-management/get.asciidoc +++ b/docs/api/spaces-management/get.asciidoc @@ -1,7 +1,7 @@ [[spaces-api-get]] === Get Space -experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental.] +experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."] Retrieves all {kib} spaces, or a specific space. @@ -22,7 +22,7 @@ GET /api/spaces/space ===== Response -A successful call returns a response code of `200` and a response body containing a JSON +A successful call returns a response code of `200` and a response body containing a JSON representation of the spaces. [source,js] @@ -67,7 +67,7 @@ GET /api/spaces/space/marketing ===== Response -A successful call returns a response code of `200` and a response body containing a JSON +A successful call returns a response code of `200` and a response body containing a JSON representation of the space. [source,js] diff --git a/docs/api/spaces-management/post.asciidoc b/docs/api/spaces-management/post.asciidoc index 5b41e67ee84b..ccd9ea7ea61c 100644 --- a/docs/api/spaces-management/post.asciidoc +++ b/docs/api/spaces-management/post.asciidoc @@ -1,7 +1,7 @@ [[spaces-api-post]] === Create Space -experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental.] +experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."] Creates a new {kib} space. To update an existing space, use the PUT command. @@ -9,7 +9,7 @@ Note: You cannot access this endpoint via the Console in Kibana. ==== Request -To create a space, issue a POST request to the +To create a space, issue a POST request to the `/api/spaces/space` endpoint. [source,js] diff --git a/docs/api/spaces-management/put.asciidoc b/docs/api/spaces-management/put.asciidoc index a1caae59efb8..55a6022e729c 100644 --- a/docs/api/spaces-management/put.asciidoc +++ b/docs/api/spaces-management/put.asciidoc @@ -1,7 +1,7 @@ [[spaces-api-put]] === Update Space -experimental[This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental.] +experimental["This API is *experimental* and may be changed or removed completely in a future release. The underlying Spaces concepts are stable, but the APIs for managing Spaces are currently experimental."] Updates an existing {kib} space. To create a new space, use the POST command. @@ -9,7 +9,7 @@ Note: You cannot access this endpoint via the Console in Kibana. ==== Request -To update a space, issue a PUT request to the +To update a space, issue a PUT request to the `/api/spaces/space/` endpoint. [source,js]