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

[DOCS][OpenAPI] Add descriptions, examples, tags, responses for space APIs #195333

Merged
merged 35 commits into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
f1753c9
[DOCS][OpenAPI] Add descriptions for create space API
lcawl Oct 7, 2024
6266d1f
Put examples in single shared overlay file
lcawl Oct 7, 2024
400df85
Add update space example and response code
lcawl Oct 7, 2024
104980a
Revert changes to connector and alerting overlay files
lcawl Oct 7, 2024
2f3c518
Add summary and tags to all space APIs
lcawl Oct 8, 2024
6bba78b
Added descriptions to more space APIs
lcawl Oct 8, 2024
20a98df
Generate output
lcawl Oct 8, 2024
9eb921f
Add examples for space APIs
lcawl Oct 8, 2024
21cf8a0
Add more missing descriptions
lcawl Oct 9, 2024
a5050bc
Edit markdown in example descriptions
lcawl Oct 9, 2024
d674b83
[DOCS] Remove old API pages
lcawl Oct 9, 2024
62275a1
[CI] Auto-commit changed files from 'make api-docs && make api-docs-s…
kibanamachine Oct 9, 2024
30e1a13
Merge branch 'main' into space-examples
lcawl Oct 11, 2024
30d4b0f
Revert request response changes in unversioned operations
lcawl Oct 11, 2024
4b8b51c
Merge branch 'main' into space-examples
lcawl Oct 11, 2024
1e1780a
Regenerate output
lcawl Oct 11, 2024
517c67c
[CI] Auto-commit changed files from 'make api-docs && make api-docs-s…
kibanamachine Oct 11, 2024
7e99cc5
Merge branch 'main' into space-examples
lcawl Oct 15, 2024
c099b5d
Remove response from resolve conflicts
lcawl Oct 15, 2024
68d06ae
Regenerate output
lcawl Oct 15, 2024
638a598
Merge branch 'main' into space-examples
lcawl Oct 15, 2024
7853221
Merge branch 'main' into space-examples
lcawl Oct 16, 2024
695289a
Regenerate staging output
lcawl Oct 16, 2024
537e85b
Update x-pack/plugins/spaces/server/routes/api/external/copy_to_space.ts
lcawl Oct 16, 2024
dcd8b38
Update oas_docs/examples/copy_saved_objects_response3.yaml
lcawl Oct 16, 2024
5fdd9d6
Update x-pack/plugins/spaces/server/routes/api/external/delete.ts
lcawl Oct 16, 2024
ef6e2f9
Update x-pack/plugins/spaces/server/routes/api/external/disable_legac…
lcawl Oct 16, 2024
26b1656
Update x-pack/plugins/spaces/server/routes/api/external/put.ts
lcawl Oct 16, 2024
3082e9e
Merge branch 'main' into space-examples
lcawl Oct 16, 2024
cb83fe5
Update x-pack/plugins/spaces/server/routes/api/external/copy_to_space.ts
lcawl Oct 16, 2024
dbe30c4
Regenerate output
lcawl Oct 16, 2024
355002b
[CI] Auto-commit changed files from 'make api-docs && make api-docs-s…
kibanamachine Oct 16, 2024
d2bc405
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
kibanamachine Oct 16, 2024
7c863db
Fix 404 in delete API
lcawl Oct 16, 2024
03f5b38
Merge branch 'main' into space-examples
lcawl Oct 18, 2024
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