Skip to content

Commit

Permalink
[DOCS] Collapses content in Kibana and APM APIs (#62201) (#62646)
Browse files Browse the repository at this point in the history
* 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>

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
  • Loading branch information
KOTungseth and lcawl committed Apr 6, 2020
1 parent 4dd098b commit c7d466e
Show file tree
Hide file tree
Showing 4 changed files with 349 additions and 8 deletions.
11 changes: 8 additions & 3 deletions docs/api/role-management/put.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

[role="child_attributes"]
[[role-management-api-response-body]]
==== Request body

Expand All @@ -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].

`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` :::
(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.
Expand All @@ -45,14 +49,15 @@ To use the create or update role API, you must have the `manage_security` cluste
`spaces` :::
(list) The spaces to apply the privileges to.
To grant access to all spaces, set to `["*"]`, or omit the value.
=====

[[role-management-api-put-response-codes]]
==== Response code

`204`::
Indicates a successful call.

===== Examples
==== Examples

Grant access to various features in all spaces:

Expand Down
29 changes: 26 additions & 3 deletions docs/api/spaces-management/copy_saved_objects.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ You can request to overwrite any objects that already exist in the target space
`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.

[role="child_attributes"]
[[spaces-api-copy-saved-objects-request-body]]
==== {api-request-body-title}

Expand All @@ -34,38 +35,60 @@ You can request to overwrite any objects that already exist in the target space

`objects`::
(Required, object array) The saved objects to copy.
+
.Properties of `objects`
[%collapsible%open]
=====
`type`:::
(Required, string) The saved object type.
`id`:::
(Required, string) The saved object ID.
=====

`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`.

`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`.


[role="child_attributes"]
[[spaces-api-copy-saved-objects-response-body]]
==== {api-response-body-title}

`<space_id>`::
(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`:::
(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`:::
(number) The number of objects that successfully copied.
`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`::::
(string) The saved object ID that failed to copy.
`type`::::
(string) The type of saved object that failed to copy.
`error`::::
(object) The error that caused the copy operation to fail.
+
.Properties of `error`
[%collapsible%open]
=======
`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>>.

=======
======
=====
[[spaces-api-copy-saved-objects-example]]
==== {api-examples-title}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,51 +25,89 @@ Execute the <<spaces-api-copy-saved-objects,copy saved objects to space API>>, w
`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.

[role="child_attributes"]
[[spaces-api-resolve-copy-saved-objects-conflicts-request-body]]
==== {api-request-body-title}

`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.
+
.Properties of `objects`
[%collapsible%open]
=====
`type`:::
(Required, string) The saved object type.
`id`:::
(Required, string) The saved object ID.
=====

`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`.

`retries`::
(Required, object) The retry operations to attempt. Object keys represent the target space IDs.
+
.Properties of `retries`
[%collapsible%open]
=====
`<space_id>`:::
(Required, array) The errors to resolve for the specified `<space_id>`.
+
.Properties of `<space_id>`
[%collapsible%open]
======
`type`::::
(Required, string) The saved object type.
`id`::::
(Required, string) The saved object ID.
`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.
======
=====


[role="child_attributes"]
[[spaces-api-resolve-copy-saved-objects-conflicts-response-body]]
==== {api-response-body-title}

`<space_id>`::
(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`:::
(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`:::
(number) The number of objects that successfully copied.
`errors`:::
(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`::::
(string) The saved object ID that failed to copy.

`type`::::
(string) The type of saved object that failed to copy.

`error`::::
(object) The error that caused the copy operation to fail.
+

.Properties of `error`
[%collapsible%open]
=======
`type`:::::
(string) The type of error. For example, `unsupported_type`, `missing_references`, or `unknown`.

=======
======
=====

[[spaces-api-resolve-copy-saved-objects-conflicts-example]]
==== {api-examples-title}
Expand Down
Loading

0 comments on commit c7d466e

Please sign in to comment.