Skip to content

Add missing common cat params #134870

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Sep 18, 2025
Merged

Add missing common cat params #134870

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
23d29a0
Add missing common cat params
DaveCTurner Sep 17, 2025
08b2ef9
Merge branch 'main' into 2025/09/17/common-cat-params
DaveCTurner Sep 17, 2025
93335a4
Merge remote-tracking branch 'origin/main' into 2025/09/17/common-cat…
pquentin Sep 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,31 @@
"type": "time",
"description": "Timeout for waiting for new cluster state in case it is blocked",
"default": "30s"
},
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": [
"b",
"kb",
"mb",
"gb",
"tb",
"pb"
]
},
"time": {
"type": "enum",
"description": "The unit in which to display time values",
"options": [
"d",
"h",
"m",
"s",
"ms",
"micros",
"nanos"
]
}
}
}
Expand Down
13 changes: 13 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.allocation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,19 @@
"pb"
]
},
"time": {
"type": "enum",
"description": "The unit in which to display time values",
"options": [
"d",
"h",
"m",
"s",
"ms",
"micros",
"nanos"
]
},
"local": {
"type": "boolean",
"description": "Return local information, do not retrieve the state from master node (default: false)"
Expand Down
25 changes: 25 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.component_templates.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,31 @@
"type": "boolean",
"description": "Verbose mode. Display column headers",
"default": false
},
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": [
"b",
"kb",
"mb",
"gb",
"tb",
"pb"
]
},
"time": {
"type": "enum",
"description": "The unit in which to display time values",
"options": [
"d",
"h",
"m",
"s",
"ms",
"micros",
"nanos"
]
}
}
}
Expand Down
25 changes: 25 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.count.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,31 @@
"type": "boolean",
"description": "Verbose mode. Display column headers",
"default": false
},
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": [
"b",
"kb",
"mb",
"gb",
"tb",
"pb"
]
},
"time": {
"type": "enum",
"description": "The unit in which to display time values",
"options": [
"d",
"h",
"m",
"s",
"ms",
"micros",
"nanos"
]
}
}
}
Expand Down
13 changes: 13 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.fielddata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,19 @@
"fields": {
"type": "list",
"description": "A comma-separated list of fields to return in the output"
},
"time": {
"type": "enum",
"description": "The unit in which to display time values",
"options": [
"d",
"h",
"m",
"s",
"ms",
"micros",
"nanos"
]
}
}
}
Expand Down
12 changes: 12 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,18 @@
"type": "boolean",
"description": "Verbose mode. Display column headers",
"default": false
},
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": [
"b",
"kb",
"mb",
"gb",
"tb",
"pb"
]
}
}
}
Expand Down
25 changes: 25 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.master.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,31 @@
"type": "boolean",
"description": "Verbose mode. Display column headers",
"default": false
},
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": [
"b",
"kb",
"mb",
"gb",
"tb",
"pb"
]
},
"time": {
"type": "enum",
"description": "The unit in which to display time values",
"options": [
"d",
"h",
"m",
"s",
"ms",
"micros",
"nanos"
]
}
}
}
Expand Down
12 changes: 12 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,18 @@
"type": "boolean",
"description": "Verbose mode. Display column headers",
"default": false
},
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": [
"b",
"kb",
"mb",
"gb",
"tb",
"pb"
]
}
}
}
Expand Down
25 changes: 25 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodeattrs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,31 @@
"type": "boolean",
"description": "Verbose mode. Display column headers",
"default": false
},
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": [
"b",
"kb",
"mb",
"gb",
"tb",
"pb"
]
},
"time": {
"type": "enum",
"description": "The unit in which to display time values",
"options": [
"d",
"h",
"m",
"s",
"ms",
"micros",
"nanos"
]
}
}
}
Expand Down
12 changes: 12 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,18 @@
"type": "boolean",
"description": "Verbose mode. Display column headers",
"default": false
},
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": [
"b",
"kb",
"mb",
"gb",
"tb",
"pb"
]
}
}
}
Expand Down
25 changes: 25 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.plugins.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,31 @@
"type": "boolean",
"description": "Verbose mode. Display column headers",
"default": false
},
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": [
"b",
"kb",
"mb",
"gb",
"tb",
"pb"
]
},
"time": {
"type": "enum",
"description": "The unit in which to display time values",
"options": [
"d",
"h",
"m",
"s",
"ms",
"micros",
"nanos"
]
}
}
}
Expand Down
25 changes: 25 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.repositories.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,31 @@
"type": "boolean",
"description": "Verbose mode. Display column headers",
"default": false
},
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": [
"b",
"kb",
"mb",
"gb",
"tb",
"pb"
]
},
"time": {
"type": "enum",
"description": "The unit in which to display time values",
"options": [
"d",
"h",
"m",
"s",
"ms",
"micros",
"nanos"
]
}
}
}
Expand Down
13 changes: 13 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.segments.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,19 @@
"type": "boolean",
"description": "Verbose mode. Display column headers",
"default": false
},
"time": {
"type": "enum",
"description": "The unit in which to display time values",
"options": [
"d",
"h",
"m",
"s",
"ms",
"micros",
"nanos"
]
}
}
}
Expand Down
12 changes: 12 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.snapshots.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,18 @@
"type": "boolean",
"description": "Verbose mode. Display column headers",
"default": false
},
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": [
"b",
"kb",
"mb",
"gb",
"tb",
"pb"
]
}
}
}
Expand Down
12 changes: 12 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/cat.tasks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,18 @@
"type": "boolean",
"default": false,
"description": "If `true`, the request blocks until the task has completed."
},
"bytes": {
"type": "enum",
"description": "The unit in which to display byte values",
"options": [
"b",
"kb",
"mb",
"gb",
"tb",
"pb"
]
}
}
}
Expand Down
Loading