Skip to content

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Jun 26, 2019

Related to #43490

This PR adds a response codes section to the documentation for the get data frame transforms, get data frame transform statistics, and stop data frame transforms APIs. It also edits the description of the allow_no_match query parameter.

@lcawl lcawl added >docs General docs changes v8.0.0 :ml/Transform Transform v7.3.0 labels Jun 26, 2019
@lcawl lcawl requested a review from benwtrent June 26, 2019 22:13
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

@elasticmachine
Copy link
Collaborator

Pinging @elastic/ml-core

been specified. The default is `true`.
(boolean) Specifies what to do when the request contains a wildcard expression
and there are no {dataframe-transforms} that match. The default value is
`true`, which returns an empty `transforms` array in this scenario. If it's
Copy link
Member

Choose a reason for hiding this comment

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

It is also if there is a partial match. If somebody supplies the patter test-id*,missing* and missing* does not match but test-id* does, we will return the test-id* matched transforms without the missing*.

If the allow_no_match is false, we would through the 404, even if there is a partial match for one of the patterns.


`404`::
If `allow_no_match` is `false`, this code indicates that there are no
resources that match the request.
Copy link
Member

Choose a reason for hiding this comment

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

This should refer to missing resources a partial match is also errored out in this case.

@lcawl
Copy link
Contributor Author

lcawl commented Jun 27, 2019

Thanks for the feedback, @benwtrent. I've updated the three pages to try to be clearer about the partial match behaviour.

Copy link
Member

@benwtrent benwtrent left a comment

Choose a reason for hiding this comment

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

📝 ✔️

@lcawl
Copy link
Contributor Author

lcawl commented Jun 27, 2019

@elasticmachine update branch

@lcawl lcawl merged commit f1e3a8f into elastic:master Jun 27, 2019
@lcawl lcawl deleted the allow-no-match branch June 27, 2019 22:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants