Skip to content

[DOCS] Add authorization info to get and update transform APIs#87994

Merged
lcawl merged 4 commits intoelastic:masterfrom
lcawl:transform-auth
Jul 4, 2022
Merged

[DOCS] Add authorization info to get and update transform APIs#87994
lcawl merged 4 commits intoelastic:masterfrom
lcawl:transform-auth

Conversation

@lcawl
Copy link
Copy Markdown
Member

@lcawl lcawl commented Jun 23, 2022

@lcawl lcawl added >docs General docs changes :ml/Transform Transform v8.4.0 labels Jun 23, 2022
@lcawl lcawl marked this pull request as ready for review June 24, 2022 15:21
@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:ML Meta label for the ML team labels Jun 24, 2022
@elasticmachine
Copy link
Copy Markdown
Collaborator

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

@elasticmachine
Copy link
Copy Markdown
Collaborator

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

@lcawl lcawl requested a review from droberts195 June 24, 2022 15:21
@lcawl lcawl marked this pull request as draft June 24, 2022 21:12
@lcawl lcawl changed the title [DOCS] Add authorization info to get transforms API [DOCS] Add authorization info to get and update transform APIs Jun 24, 2022
@droberts195
Copy link
Copy Markdown

droberts195 commented Jun 27, 2022

The top level docs tests run with security disabled, so the responses in the snippet testing won't contain an authorization object. Since we want everyone to run with security enabled we should include authorization in the docs and manipulate the response so the test passes.

Separately it's probably worth discussing whether the docs tests should be changed to run with security enabled. I think they should now that security is on by default. I don't know how much change that would cause to other test snippets in the docs - it might be masses of work or it might be as simple as deleting this one line:

setting 'xpack.security.enabled', 'false'

@lcawl lcawl marked this pull request as ready for review June 27, 2022 21:26
@lcawl
Copy link
Copy Markdown
Member Author

lcawl commented Jun 27, 2022

I will discuss further with the Elasticsearch writers, but for now I've added substitution instructions to address the snippet failure.

@lcawl
Copy link
Copy Markdown
Member Author

lcawl commented Jun 28, 2022

@elasticmachine run elasticsearch-ci/docs

@lcawl lcawl requested a review from szabosteve June 30, 2022 17:04
Copy link
Copy Markdown
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

LGTM!

@lcawl lcawl merged commit 4e18993 into elastic:master Jul 4, 2022
@lcawl lcawl deleted the transform-auth branch July 4, 2022 16:52
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 v8.4.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants