-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
[data views] data view api docs - index patterns => data views #119415
Merged
mattkime
merged 13 commits into
elastic:main
from
mattkime:rename_index_pattern_api_docs
Dec 1, 2021
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
3d5f588
initial pass at changing urls and anchors
mattkime 126a494
update api.asciidoc
mattkime 84e917e
upate a few more anchor tags
mattkime a9025e0
upate a few more anchor tags
mattkime 7c0bc15
update data view api docs
mattkime 31b3152
Merge branch 'main' into rename_index_pattern_api_docs
kibanamachine be4859a
Merge branch 'main' into rename_index_pattern_api_docs
kibanamachine dd2f3a6
Update delete.asciidoc
mattkime 121810c
Update default-get.asciidoc
mattkime fd3b5b2
add redirects
mattkime d43f8c6
Merge branch 'rename_index_pattern_api_docs' of github.com:mattkime/k…
mattkime 8c2bdf9
fix redirects
mattkime caafa76
remove duplicate redirect
mattkime File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
[[data-views-api]] | ||
== Data views API | ||
|
||
experimental[] Manage data views, formerly known as {kib} index patterns. | ||
|
||
WARNING: Do not write documents directly to the `.kibana` index. When you write directly | ||
to the `.kibana` index, the data becomes corrupted and permanently breaks future {kib} versions. | ||
|
||
WARNING: Use the data views APIs for managing data views instead of lower-level <<saved-objects-api, saved objects API>>. | ||
|
||
The following data views APIs are available: | ||
|
||
* Data views | ||
** <<data-views-api-get, Get data view API>> to retrieve a single data view | ||
** <<data-views-api-create, Create data view API>> to create data view | ||
** <<data-views-api-update, Update data view API>> to partially updated data view | ||
** <<data-views-api-delete, Delete data view API>> to delete a data view | ||
* Default data views | ||
** <<data-views-api-default-get, Get default data view API>> to retrieve a default data view | ||
** <<data-views-api-default-set, Set default data view API>> to set a default data view | ||
* Fields | ||
** <<data-views-fields-api-update, Update data view field>> to change field metadata, such as `count`, `customLabel` and `format` | ||
* Runtime fields | ||
** <<data-views-runtime-field-api-get, Get runtime field API>> to retrieve a runtime field | ||
** <<data-views-runtime-field-api-create, Create runtime field API>> to create a runtime field | ||
** <<data-views-runtime-field-api-upsert, Upsert runtime field API>> to create or update a runtime field | ||
** <<data-views-runtime-field-api-update, Update runtime field API>> to partially update an existing runtime field | ||
** <<data-views-runtime-field-api-delete, Delete runtime field API>> to delete a runtime field | ||
|
||
include::data-views/get.asciidoc[] | ||
include::data-views/create.asciidoc[] | ||
include::data-views/update.asciidoc[] | ||
include::data-views/delete.asciidoc[] | ||
include::data-views/default-get.asciidoc[] | ||
include::data-views/default-set.asciidoc[] | ||
include::data-views/update-fields.asciidoc[] | ||
include::data-views/runtime-fields/get.asciidoc[] | ||
include::data-views/runtime-fields/create.asciidoc[] | ||
include::data-views/runtime-fields/upsert.asciidoc[] | ||
include::data-views/runtime-fields/update.asciidoc[] | ||
include::data-views/runtime-fields/delete.asciidoc[] | ||
|
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
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
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
22 changes: 11 additions & 11 deletions
22
docs/api/index-patterns/delete.asciidoc → docs/api/data-views/delete.asciidoc
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
24 changes: 12 additions & 12 deletions
24
docs/api/index-patterns/get.asciidoc → docs/api/data-views/get.asciidoc
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This changes docs URLs, correct?
In this case we should add this to redirects: https://github.com/elastic/kibana/blob/main/docs/redirects.asciidoc
(for all of the pages, I think)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
addressed