[DOCS] Add space_id path parameter to saved_object APIs #47627
Merged
Conversation
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
mellieA
added
Team:Docs
v8.0.0
release_note:skip
|
Pinging @elastic/kibana-docs (Team:Docs) |
KOTungseth
reviewed
Oct 9, 2019
| ==== 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. |
There was a problem hiding this comment.
I would add a comma in between URL and the
| [[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. |
There was a problem hiding this comment.
I would change the second sentence to:
The ID includes the {kib} unique identifier or a custom identifier.
| (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. |
There was a problem hiding this comment.
successfully should be successful
| [[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. |
There was a problem hiding this comment.
I would add a comma in between URL and the
| [[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. |
There was a problem hiding this comment.
I would add a comma in between URL and the
| @@ -50,3 +56,60 @@ The API returns the following: | |||
| } | |||
| } | |||
| -------------------------------------------------- | |||
|
|
|||
| The following example retrieves a dashboard object in the `testspace` by id. | |||
docs/api/saved-objects/get.asciidoc
Outdated
| -------------------------------------------------- | ||
| // KIBANA | ||
|
|
||
| A successful call returns a response code of `200` and a response body |
There was a problem hiding this comment.
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:
| ==== 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. |
There was a problem hiding this comment.
I would add a comma in between URL and the
| ==== 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. |
There was a problem hiding this comment.
I would add a comma in between URL and the
| ==== 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. |
There was a problem hiding this comment.
I would add a comma in between URL and the
|
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 |
This was referenced Mar 23, 2020
mellieA
pushed a commit
to mellieA/kibana
that referenced
this pull request
Mar 23, 2020
* [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
mellieA
pushed a commit
to mellieA/kibana
that referenced
this pull request
Mar 23, 2020
* [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
mellieA
pushed a commit
to mellieA/kibana
that referenced
this pull request
Mar 23, 2020
* [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
mellieA
pushed a commit
that referenced
this pull request
Mar 23, 2020
mellieA
pushed a commit
that referenced
this pull request
Mar 23, 2020
mellieA
pushed a commit
that referenced
this pull request
Mar 23, 2020
mellieA
pushed a commit
that referenced
this pull request
Mar 23, 2020
) * [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 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Updated saved_object APIs with space_id
closes #38788
[skip ci]