Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.x] [DOCS][OpenAPI] Add descriptions, examples, tags, responses for space APIs (#195333) #196944

Merged
merged 1 commit into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 1 addition & 35 deletions docs/api/spaces-management.asciidoc
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].
Loading