[DOCS] Add space_id path parameter to saved_object APIs #47627

mellieA · 2019-10-08T20:02:02Z

Summary

Updated saved_object APIs with space_id

closes #38788
[skip ci]

elasticmachine · 2019-10-08T20:02:04Z

Pinging @elastic/kibana-docs (Team:Docs)

KOTungseth · 2019-10-09T15:18:50Z

docs/api/saved-objects/bulk_get.asciidoc

+==== Path parameters
+
+`space_id`::
+  (Optional, string) An identifier for the space. If `space_id` is not provided in the URL the default space is used.


I would add a comma in between URL and the

KOTungseth · 2019-10-09T15:21:04Z

docs/api/saved-objects/bulk_get.asciidoc

 [[saved-objects-api-bulk-get-request-body]]
 ==== Request Body

 `type`::
  (Required, string) Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`, and `timelion-sheet`.

 `id`::
-  (Required, string) ID of the retrieved object.
+  (Required, string) ID of the retrieved object. This can be a Kibana's unique identifier or a custom one.


I would change the second sentence to:

The ID includes the {kib} unique identifier or a custom identifier.

KOTungseth · 2019-10-09T15:25:43Z

docs/api/saved-objects/bulk_get.asciidoc

  (array) Top-level property the contains objects that represent the response for each of the requested objects. The order of the objects in the response is identical to the order of the objects in the request.

 Saved objects that are unable to persist are replaced with an error object.

 [[saved-objects-api-bulk-get-body-codes]]
 ==== Response code

-`200`:: 
+`200`::
  Indicates a successfully call.


successfully should be successful

KOTungseth · 2019-10-09T15:26:25Z

docs/api/saved-objects/create.asciidoc

 [[saved-objects-api-create-path-params]]
 ==== Path parameters

+`space_id`::
+  (Optional, string) An identifier for the space. If `space_id` is not provided in the URL the default space is used.


I would add a comma in between URL and the

KOTungseth · 2019-10-09T15:26:41Z

docs/api/saved-objects/delete.asciidoc

 [[saved-objects-api-delete-path-params]]
 ==== Path parameters

+`space_id`::
+  (Optional, string) An identifier for the space. If `space_id` is not provided in the URL the default space is used.


I would add a comma in between URL and the

KOTungseth · 2019-10-09T15:27:20Z

docs/api/saved-objects/get.asciidoc

@@ -50,3 +56,60 @@ The API returns the following:
  }
 }
 --------------------------------------------------
+
+The following example retrieves a dashboard object in the `testspace` by id.


id should be ID

KOTungseth · 2019-10-09T15:28:34Z

docs/api/saved-objects/get.asciidoc

+--------------------------------------------------
+// KIBANA
+
+A successful call returns a response code of `200` and a response body


Remove A successful call returns a response code of 200 and a response body containing a JSON structure similar to the following example:, then replace with:

The API returns the following:

KOTungseth · 2019-10-09T15:30:51Z

docs/api/saved-objects/import.asciidoc

+==== Path parameters
+
+`space_id`::
+  (Optional, string) An identifier for the space. If `space_id` is not provided in the URL the default space is used.


I would add a comma in between URL and the

KOTungseth · 2019-10-09T15:32:46Z

docs/api/saved-objects/resolve_import_errors.asciidoc

+==== Path parameters
+
+`space_id`::
+  (Optional, string) An identifier for the space. If `space_id` is not provided in the URL the default space is used.


I would add a comma in between URL and the

KOTungseth · 2019-10-09T15:32:55Z

docs/api/saved-objects/update.asciidoc

+==== Path parameters
+
+`space_id`::
+  (Optional, string) An identifier for the space. If `space_id` is not provided in the URL the default space is used.


I would add a comma in between URL and the

KOTungseth

LGTM!

thomasneirynck · 2020-03-23T02:48:54Z

hi @KOTungseth , @mellieA, does this need to be backported to the older 7.x branches?

See this discuss question: https://discuss.elastic.co/t/space-id-parameter-for-the-savedobjects-api/224548

* [DOCS] Add space_id path parameter to saved_object APIs * [DOCS] Apply suggested edits for elastic#47627 * [DOCS] Apply suggested edits for elastic#47627 to delete API

) * [DOCS] Add space_id path parameter to saved_object APIs * [DOCS] Apply suggested edits for #47627 * [DOCS] Apply suggested edits for #47627 to delete API

) * [DOCS] Add space_id path parameter to saved_object APIs * [DOCS] Apply suggested edits for #47627 * [DOCS] Apply suggested edits for #47627 to delete API Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>

[DOCS] Add space_id path parameter to saved_object APIs

afa7037

mellieA added Team:Docs v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.4.0 v7.5.0 labels Oct 8, 2019

mellieA requested a review from KOTungseth October 8, 2019 20:02

mellieA mentioned this pull request Oct 8, 2019

Kibana APIs - Spaces URL "prefix" #29646

Closed

KOTungseth reviewed Oct 9, 2019

View reviewed changes

Melori Arellano added 2 commits October 16, 2019 10:37

[DOCS] Apply suggested edits for elastic#47627

1572355

[DOCS] Apply suggested edits for elastic#47627 to delete API

e2c75e9

KOTungseth approved these changes Oct 17, 2019

View reviewed changes

Merge branch 'master' into PR38788

6d3c9b5

mellieA merged commit 8d34f25 into elastic:master Oct 18, 2019

thomasneirynck mentioned this pull request Mar 23, 2020

Update API documentation to include effects of space prefix in URL #38788

Closed

This was referenced Mar 23, 2020

[7.x] [DOCS] Add space_id path parameter to saved_object APIs (#47627) #60968

Merged

[7.6] [DOCS] Add space_id path parameter to saved_object APIs (#47627) #60969

Merged

mellieA mentioned this pull request Mar 23, 2020

[7.5] [DOCS] Add space_id path parameter to saved_object APIs (#47627) #60970

Merged

mellieA mentioned this pull request Mar 23, 2020

[7.4] [DOCS] Add space_id path parameter to saved_object APIs (#47627) #60971

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOCS] Add space_id path parameter to saved_object APIs #47627

[DOCS] Add space_id path parameter to saved_object APIs #47627

mellieA commented Oct 8, 2019

elasticmachine commented Oct 8, 2019

KOTungseth Oct 9, 2019

KOTungseth Oct 9, 2019

KOTungseth Oct 9, 2019

KOTungseth Oct 9, 2019

KOTungseth Oct 9, 2019

KOTungseth Oct 9, 2019

KOTungseth Oct 9, 2019

KOTungseth Oct 9, 2019

KOTungseth Oct 9, 2019

KOTungseth Oct 9, 2019

KOTungseth left a comment

thomasneirynck commented Mar 23, 2020 •

edited

Loading

[DOCS] Add space_id path parameter to saved_object APIs #47627

[DOCS] Add space_id path parameter to saved_object APIs #47627

Conversation

mellieA commented Oct 8, 2019

Summary

elasticmachine commented Oct 8, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KOTungseth left a comment

Choose a reason for hiding this comment

thomasneirynck commented Mar 23, 2020 • edited Loading

thomasneirynck commented Mar 23, 2020 •

edited

Loading