Skip to content

[DOCS] Adds retention_policy to PUT Transform API docs #68656

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

Merged
merged 12 commits into from
Feb 9, 2021

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Feb 8, 2021

Overview

This PR adds the retention_policy property and its sub-properties to the PUT Transform API and update transform API docs. It also expands the example API call with the property in the PUT Transform API docs and the example response in the GET Transform stats API docs.

Preview

Note

This PR depends on #67832
Update the branch after that PR is merged to pass the CI tests.

@szabosteve szabosteve added :ml/Transform Transform >docs General docs changes v7.12.0 v8.0.0 labels Feb 8, 2021
@elasticmachine elasticmachine added Team:ML Meta label for the ML team Team:Docs Meta label for docs team labels Feb 8, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/ml-core (Team:ML)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

Copy link

@hendrikmuhs hendrikmuhs left a comment

Choose a reason for hiding this comment

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

1 small typo to be fixed, otherwise LGTM

end::transform-retention-time[]

tag::transform-retention-time-field[]
The date filed that is used to calculate the age of the document.

Choose a reason for hiding this comment

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

filed -> field

@szabosteve
Copy link
Contributor Author

@elasticmachine update branch

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

LGTM

@szabosteve szabosteve merged commit 4443cb2 into elastic:master Feb 9, 2021
@szabosteve szabosteve deleted the tr.retention.policy branch February 9, 2021 07:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :ml/Transform Transform Team:Docs Meta label for docs team Team:ML Meta label for the ML team v7.12.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants