[8.0] Update cat datafeeds specification (#1304) (#1332)

Author: lcawl

output/schema/schema.json

@@ -402,3 +402,73 @@ export enum CatAnonalyDetectorColumn {
 export type CatAnonalyDetectorColumns =
   | CatAnonalyDetectorColumn
   | CatAnonalyDetectorColumn[]
+
+export enum CatDatafeedColumn {
+  /**
+   * For started datafeeds only, contains messages relating to the selection of
+   * a node.
+   * @aliases assignment_explanation
+   */
+  ae = 0,
+  /**
+   * The number of buckets processed.
+   * @aliases buckets.count, bucketsCount
+   */
+  bc = 1,
+  /** A numerical character string that uniquely identifies the datafeed. */
+  id = 2,
+  /**
+   * For started datafeeds only, the network address of the node where the
+   * datafeed is started.
+   * @aliases node.address, nodeAddress
+   */
+  na = 3,
+  /**
+   * For started datafeeds only, the ephemeral ID of the node where the
+   * datafeed is started.
+   * @aliases node.ephemeral_id, nodeEphemeralId
+   */
+  ne = 4,
+  /**
+   * For started datafeeds only, the unique identifier of the node where the
+   * datafeed is started.
+   * @aliases node.id, nodeId
+   */
+  ni = 5,
+  /**
+   * For started datafeeds only, the name of the node where the datafeed is
+   * started.
+   * @aliases node.name, nodeName
+   */
+  nn = 6,
+  /**
+   * The average search time per bucket, in milliseconds.
+   * @aliases search.bucket_avg, searchBucketAvg
+   */
+  sba = 7,
+  /**
+   * The number of searches run by the datafeed.
+   * @aliases search.count, searchCount */
+  sc = 8,
+  /**
+   * The exponential average search time per hour, in milliseconds.
+   * @aliases search.exp_avg_hour, searchExpAvgHour
+   */
+  seah = 9,
+  /**
+   * The total time the datafeed spent searching, in milliseconds.
+   * @aliases search.time, searchTime */
+  st = 10,
+  /**
+   * The status of the datafeed: `starting`, `started`, `stopping`, or `stopped`.
+   * If `starting`, the datafeed has been requested to start but has not yet
+   * started. If `started`, the datafeed is actively receiving data. If
+   * `stopping`, the datafeed has been requested to stop gracefully and is
+   * completing its final action. If `stopped`, the datafeed is stopped and will
+   * not receive data until it is re-started.
+   * @aliases state
+   */
+  s = 11
+}
+
+export type CatDatafeedColumns = CatDatafeedColumn | CatDatafeedColumn[]

output/schema/validation-errors.json

@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { CatRequestBase } from '@cat/_types/CatBase'
+import { CatRequestBase, CatDatafeedColumns } from '@cat/_types/CatBase'
 import { Id } from '@_types/common'
 import { TimeUnit } from '@_types/Time'
 
@@ -35,9 +35,7 @@ import { TimeUnit } from '@_types/Time'
 export interface Request extends CatRequestBase {
   path_parts: {
     /**
-     * A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase
-     * alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric
-     * characters.
+     * A numerical character string that uniquely identifies the datafeed.
      */
     datafeed_id?: Id
   }
@@ -55,9 +53,27 @@ export interface Request extends CatRequestBase {
      * @server_default true
      */
     allow_no_match?: boolean
+    /** Short version of the HTTP accept header. Valid values include JSON, YAML, for example. */
+    format?: string
+    /**
+     * Comma-separated list of column names to display.
+     * @server_default bc,id,sc,s
+     */
+    h?: CatDatafeedColumns
+    /** If `true`, the response includes help information.
+     * @server_default false
+     */
+    help?: boolean
+    /** Comma-separated list of column names or column aliases used to sort the response. */
+    s?: CatDatafeedColumns
     /**
      * The unit used to display time values.
      */
     time?: TimeUnit
+    /**
+     * If `true`, the response includes column headings.
+     * @server_default false
+     */
+    v?: boolean
   }
 }