Skip to content
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] Edits rollup summaries #3310

Merged
merged 7 commits into from
Dec 17, 2024
Merged

[DOCS] Edits rollup summaries #3310

merged 7 commits into from
Dec 17, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Dec 14, 2024

Relates to #3226

This PR edits the rollup APIs in https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-rollup based on the information from https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-apis.html

Preview

The extra content copied into the description of the "delete a rollup job" API looks like this in Bump.sh:

image

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
rollup.delete_job 🟢 3/3 3/3
rollup.get_jobs 🟢 10/10 10/10
rollup.put_job 🟢 22/22 22/22

You can validate these APIs yourself by using the make validate target.

@lcawl lcawl requested a review from a team December 14, 2024 03:14
@lcawl lcawl marked this pull request as ready for review December 14, 2024 03:14
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
rollup.delete_job 🟢 3/3 3/3
rollup.get_jobs 🟢 10/10 10/10
rollup.get_rollup_caps 🟢 3/3 3/3
rollup.get_rollup_index_caps 🟢 7/7 7/7
rollup.put_job 🟢 22/22 22/22
rollup.rollup_search 🟢 18/18 18/18
rollup.start_job 🟢 6/6 6/6
rollup.stop_job 🟢 5/5 5/5

You can validate these APIs yourself by using the make validate target.

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
rollup.delete_job 🟢 3/3 3/3
rollup.get_jobs 🟢 10/10 10/10
rollup.get_rollup_caps 🟢 3/3 3/3
rollup.get_rollup_index_caps 🟢 7/7 7/7
rollup.put_job 🟢 22/22 22/22
rollup.rollup_search 🟢 18/18 18/18
rollup.start_job 🟢 6/6 6/6
rollup.stop_job 🟢 5/5 5/5

You can validate these APIs yourself by using the make validate target.

Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left nitpick inline. Otherwise, LGTM

output/openapi/elasticsearch-openapi.json Outdated Show resolved Hide resolved
output/openapi/elasticsearch-openapi.json Outdated Show resolved Hide resolved
@@ -14202,9 +14202,14 @@
"stability": "experimental"
}
},
"description": "Deletes an existing rollup job.",
"description": "Delete a rollup job.\n\nA job must be stopped first before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n \"query\": {\n \"term\": {\n \"_rollup.id\": \"the_rollup_job_id\"\n }\n }\n}\n```",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"description": "Delete a rollup job.\n\nA job must be stopped first before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n \"query\": {\n \"term\": {\n \"_rollup.id\": \"the_rollup_job_id\"\n }\n }\n}\n```",
"description": "Delete a rollup job.\n\nA job must be stopped before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n \"query\": {\n \"term\": {\n \"_rollup.id\": \"the_rollup_job_id\"\n }\n }\n}\n```",

output/schema/schema.json Outdated Show resolved Hide resolved
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
rollup.delete_job 🟢 3/3 3/3
rollup.get_jobs 🟢 10/10 10/10
rollup.get_rollup_caps 🟢 3/3 3/3
rollup.get_rollup_index_caps 🟢 7/7 7/7
rollup.put_job 🟢 22/22 22/22
rollup.rollup_search 🟢 18/18 18/18
rollup.start_job 🟢 6/6 6/6
rollup.stop_job 🟢 5/5 5/5

You can validate these APIs yourself by using the make validate target.

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
rollup.delete_job 🟢 3/3 3/3
rollup.get_jobs 🟢 10/10 10/10
rollup.get_rollup_caps 🟢 3/3 3/3
rollup.get_rollup_index_caps 🟢 7/7 7/7
rollup.put_job 🟢 22/22 22/22
rollup.rollup_search 🟢 18/18 18/18
rollup.start_job 🟢 6/6 6/6
rollup.stop_job 🟢 5/5 5/5

You can validate these APIs yourself by using the make validate target.

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
rollup.delete_job 🟢 3/3 3/3
rollup.get_jobs 🟢 10/10 10/10
rollup.get_rollup_caps 🟢 3/3 3/3
rollup.get_rollup_index_caps 🟢 7/7 7/7
rollup.put_job 🟢 22/22 22/22
rollup.rollup_search 🟢 18/18 18/18
rollup.start_job 🟢 6/6 6/6
rollup.stop_job 🟢 5/5 5/5

You can validate these APIs yourself by using the make validate target.

@lcawl lcawl merged commit b2df31b into main Dec 17, 2024
7 checks passed
@lcawl lcawl deleted the rollup-summaries branch December 17, 2024 02:58
github-actions bot pushed a commit that referenced this pull request Dec 17, 2024
Co-authored-by: Karen Metts <[email protected]>
(cherry picked from commit b2df31b)
github-actions bot pushed a commit that referenced this pull request Dec 17, 2024
Co-authored-by: Karen Metts <[email protected]>
(cherry picked from commit b2df31b)
lcawl added a commit that referenced this pull request Dec 17, 2024
Co-authored-by: Karen Metts <[email protected]>
(cherry picked from commit b2df31b)

Co-authored-by: Lisa Cawley <[email protected]>
lcawl added a commit that referenced this pull request Dec 19, 2024
Co-authored-by: Karen Metts <[email protected]>
(cherry picked from commit b2df31b)

Co-authored-by: Lisa Cawley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants