Skip to content

Commit

Permalink
[8.6] [Docs] Fix curl examples in update data view api docs (#153292) (
Browse files Browse the repository at this point in the history
…#154284)

# Backport

This will backport the following commits from `main` to `8.6`:
- [[Docs] Fix curl examples in update data view api docs
(#153292)](#153292)

<!--- Backport version: 8.9.7 -->

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

<!--BACKPORT [{"author":{"name":"Nick
Peihl","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-04-03T20:02:26Z","message":"[Docs]
Fix curl examples in update data view api docs (#153292)\n\n##
Summary\r\n\r\nFixes typos in the curl examples in the Update data views
API docs.\r\n\r\n[Reported by a
community\r\nuser](https://discuss.elastic.co/t/kibana-data-view-update-api-request-doesnt-work/327435/5).","sha":"95d48205924474153735ffa6a9a21e6d34b29ac3","branchLabelMapping":{"^v8.8.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","Team:DataDiscovery","v8.0.2","v8.1.3","v8.2.3","backport:all-open","v8.3.3","v8.4.3","v8.5.3","v8.6.2","v8.8.0","v8.7.1"],"number":153292,"url":"https://github.com/elastic/kibana/pull/153292","mergeCommit":{"message":"[Docs]
Fix curl examples in update data view api docs (#153292)\n\n##
Summary\r\n\r\nFixes typos in the curl examples in the Update data views
API docs.\r\n\r\n[Reported by a
community\r\nuser](https://discuss.elastic.co/t/kibana-data-view-update-api-request-doesnt-work/327435/5).","sha":"95d48205924474153735ffa6a9a21e6d34b29ac3"}},"sourceBranch":"main","suggestedTargetBranches":["8.0","8.1","8.2","8.3","8.4","8.5","8.6","8.7"],"targetPullRequestStates":[{"branch":"8.0","label":"v8.0.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.1","label":"v8.1.3","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.2","label":"v8.2.3","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.3","label":"v8.3.3","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.4","label":"v8.4.3","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.5","label":"v8.5.3","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.6","label":"v8.6.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.8.0","labelRegex":"^v8.8.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/153292","number":153292,"mergeCommit":{"message":"[Docs]
Fix curl examples in update data view api docs (#153292)\n\n##
Summary\r\n\r\nFixes typos in the curl examples in the Update data views
API docs.\r\n\r\n[Reported by a
community\r\nuser](https://discuss.elastic.co/t/kibana-data-view-update-api-request-doesnt-work/327435/5).","sha":"95d48205924474153735ffa6a9a21e6d34b29ac3"}},{"branch":"8.7","label":"v8.7.1","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Nick Peihl <[email protected]>
  • Loading branch information
kibanamachine and nickpeihl authored Apr 3, 2023
1 parent 92916a1 commit 39ad965
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/api/data-views/update.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ Update a title of the `<my-view>` data view:

[source,sh]
--------------------------------------------------
$ curl -X POST api/data_views/data-view/my-view
$ curl -X POST api/data_views/data_view/my-view
{
"data_view": {
"title": "some-other-view-*"
Expand All @@ -75,7 +75,7 @@ Customize the update behavior:

[source,sh]
--------------------------------------------------
$ curl -X POST api/data_views/data-view/my-view
$ curl -X POST api/data_views/data_view/my-view
{
"refresh_fields": true,
"data_view": {
Expand All @@ -90,7 +90,7 @@ All update fields are optional, but you can specify the following fields:

[source,sh]
--------------------------------------------------
$ curl -X POST api/data_views/data-view/my-view
$ curl -X POST api/data_views/data_view/my-view
{
"data_view": {
"title": "...",
Expand Down

0 comments on commit 39ad965

Please sign in to comment.