[DOCS] Collapses content in Kibana and APM APIs (#62201)

* Collapses content in Kibana and APM APIs

* Update docs/api/role-management/put.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/copy_saved_objects.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/copy_saved_objects.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/copy_saved_objects.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/copy_saved_objects.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/copy_saved_objects.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/copy_saved_objects.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

* Update docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc

Co-Authored-By: Lisa Cawley <lcawley@elastic.co>

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
This commit is contained in:
Kaarina Tungseth 2020-04-06 11:15:52 -05:00 committed by GitHub
parent e86cb42080
commit 23755f95fa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 89 additions and 8 deletions

View file

@ -17,6 +17,7 @@ experimental[] Create a new {kib} role, or update the attributes of an existing
To use the create or update role API, you must have the `manage_security` cluster privilege. To use the create or update role API, you must have the `manage_security` cluster privilege.
[role="child_attributes"]
[[role-management-api-response-body]] [[role-management-api-response-body]]
==== Request body ==== Request body
@ -29,8 +30,11 @@ To use the create or update role API, you must have the `manage_security` cluste
{ref}/defining-roles.html[Defining roles]. {ref}/defining-roles.html[Defining roles].
`kibana`:: `kibana`::
(list) Objects that specify the <<kibana-privileges, Kibana privileges>> for the role: (list) Objects that specify the <<kibana-privileges, Kibana privileges>> for the role.
+
.Properties of `kibana`
[%collapsible%open]
=====
`base` ::: `base` :::
(Optional, list) A base privilege. When specified, the base must be `["all"]` or `["read"]`. (Optional, list) A base privilege. When specified, the base must be `["all"]` or `["read"]`.
When the `base` privilege is specified, you are unable to use the `feature` section. When the `base` privilege is specified, you are unable to use the `feature` section.
@ -45,6 +49,7 @@ To use the create or update role API, you must have the `manage_security` cluste
`spaces` ::: `spaces` :::
(list) The spaces to apply the privileges to. (list) The spaces to apply the privileges to.
To grant access to all spaces, set to `["*"]`, or omit the value. To grant access to all spaces, set to `["*"]`, or omit the value.
=====
[[role-management-api-put-response-codes]] [[role-management-api-put-response-codes]]
==== Response code ==== Response code
@ -52,7 +57,7 @@ To use the create or update role API, you must have the `manage_security` cluste
`204`:: `204`::
Indicates a successful call. Indicates a successful call.
===== Examples ==== Examples
Grant access to various features in all spaces: Grant access to various features in all spaces:

View file

@ -26,6 +26,7 @@ You can request to overwrite any objects that already exist in the target space
`space_id`:: `space_id`::
(Optional, string) The ID of the space that contains the saved objects you want to copy. When `space_id` is unspecified in the URL, the default space is used. (Optional, string) The ID of the space that contains the saved objects you want to copy. When `space_id` is unspecified in the URL, the default space is used.
[role="child_attributes"]
[[spaces-api-copy-saved-objects-request-body]] [[spaces-api-copy-saved-objects-request-body]]
==== {api-request-body-title} ==== {api-request-body-title}
@ -34,10 +35,16 @@ You can request to overwrite any objects that already exist in the target space
`objects`:: `objects`::
(Required, object array) The saved objects to copy. (Required, object array) The saved objects to copy.
+
.Properties of `objects`
[%collapsible%open]
=====
`type`::: `type`:::
(Required, string) The saved object type. (Required, string) The saved object type.
`id`::: `id`:::
(Required, string) The saved object ID. (Required, string) The saved object ID.
=====
`includeReferences`:: `includeReferences`::
(Optional, boolean) When set to `true`, all saved objects related to the specified saved objects will also be copied into the target spaces. The default value is `false`. (Optional, boolean) When set to `true`, all saved objects related to the specified saved objects will also be copied into the target spaces. The default value is `false`.
@ -45,27 +52,43 @@ You can request to overwrite any objects that already exist in the target space
`overwrite`:: `overwrite`::
(Optional, boolean) When set to `true`, all conflicts are automatically overidden. When a saved object with a matching `type` and `id` exists in the target space, that version is replaced with the version from the source space. The default value is `false`. (Optional, boolean) When set to `true`, all conflicts are automatically overidden. When a saved object with a matching `type` and `id` exists in the target space, that version is replaced with the version from the source space. The default value is `false`.
[role="child_attributes"]
[[spaces-api-copy-saved-objects-response-body]] [[spaces-api-copy-saved-objects-response-body]]
==== {api-response-body-title} ==== {api-response-body-title}
`<space_id>`:: `<space_id>`::
(object) An object that describes the result of the copy operation for the space. Includes the dynamic keys in the response. (object) An object that describes the result of the copy operation for the space. Includes the dynamic keys in the response.
+
.Properties of `<space_id>`
[%collapsible%open]
=====
`success`::: `success`:::
(boolean) The copy operation was successful. When set to `false`, some objects may have been copied. For additional information, refer to the `successCount` and `errors` properties. (boolean) The copy operation was successful. When set to `false`, some objects may have been copied. For additional information, refer to the `successCount` and `errors` properties.
`successCount`::: `successCount`:::
(number) The number of objects that successfully copied. (number) The number of objects that successfully copied.
`errors`::: `errors`:::
(Optional, array) The errors that occurred during the copy operation. When errors are reported, the `success` flag is set to `false`.v (Optional, array) The errors that occurred during the copy operation. When errors are reported, the `success` flag is set to `false`.
+
.Properties of `errors`
[%collapsible%open]
======
`id`:::: `id`::::
(string) The saved object ID that failed to copy. (string) The saved object ID that failed to copy.
`type`:::: `type`::::
(string) The type of saved object that failed to copy. (string) The type of saved object that failed to copy.
`error`:::: `error`::::
(object) The error that caused the copy operation to fail. (object) The error that caused the copy operation to fail.
+
.Properties of `error`
[%collapsible%open]
=======
`type`::::: `type`:::::
(string) The type of error. For example, `unsupported_type`, `missing_references`, or `unknown`. Errors marked as `conflict` may be resolved by using the <<spaces-api-resolve-copy-saved-objects-conflicts, Resolve copy saved objects conflicts API>>. (string) The type of error. For example, `unsupported_type`, `missing_references`, or `unknown`. Errors marked as `conflict` may be resolved by using the <<spaces-api-resolve-copy-saved-objects-conflicts, Resolve copy saved objects conflicts API>>.
=======
======
=====
[[spaces-api-copy-saved-objects-example]] [[spaces-api-copy-saved-objects-example]]
==== {api-examples-title} ==== {api-examples-title}

View file

@ -25,51 +25,89 @@ Execute the <<spaces-api-copy-saved-objects,copy saved objects to space API>>, w
`space_id`:: `space_id`::
(Optional, string) The ID of the space that contains the saved objects you want to copy. When `space_id` is unspecified in the URL, the default space is used. The `space_id` must be the same value used during the failed <<spaces-api-copy-saved-objects, copy saved objects to space API>> operation. (Optional, string) The ID of the space that contains the saved objects you want to copy. When `space_id` is unspecified in the URL, the default space is used. The `space_id` must be the same value used during the failed <<spaces-api-copy-saved-objects, copy saved objects to space API>> operation.
[role="child_attributes"]
[[spaces-api-resolve-copy-saved-objects-conflicts-request-body]] [[spaces-api-resolve-copy-saved-objects-conflicts-request-body]]
==== {api-request-body-title} ==== {api-request-body-title}
`objects`:: `objects`::
(Required, object array) The saved objects to copy. The `objects` must be the same values used during the failed <<spaces-api-copy-saved-objects, copy saved objects to space API>> operation. (Required, object array) The saved objects to copy. The `objects` must be the same values used during the failed <<spaces-api-copy-saved-objects, copy saved objects to space API>> operation.
+
.Properties of `objects`
[%collapsible%open]
=====
`type`::: `type`:::
(Required, string) The saved object type. (Required, string) The saved object type.
`id`::: `id`:::
(Required, string) The saved object ID. (Required, string) The saved object ID.
=====
`includeReferences`:: `includeReferences`::
(Optional, boolean) When set to `true`, all saved objects related to the specified saved objects are copied into the target spaces. The `includeReferences` must be the same values used during the failed <<spaces-api-copy-saved-objects, copy saved objects to space API>> operation. The default value is `false`. (Optional, boolean) When set to `true`, all saved objects related to the specified saved objects are copied into the target spaces. The `includeReferences` must be the same values used during the failed <<spaces-api-copy-saved-objects, copy saved objects to space API>> operation. The default value is `false`.
`retries`:: `retries`::
(Required, object) The retry operations to attempt. Object keys represent the target space IDs. (Required, object) The retry operations to attempt. Object keys represent the target space IDs.
+
.Properties of `retries`
[%collapsible%open]
=====
`<space_id>`::: `<space_id>`:::
(Required, array) The errors to resolve for the specified `<space_id>`. (Required, array) The errors to resolve for the specified `<space_id>`.
+
.Properties of `<space_id>`
[%collapsible%open]
======
`type`:::: `type`::::
(Required, string) The saved object type. (Required, string) The saved object type.
`id`:::: `id`::::
(Required, string) The saved object ID. (Required, string) The saved object ID.
`overwrite`:::: `overwrite`::::
(Required, boolean) When set to `true`, the saved object from the source space (desigated by the <<spaces-api-resolve-copy-saved-objects-conflicts-path-params, `space_id` path parameter>>) overwrites the conflicting object in the destination space. When set to `false`, this does nothing. (Required, boolean) When set to `true`, the saved object from the source space (desigated by the <<spaces-api-resolve-copy-saved-objects-conflicts-path-params, `space_id` path parameter>>) overwrites the conflicting object in the destination space. When set to `false`, this does nothing.
======
=====
[role="child_attributes"]
[[spaces-api-resolve-copy-saved-objects-conflicts-response-body]] [[spaces-api-resolve-copy-saved-objects-conflicts-response-body]]
==== {api-response-body-title} ==== {api-response-body-title}
`<space_id>`:: `<space_id>`::
(object) An object that describes the result of the copy operation for the space. Includes the dynamic keys in the response. (object) An object that describes the result of the copy operation for the space. Includes the dynamic keys in the response.
+
.Properties of `<space_id>`
[%collapsible%open]
=====
`success`::: `success`:::
(boolean) The copy operation was successful. When set to `false`, some objects may have been copied. For additional information, refer to the `successCount` and `errors` properties. (boolean) The copy operation was successful. When set to `false`, some objects may have been copied. For additional information, refer to the `successCount` and `errors` properties.
`successCount`::: `successCount`:::
(number) The number of objects that successfully copied. (number) The number of objects that successfully copied.
`errors`::: `errors`:::
(Optional, array) The errors that occurred during the copy operation. When errors are reported, the `success` flag is set to `false`. (Optional, array) The errors that occurred during the copy operation. When errors are reported, the `success` flag is set to `false`.
+
.Properties of `errors`
[%collapsible%open]
======
`id`:::: `id`::::
(string) The saved object ID that failed to copy. (string) The saved object ID that failed to copy.
`type`:::: `type`::::
(string) The type of saved object that failed to copy. (string) The type of saved object that failed to copy.
`error`:::: `error`::::
(object) The error that caused the copy operation to fail. (object) The error that caused the copy operation to fail.
+
.Properties of `error`
[%collapsible%open]
=======
`type`::::: `type`:::::
(string) The type of error. For example, `unsupported_type`, `missing_references`, or `unknown`. (string) The type of error. For example, `unsupported_type`, `missing_references`, or `unknown`.
=======
======
=====
[[spaces-api-resolve-copy-saved-objects-conflicts-example]] [[spaces-api-resolve-copy-saved-objects-conflicts-example]]
==== {api-examples-title} ==== {api-examples-title}

View file

@ -38,17 +38,22 @@ The following Agent configuration APIs are available:
`PUT /api/apm/settings/agent-configuration` `PUT /api/apm/settings/agent-configuration`
[role="child_attributes"]
[[apm-update-config-req-body]] [[apm-update-config-req-body]]
===== Request body ===== Request body
`service`:: `service`::
(required, object) Service identifying the configuration to create or update. (required, object) Service identifying the configuration to create or update.
.Properties of `service`
[%collapsible%open]
======
`name` ::: `name` :::
(required, string) Name of service (required, string) Name of service
`environment` ::: `environment` :::
(optional, string) Environment of service (optional, string) Environment of service
======
`settings`:: `settings`::
(required) Key/value object with settings and their corresponding value. (required) Key/value object with settings and their corresponding value.
@ -90,16 +95,21 @@ PUT /api/apm/settings/agent-configuration
`DELETE /api/apm/settings/agent-configuration` `DELETE /api/apm/settings/agent-configuration`
[role="child_attributes"]
[[apm-delete-config-req-body]] [[apm-delete-config-req-body]]
===== Request body ===== Request body
`service`:: `service`::
(required, object) Service identifying the configuration to delete (required, object) Service identifying the configuration to delete
.Properties of `service`
[%collapsible%open]
======
`name` ::: `name` :::
(required, string) Name of service (required, string) Name of service
`environment` ::: `environment` :::
(optional, string) Environment of service (optional, string) Environment of service
======
[[apm-delete-config-example]] [[apm-delete-config-example]]
@ -201,17 +211,22 @@ GET /api/apm/settings/agent-configuration
`POST /api/apm/settings/agent-configuration/search` `POST /api/apm/settings/agent-configuration/search`
[role="child_attributes"]
[[apm-search-config-req-body]] [[apm-search-config-req-body]]
===== Request body ===== Request body
`service`:: `service`::
(required, object) Service identifying the configuration. (required, object) Service identifying the configuration.
.Properties of `service`
[%collapsible%open]
======
`name` ::: `name` :::
(required, string) Name of service (required, string) Name of service
`environment` ::: `environment` :::
(optional, string) Environment of service (optional, string) Environment of service
======
`etag`:: `etag`::
(required) etag is sent by the agent to indicate the etag of the last successfully applied configuration. If the etag matches an existing configuration its `applied_by_agent` property will be set to `true`. Every time a configuration is edited `applied_by_agent` is reset to `false`. (required) etag is sent by the agent to indicate the etag of the last successfully applied configuration. If the etag matches an existing configuration its `applied_by_agent` property will be set to `true`. Every time a configuration is edited `applied_by_agent` is reset to `false`.