Skip to content

[BUG] _cat help content cleanup after fork #14653

Closed
@lukas-vlcek

Description

@lukas-vlcek

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    OtherbugSomething isn't workingdocumentationImprovements or additions to documentationgood first issueGood for newcomersv1.3.19Issues and PRs related to version 1.3.19v2.16.0Issues and PRs related to version 2.16.0v3.0.0Issues and PRs related to version 3.0.0

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions