Skip to content

Commit

Permalink
[8.16] [DOCS][OpenAPI] Add descriptions, examples, tags, responses fo…
Browse files Browse the repository at this point in the history
…r space APIs (#195333) (#196943)

# Backport

This will backport the following commits from `main` to `8.16`:
- [[DOCS][OpenAPI] Add descriptions, examples, tags, responses for space
APIs (#195333)](#195333)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-18T19:03:06Z","message":"[DOCS][OpenAPI]
Add descriptions, examples, tags, responses for space APIs
(#195333)\n\nCo-authored-by: Elena Shostak
<[email protected]>","sha":"2656e5a4ff79277c9a370ee24d6692ccb1d3142c","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Security/Spaces","release_note:skip","v9.0.0","docs","v8.16.0","backport:version","v8.17.0"],"title":"[DOCS][OpenAPI]
Add descriptions, examples, tags, responses for space
APIs","number":195333,"url":"https://github.com/elastic/kibana/pull/195333","mergeCommit":{"message":"[DOCS][OpenAPI]
Add descriptions, examples, tags, responses for space APIs
(#195333)\n\nCo-authored-by: Elena Shostak
<[email protected]>","sha":"2656e5a4ff79277c9a370ee24d6692ccb1d3142c"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/195333","number":195333,"mergeCommit":{"message":"[DOCS][OpenAPI]
Add descriptions, examples, tags, responses for space APIs
(#195333)\n\nCo-authored-by: Elena Shostak
<[email protected]>","sha":"2656e5a4ff79277c9a370ee24d6692ccb1d3142c"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <[email protected]>
  • Loading branch information
kibanamachine and lcawl authored Oct 18, 2024
1 parent bbd42c0 commit 689c847
Show file tree
Hide file tree
Showing 51 changed files with 1,547 additions and 1,653 deletions.
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

0 comments on commit 689c847

Please sign in to comment.