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

[BUG] _cat help content cleanup after fork #14653

Closed
lukas-vlcek opened this issue Jul 4, 2024 · 2 comments · Fixed by #14722
Closed

[BUG] _cat help content cleanup after fork #14653

lukas-vlcek opened this issue Jul 4, 2024 · 2 comments · Fixed by #14722
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers Other v1.3.19 Issues and PRs related to version 1.3.19 v2.16.0 Issues and PRs related to version 2.16.0 v3.0.0 Issues and PRs related to version 3.0.0

Comments

@lukas-vlcek
Copy link
Contributor

Describe the bug

It seems that help output of the _cat API was not fully reviewed when the fork happened.

One example: http://localhost:9200/_cat/nodes?help

id                                 | id,nodeId                                   | unique node id                                                                                                   
pid                                | p                                           | process id                                                                                                       
ip                                 | i                                           | ip address                                                                                                       
port                               | po                                          | bound transport port                                                                                             
http_address                       | http                                        | bound http address                                                                                               
version                            | v                                           | es version                                                                                                       
type                               | t                                           | es distribution type                                                                                             
build                              | b                                           | es build hash  
[... cont.]

See the explanation for version, type and build.

It would be useful to review all _cat API help texts.

Related component

Other

To Reproduce

  1. Go to http://localhost:9200/_cat/
  2. Iterate over all options (ie. allocation, segment_replication, ...)
  3. Append ?help to the URL
  4. Check the help text, especially the explanation column

Expected behavior

Help output should not refer to previous product name or acronyms.

Additional Details

No response

@lukas-vlcek lukas-vlcek added bug Something isn't working untriaged labels Jul 4, 2024
@github-actions github-actions bot added the Other label Jul 4, 2024
@lukas-vlcek
Copy link
Contributor Author

IMO this is an ideal candidate for the "good first issue" category.

@peternied peternied added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 10, 2024
@peternied
Copy link
Member

[Triage - attendees 1 2 3 4 5]
@lukas-vlcek Thanks for creating this issue - this is a great candidate for a good first issue.

@reta reta added v3.0.0 Issues and PRs related to version 3.0.0 v2.16.0 Issues and PRs related to version 2.16.0 labels Jul 11, 2024
@reta reta added the v1.3.19 Issues and PRs related to version 1.3.19 label Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers Other v1.3.19 Issues and PRs related to version 1.3.19 v2.16.0 Issues and PRs related to version 2.16.0 v3.0.0 Issues and PRs related to version 3.0.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants