Switch from string to enum for metrics

Author: pquentin

specification/_types/common.ts

@@ -67,9 +67,6 @@ export type ProjectRouting = string
 
 export type Routing = string
 export type LongId = string
-//TODO encode metrics as API specific enums
-export type IndexMetrics = string
-export type Metrics = string | string[]
 
 export type ClusterAlias = string
 
@@ -391,3 +388,31 @@ export enum ClusterInfoTarget {
 }
 
 export type ClusterInfoTargets = ClusterInfoTarget | ClusterInfoTarget[]
+
+
+export enum CommonStatsFlag {
+  _all,
+  store,
+  indexing,
+  get,
+  search,
+  merge,
+  flush,
+  refresh,
+  query_cache,
+  fielddata,
+  docs,
+  warmer,
+  completion,
+  segments,
+  translog,
+  request_cache,
+  recovery,
+  bulk,
+  shard_stats,
+  mappings,
+  dense_vector,
+  sparse_vector
+}
+
+export type CommonStatsFlags = CommonStatsFlag | CommonStatsFlag[]

specification/cluster/reroute/ClusterRerouteRequest.ts

@@ -18,7 +18,6 @@
  */
 
 import { RequestBase } from '@_types/Base'
-import { Metrics } from '@_types/common'
 import { Duration } from '@_types/Time'
 import { Command } from './types'
 
@@ -63,9 +62,10 @@ export interface Request extends RequestBase {
     explain?: boolean
     /**
      * Limits the information returned to the specified metrics.
+     * @deprecated 8.6.0 This parameter has no effect; its use will be forbidden in a future version.
      * @server_default all
      */
-    metric?: Metrics
+    metric?: string | string[]
     /**
      * If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.
      * @server_default false

specification/cluster/state/ClusterStateRequest.ts

@@ -21,7 +21,6 @@ import { RequestBase } from '@_types/Base'
 import {
   ExpandWildcards,
   Indices,
-  Metrics,
   VersionNumber
 } from '@_types/common'
 import { Duration } from '@_types/Time'
@@ -68,7 +67,7 @@ export interface Request extends RequestBase {
     }
   ]
   path_parts: {
-    metric?: Metrics
+    metric?: ClusterStateMetric | ClusterStateMetric[]
     index?: Indices
   }
   query_parameters: {
@@ -91,3 +90,14 @@ export interface Request extends RequestBase {
     wait_for_timeout?: Duration
   }
 }
+
+export enum ClusterStateMetric {
+  version,
+  master_node,
+  blocks,
+  nodes,
+  metadata,
+  routing_table,
+  routing_nodes,
+  customs
+}

specification/indices/stats/IndicesStatsRequest.ts

@@ -19,11 +19,11 @@
 
 import { RequestBase } from '@_types/Base'
 import {
+  CommonStatsFlags,
   ExpandWildcards,
   Fields,
   Indices,
-  Level,
-  Metrics
+  Level
 } from '@_types/common'
 
 /**
@@ -64,7 +64,7 @@ export interface Request extends RequestBase {
     }
   ]
   path_parts: {
-    metric?: Metrics
+    metric?: CommonStatsFlags
     index?: Indices
   }
   query_parameters: {

specification/nodes/info/NodesInfoRequest.ts

@@ -18,7 +18,7 @@
  */
 
 import { RequestBase } from '@_types/Base'
-import { Metrics, NodeIds } from '@_types/common'
+import { NodeIds } from '@_types/common'
 import { Duration } from '@_types/Time'
 
 /**
@@ -54,7 +54,7 @@ export interface Request extends RequestBase {
     /** Comma-separated list of node IDs or names used to limit returned information. */
     node_id?: NodeIds
     /** Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. */
-    metric?: Metrics
+    metric?: NodesInfoMetrics | NodesInfoMetrics[]
   }
   query_parameters: {
     /**
@@ -69,3 +69,20 @@ export interface Request extends RequestBase {
     timeout?: Duration
   }
 }
+
+export enum NodesInfoMetrics {
+  _all,
+  _none,
+  settings,
+  os,
+  process,
+  jvm,
+  thread_pool,
+  transport,
+  http,
+  remote_cluster_server,
+  plugins,
+  ingest,
+  aggregations,
+  indices
+}

specification/nodes/stats/NodesStatsRequest.ts

@@ -18,7 +18,7 @@
  */
 
 import { RequestBase } from '@_types/Base'
-import { Fields, Metrics, NodeIds, NodeStatsLevel } from '@_types/common'
+import { Fields, CommonStatsFlags, NodeIds, NodeStatsLevel } from '@_types/common'
 import { Duration } from '@_types/Time'
 
 /**
@@ -63,9 +63,9 @@ export interface Request extends RequestBase {
     /** Comma-separated list of node IDs or names used to limit returned information. */
     node_id?: NodeIds
     /*+ Limits the information returned to the specific metrics. */
-    metric?: Metrics
+    metric?: NodeStatsMetrics | NodeStatsMetrics[]
     /** Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified.*/
-    index_metric?: Metrics
+    index_metric?: CommonStatsFlags
   }
   query_parameters: {
     /** Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. */
@@ -100,3 +100,24 @@ export interface Request extends RequestBase {
     include_unloaded_segments?: boolean
   }
 }
+
+export enum NodeStatsMetrics {
+  _all,
+  _none,
+  os,
+  process,
+  jvm,
+  thread_pool,
+  fs,
+  transport,
+  http,
+  breaker,
+  script,
+  discovery,
+  ingest,
+  adaptive_selection,
+  script_cache,
+  indexing_pressure,
+  repositories,
+  allocations
+}

specification/nodes/usage/NodesUsageRequest.ts

@@ -18,7 +18,7 @@
  */
 
 import { RequestBase } from '@_types/Base'
-import { Metrics, NodeIds } from '@_types/common'
+import { NodeIds } from '@_types/common'
 import { Duration } from '@_types/Time'
 
 /**
@@ -53,9 +53,9 @@ export interface Request extends RequestBase {
     node_id?: NodeIds
     /**
      * Limits the information returned to the specific metrics.
-     * A comma-separated list of the following options: `_all`, `rest_actions`.
+     * A comma-separated list of the following options: `_all`, `rest_actions`, `aggregations`.
      */
-    metric?: Metrics
+    metric?: NodesUsageMetric | NodesUsageMetric[]
   }
   query_parameters: {
     /**
@@ -66,3 +66,9 @@ export interface Request extends RequestBase {
     timeout?: Duration
   }
 }
+
+export enum NodesUsageMetric {
+  _all,
+  rest_actions,
+  aggregations
+}