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

Update recovery.asciidoc #114889

Merged
merged 3 commits into from
Jan 29, 2025
Merged

Update recovery.asciidoc #114889

merged 3 commits into from
Jan 29, 2025

Conversation

redcinelli
Copy link

@redcinelli redcinelli commented Oct 16, 2024

I found the documentation for the _cat/recovery api lacking some information about the available headers.

I dug a little into the code base to better understand some part such as which headers are defaults, or what are the possible values for stage.

The column names where missing from the documentation.

I need to investigate the recovery stage. I am not too sure of the values applicable there.
Copy link
Contributor

Documentation preview:

@elasticsearchmachine
Copy link
Collaborator

@redcinelli please enable the option "Allow edits and access to secrets by maintainers" on your PR. For more information, see the documentation.

@elasticsearchmachine elasticsearchmachine added v8.15.4 external-contributor Pull request authored by a developer outside the Elasticsearch team labels Oct 16, 2024
Dug into the recovery types in the code. Added some details
@redcinelli redcinelli marked this pull request as ready for review October 16, 2024 10:26
@redcinelli redcinelli requested a review from leemthompo October 16, 2024 10:26
@elasticsearchmachine elasticsearchmachine added the needs:triage Requires assignment of a team area label label Oct 16, 2024
@redcinelli redcinelli added >docs General docs changes Team:Docs Meta label for docs team documentation labels Oct 16, 2024
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine elasticsearchmachine removed the needs:triage Requires assignment of a team area label label Oct 16, 2024
@leemthompo leemthompo added auto-backport Automatically create backport pull requests when merged v8.16.0 v8.17.0 v8.18.0 labels Jan 29, 2025
@leemthompo
Copy link
Contributor

leemthompo commented Jan 29, 2025

@redcinelli sorry this got lost in the vortex of GitHub notifications.

This LGTM and in the auto-generated API docs that will be the source of truth for 9.0+ looks like they have this info

@lcawl wdyt?

@leemthompo leemthompo merged commit d8874b6 into 8.15 Jan 29, 2025
6 checks passed
@leemthompo leemthompo deleted the redcinelli-patch-1 branch January 29, 2025 17:08
leemthompo pushed a commit to leemthompo/elasticsearch that referenced this pull request Jan 29, 2025
@leemthompo
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.x
8.17
8.16

Questions ?

Please refer to the Backport tool documentation

leemthompo pushed a commit to leemthompo/elasticsearch that referenced this pull request Jan 29, 2025
leemthompo pushed a commit to leemthompo/elasticsearch that referenced this pull request Jan 29, 2025
elasticsearchmachine pushed a commit that referenced this pull request Jan 29, 2025
(cherry picked from commit d8874b6)

Co-authored-by: Paulo <[email protected]>
elasticsearchmachine pushed a commit that referenced this pull request Jan 29, 2025
(cherry picked from commit d8874b6)

Co-authored-by: Paulo <[email protected]>
elasticsearchmachine pushed a commit that referenced this pull request Jan 29, 2025
(cherry picked from commit d8874b6)

Co-authored-by: Paulo <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged >docs General docs changes documentation external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Docs Meta label for docs team v8.15.6 v8.16.0 v8.17.0 v8.18.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants