-
Notifications
You must be signed in to change notification settings - Fork 24.9k
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] Add rollup V2 API docs #65398
Conversation
* Documents new `<index>/_rollup` API * Updates rollup APIs overview page * Enables rollups V2 in docs integ tests
Time zone for the `field`. Valid values are ISO 8601 UTC offsets, such as | ||
`+01:00` or `-08:00`, and IANA time zone IDs, such as `America/Los_Angeles`. | ||
Defaults to `+00:00` (UTC). | ||
===== |
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.
delay
is also a valid param for date_histogram
but seems to be inert. Let me know if I should document it here.
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 is one of those WIP leaks. the config is being re-used, but you're right, the delay
option is not intended to be used in this action, so it should not be mentioned
[[legacy-rollup-apis]] | ||
=== Legacy rollup APIs | ||
|
||
Prior to {es} 7.x, you could only create a rollup using a periodic cron jobs. |
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.
Prior to {es} 7.x, you could only create a rollup using a periodic cron jobs.
I'll update with the actual release version once we're closer to that.
Pinging @elastic/es-analytics-geo (Team:Analytics) |
Pinging @elastic/es-docs (Team:Docs) |
@talevy This is ready for a review at your convenience. I left a few questions and comments in the file changes. Thanks! |
@@ -52,6 +52,9 @@ testClusters.integTest { | |||
if (singleNode().testDistribution == DEFAULT) { | |||
setting 'xpack.license.self_generated.type', 'trial' | |||
setting 'indices.lifecycle.history_index_enabled', 'false' | |||
if (BuildParams.isSnapshotBuild() == true) { |
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.
now that I am seeing this, I may have to change how I've done this in my PRs.
I feel it is safe to always set the system property in test clusters. I'll change all of them at a later point
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.
woohoo! thank you for this. I will follow-up on the security role issue.
[[legacy-rollup-apis]] | ||
=== Legacy rollup APIs | ||
|
||
Prior to {es} 7.x, you could only create a rollup using a periodic cron jobs. |
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.
drop the "a"?
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.
Good catch! Thanks!
Changes:
<index>/_rollup
APIRelates to #64900
Scope
This PR is focused on API reference documentation This PR does not include a more general overview or tutorial for rollups V2. I plan to cover those in later PRs. I also plan to open additional PR(s) to better label legacy rollup APIs.
Previews