Add documentation for Pause/Resume Auto-Follower APIs #47985
Conversation
tlrx
added
>docs
|
Pinging @elastic/es-docs (>docs) |
|
Pinging @elastic/es-distributed (:Distributed/CCR) |
docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc
Outdated
Show resolved
Hide resolved
|
|
||
| ////////////////////////// | ||
|
|
||
| [source,console] |
There was a problem hiding this comment.
In this section, we typically use literals instead of an actual snippet:
POST /_ccr/auto_follow/<auto_follow_pattern_name>/pause
You may want to move the preceding test setup lower but no big deal.
docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc
Outdated
Show resolved
Hide resolved
| -------------------------------------------------- | ||
| POST /_ccr/auto_follow/<auto_follow_pattern_name>/resume | ||
| -------------------------------------------------- | ||
| // TEST[s/<auto_follow_pattern_name>/my_auto_follow_pattern/] |
There was a problem hiding this comment.
We typically use literals here:
POST /_ccr/auto_follow/<auto_follow_pattern_name>/resume
There was a problem hiding this comment.
I made it like this to mirror what is done in docs/reference/ccr/apis/follow/post-pause-follow.asciidoc but maybe it's wrong there too?
There was a problem hiding this comment.
The format here is based on the API reference template:
https://github.com/elastic/docs/blame/master/shared/api-ref-ex.asciidoc#L39
It's likely that docs/reference/ccr/apis/follow/post-pause-follow.asciidoc followed a previous iteration of that template.
If you'd like to leave this as-is for consistency, I think that's okay. I don't feel strongly about it.
There was a problem hiding this comment.
Thanks, I forgot about this template. I adapted the doc to follow the template and not add more debt.
docs/reference/ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc
Outdated
Show resolved
Hide resolved
docs/reference/ccr/apis/auto-follow/resume-auto-follow-pattern.asciidoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Looks good overall.
I left a recommended needed changes in these comments:
https://github.com/elastic/elasticsearch/pull/47985/files#r334560561
https://github.com/elastic/elasticsearch/pull/47985/files#r334558730
I also left a few other non-blocking suggestions.
….asciidoc Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
…asciidoc Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
…asciidoc Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
…asciidoc Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
…asciidoc Co-Authored-By: James Rodewig <james.rodewig@elastic.co>
Relates #47510