Add descriptions for final cat APIs

specification/cat/ml_data_frame_analytics/types.ts

@@ -21,81 +21,81 @@ import { Id, IndexName, Name, VersionString } from '@_types/common'
 
 export class DataFrameAnalyticsRecord {
   /**
-   * the id
+   * The identifier for the job.
    */
   'id'?: Id
   /**
-   * analysis type
+   * The type of analysis that the job performs.
    * @aliases t
    */
   'type'?: string
   /**
-   * job creation time
+   * The time when the job was created.
    * @aliases ct, createTime
    */
   'create_time'?: string
   /**
-   * the version of Elasticsearch when the analytics was created
+   * The version of Elasticsearch when the job was created.
    * @aliases v
    */
   'version'?: VersionString
   /**
-   * source index
+   * The name of the source index.
    * @aliases si, sourceIndex
    */
   'source_index'?: IndexName
   /**
-   * destination index
+   * The name of the destination index.
    * @aliases di, destIndex
    */
   'dest_index'?: IndexName
   /**
-   * description
+   * A description of the job.
    * @aliases d
    */
   'description'?: string
   /**
-   * model memory limit
+   * The approximate maximum amount of memory resources that are permitted for the job.
    * @aliases mml, modelMemoryLimit
    */
   'model_memory_limit'?: string
   /**
-   * job state
+   * The current status of the job.
    * @aliases s
    */
   'state'?: string
   /**
-   * failure reason
+   * Messages about the reason why the job failed.
    * @aliases fr, failureReason
    */
   'failure_reason'?: string
   /**
-   * progress
+   * The progress report for the job by phase.
    * @aliases p
    */
   'progress'?: string
   /**
-   * why the job is or is not assigned to a node
+   * Messages related to the selection of a node.
    * @aliases ae, assignmentExplanation
    */
   'assignment_explanation'?: string
   /**
-   * id of the assigned node
+   * The unique identifier of the assigned node.
    * @aliases ni, nodeId
    */
   'node.id'?: Id
   /**
-   * name of the assigned node
+   * The name of the assigned node.
    * @aliases nn, nodeName
    */
   'node.name'?: Name
   /**
-   * ephemeral id of the assigned node
+   * The ephemeral identifier of the assigned node.
    * @aliases ne, nodeEphemeralId
    */
   'node.ephemeral_id'?: Id
   /**
-   * network address of the assigned node
+   * The network address of the assigned node.
    * @aliases na, nodeAddress
    */
   'node.address'?: string

specification/cat/ml_datafeeds/types.ts

@@ -21,62 +21,66 @@ import { DatafeedState } from '@ml/_types/Datafeed'
 
 export class DatafeedsRecord {
   /**
-   * the datafeed_id
+   * The datafeed identifier.
    */
   'id'?: string
   /**
-   * the datafeed state
+   * The status of the datafeed.
    * @aliases s
    */
   'state'?: DatafeedState
   /**
-   * why the datafeed is or is not assigned to a node
+   * For started datafeeds only, contains messages relating to the selection of a node.
    * @aliases ae
    */
   'assignment_explanation'?: string
   /**
-   * bucket count
+   * The number of buckets processed.
    * @aliases bc, bucketsCount
    */
   'buckets.count'?: string
   /**
-   * number of searches ran by the datafeed
+   * The number of searches run by the datafeed.
    * @aliases sc, searchCount
    */
   'search.count'?: string
   /**
-   * the total search time
+   * The total time the datafeed spent searching, in milliseconds.
    * @aliases st, searchTime
    */
   'search.time'?: string
   /**
-   * the average search time per bucket (millisecond)
+   * The average search time per bucket, in milliseconds.
    * @aliases sba, searchBucketAvg
    */
   'search.bucket_avg'?: string
   /**
-   * the exponential average search time per hour (millisecond)
+   * The exponential average search time per hour, in milliseconds.
    * @aliases seah, searchExpAvgHour
    */
   //Node info
   'search.exp_avg_hour'?: string
   /**
-   * id of the assigned node
+   * The unique identifier of the assigned node.
+   * For started datafeeds only, this information pertains to the node upon which the datafeed is started.
    * @aliases ni, nodeId
    */
   'node.id'?: string
   /**
-   * name of the assigned node
+   * The name of the assigned node.
+   * For started datafeeds only, this information pertains to the node upon which the datafeed is started.
    * @aliases nn, nodeName
    */
   'node.name'?: string
   /**
-   * ephemeral id of the assigned node
+   * The ephemeral identifier of the assigned node.
+   * For started datafeeds only, this information pertains to the node upon which the datafeed is started.
    * @aliases ne, nodeEphemeralId
    */
   'node.ephemeral_id'?: string
   /**
-   * network address of the assigned node
+   * The network address of the assigned node.
+   * For started datafeeds only, this information pertains to the node upon which the datafeed is started.
    * @aliases na, nodeAddress
    */
   'node.address'?: string