-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS][OpenAPI] Add descriptions, examples, tags, responses for space…
… APIs (#195333) Co-authored-by: Elena Shostak <[email protected]> (cherry picked from commit 2656e5a)
- Loading branch information
Showing
51 changed files
with
1,547 additions
and
1,653 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,4 @@ | ||
[role="xpack"] | ||
[[spaces-api]] | ||
== {kib} spaces APIs | ||
|
||
Manage your {kib} spaces. | ||
|
||
The following {kib} spaces APIs are available: | ||
|
||
* <<spaces-api-post, Create space API>> to create a {kib} space | ||
|
||
* <<spaces-api-put, Update space API>> to update an existing {kib} space | ||
|
||
* <<spaces-api-get, Get a space API>> to retrieve a specified {kib} space | ||
|
||
* <<spaces-api-get-all, Get all {kib} spaces API>> to retrieve all {kib} spaces | ||
|
||
* <<spaces-api-delete, Delete space API>> to delete a {kib} space | ||
|
||
* <<spaces-api-copy-saved-objects, Copy saved objects to space API>> to copy saved objects between spaces | ||
|
||
* <<spaces-api-resolve-copy-saved-objects-conflicts, Resolve copy saved objects to space conflicts API>> to overwrite saved objects returned as errors from the copy saved objects to space API | ||
|
||
* <<spaces-api-disable-legacy-url-aliases, Disable legacy URL aliases API>> to disable legacy URL aliases if an error is encountered | ||
|
||
* <<spaces-api-update-objects-spaces, Update saved objects spaces API>> to update one or more saved objects to add and/or remove them from specified spaces | ||
|
||
* <<spaces-api-get-shareable-references, Get shareable references API>> to collect references and spaces context for saved objects | ||
|
||
include::spaces-management/post.asciidoc[] | ||
include::spaces-management/put.asciidoc[] | ||
include::spaces-management/get.asciidoc[] | ||
include::spaces-management/get_all.asciidoc[] | ||
include::spaces-management/delete.asciidoc[] | ||
include::spaces-management/copy_saved_objects.asciidoc[] | ||
include::spaces-management/resolve_copy_saved_objects_conflicts.asciidoc[] | ||
include::spaces-management/disable_legacy_url_aliases.asciidoc[] | ||
include::spaces-management/update_objects_spaces.asciidoc[] | ||
include::spaces-management/get_shareable_references.asciidoc[] | ||
For the latest details, refer to {api-kibana}/group/endpoint-spaces[spaces APIs]. |
Oops, something went wrong.