Skip to content

Commit 5c60175

Browse files
pquentinDaveCTurner
pquentin
and
DaveCTurner
authored
Add missing common cat params (elastic#134870) (elastic#134986)
Relates elastic/elasticsearch-specification#5298 Co-authored-by: Quentin Pradet <[email protected]> (cherry picked from commit d0ea79a) # Conflicts: # rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json Co-authored-by: David Turner <[email protected]>
1 parent a0b734d commit 5c60175

18 files changed

+325
-2
lines changed

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json‎

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,33 @@
7272
},
7373
"master_timeout": {
7474
"type": "time",
75-
"description": "Timeout for waiting for new cluster state in case it is blocked",
76-
"default": "30s"
75+
"default": "30s",
76+
"description": "Timeout for waiting for new cluster state in case it is blocked"
77+
},
78+
"bytes": {
79+
"type": "enum",
80+
"description": "The unit in which to display byte values",
81+
"options": [
82+
"b",
83+
"kb",
84+
"mb",
85+
"gb",
86+
"tb",
87+
"pb"
88+
]
89+
},
90+
"time": {
91+
"type": "enum",
92+
"description": "The unit in which to display time values",
93+
"options": [
94+
"d",
95+
"h",
96+
"m",
97+
"s",
98+
"ms",
99+
"micros",
100+
"nanos"
101+
]
77102
}
78103
}
79104
}

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.allocation.json‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,19 @@
5252
"pb"
5353
]
5454
},
55+
"time": {
56+
"type": "enum",
57+
"description": "The unit in which to display time values",
58+
"options": [
59+
"d",
60+
"h",
61+
"m",
62+
"s",
63+
"ms",
64+
"micros",
65+
"nanos"
66+
]
67+
},
5568
"local": {
5669
"type": "boolean",
5770
"description": "Return local information, do not retrieve the state from master node (default: false)"

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.component_templates.json‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,31 @@
6565
"type": "boolean",
6666
"description": "Verbose mode. Display column headers",
6767
"default": false
68+
},
69+
"bytes": {
70+
"type": "enum",
71+
"description": "The unit in which to display byte values",
72+
"options": [
73+
"b",
74+
"kb",
75+
"mb",
76+
"gb",
77+
"tb",
78+
"pb"
79+
]
80+
},
81+
"time": {
82+
"type": "enum",
83+
"description": "The unit in which to display time values",
84+
"options": [
85+
"d",
86+
"h",
87+
"m",
88+
"s",
89+
"ms",
90+
"micros",
91+
"nanos"
92+
]
6893
}
6994
}
7095
}

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.count.json‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,31 @@
5757
"type": "boolean",
5858
"description": "Verbose mode. Display column headers",
5959
"default": false
60+
},
61+
"bytes": {
62+
"type": "enum",
63+
"description": "The unit in which to display byte values",
64+
"options": [
65+
"b",
66+
"kb",
67+
"mb",
68+
"gb",
69+
"tb",
70+
"pb"
71+
]
72+
},
73+
"time": {
74+
"type": "enum",
75+
"description": "The unit in which to display time values",
76+
"options": [
77+
"d",
78+
"h",
79+
"m",
80+
"s",
81+
"ms",
82+
"micros",
83+
"nanos"
84+
]
6085
}
6186
}
6287
}

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.fielddata.json‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,19 @@
7373
"fields": {
7474
"type": "list",
7575
"description": "A comma-separated list of fields to return in the output"
76+
},
77+
"time": {
78+
"type": "enum",
79+
"description": "The unit in which to display time values",
80+
"options": [
81+
"d",
82+
"h",
83+
"m",
84+
"s",
85+
"ms",
86+
"micros",
87+
"nanos"
88+
]
7689
}
7790
}
7891
}

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,18 @@
6363
"type": "boolean",
6464
"description": "Verbose mode. Display column headers",
6565
"default": false
66+
},
67+
"bytes": {
68+
"type": "enum",
69+
"description": "The unit in which to display byte values",
70+
"options": [
71+
"b",
72+
"kb",
73+
"mb",
74+
"gb",
75+
"tb",
76+
"pb"
77+
]
6678
}
6779
}
6880
}

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.master.json‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,31 @@
5353
"type": "boolean",
5454
"description": "Verbose mode. Display column headers",
5555
"default": false
56+
},
57+
"bytes": {
58+
"type": "enum",
59+
"description": "The unit in which to display byte values",
60+
"options": [
61+
"b",
62+
"kb",
63+
"mb",
64+
"gb",
65+
"tb",
66+
"pb"
67+
]
68+
},
69+
"time": {
70+
"type": "enum",
71+
"description": "The unit in which to display time values",
72+
"options": [
73+
"d",
74+
"h",
75+
"m",
76+
"s",
77+
"ms",
78+
"micros",
79+
"nanos"
80+
]
5681
}
5782
}
5883
}

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,18 @@
7474
"type": "boolean",
7575
"description": "Verbose mode. Display column headers",
7676
"default": false
77+
},
78+
"bytes": {
79+
"type": "enum",
80+
"description": "The unit in which to display byte values",
81+
"options": [
82+
"b",
83+
"kb",
84+
"mb",
85+
"gb",
86+
"tb",
87+
"pb"
88+
]
7789
}
7890
}
7991
}

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodeattrs.json‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,31 @@
5353
"type": "boolean",
5454
"description": "Verbose mode. Display column headers",
5555
"default": false
56+
},
57+
"bytes": {
58+
"type": "enum",
59+
"description": "The unit in which to display byte values",
60+
"options": [
61+
"b",
62+
"kb",
63+
"mb",
64+
"gb",
65+
"tb",
66+
"pb"
67+
]
68+
},
69+
"time": {
70+
"type": "enum",
71+
"description": "The unit in which to display time values",
72+
"options": [
73+
"d",
74+
"h",
75+
"m",
76+
"s",
77+
"ms",
78+
"micros",
79+
"nanos"
80+
]
5681
}
5782
}
5883
}

‎rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,18 @@
6666
"type": "boolean",
6767
"description": "Verbose mode. Display column headers",
6868
"default": false
69+
},
70+
"bytes": {
71+
"type": "enum",
72+
"description": "The unit in which to display byte values",
73+
"options": [
74+
"b",
75+
"kb",
76+
"mb",
77+
"gb",
78+
"tb",
79+
"pb"
80+
]
6981
}
7082
}
7183
}

0 commit comments

Comments
 (0)