Add authorization property to ML datafeed, job, and transform specs

Author: lcawl

output/schema/schema.json

@@ -0,0 +1,71 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+export class ApiKeyAuthorization {
+  /**
+   * The identifier for the API key.
+   */
+  id: string
+  /**
+   * The name of the API key.
+   */
+  name: string
+}
+
+export class DatafeedAuthorization {
+  /**
+   *  If an API key was used for the most recent update to the datafeed, its name and identifier are listed in the response.
+   */
+  api_key?: ApiKeyAuthorization
+  /**
+   *  If a user ID was used for the most recent update to the datafeed, its roles at the time of the update are listed in the response. */
+  roles?: string[]
+  /**
+   * If a service account was used for the most recent update to the datafeed, the account name is listed in the response.
+   */
+  service_account?: string
+}
+
+export class DataframeAnalyticsAuthorization {
+  /**
+   *  If an API key was used for the most recent update to the job, its name and identifier are listed in the response.
+   */
+  api_key?: ApiKeyAuthorization
+  /**
+   *  If a user ID was used for the most recent update to the job, its roles at the time of the update are listed in the response. */
+  roles?: string[]
+  /**
+   * If a service account was used for the most recent update to the job, the account name is listed in the response.
+   */
+  service_account?: string
+}
+
+export class TransformAuthorization {
+  /**
+   *  If an API key was used for the most recent update to the transform, its name and identifier are listed in the response.
+   */
+  api_key?: ApiKeyAuthorization
+  /**
+   *  If a user ID was used for the most recent update to the transform, its roles at the time of the update are listed in the response. */
+  roles?: string[]
+  /**
+   * If a service account was used for the most recent update to the transform, the account name is listed in the response.
+   */
+  service_account?: string
+}

output/schema/validation-errors.json

@@ -32,10 +32,15 @@ import {
   UnitFloatMillis
 } from '@_types/Time'
 import { DiscoveryNode } from './DiscoveryNode'
+import { DatafeedAuthorization } from '@ml/_types/Authorization'
 
 export class Datafeed {
   /** @aliases aggs */
   aggregations?: Dictionary<string, AggregationContainer>
+  /**
+   * The security privileges that the datafeed uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the datafeed, this property is omitted.
+   */
+  authorization?: DatafeedAuthorization
   chunking_config?: ChunkingConfig
   datafeed_id: Id
   frequency?: Duration

output/typescript/types.ts

@@ -34,6 +34,7 @@ import { double, integer, long, Percentage } from '@_types/Numeric'
 import { QueryContainer } from '@_types/query_dsl/abstractions'
 import { UnitMillis, DurationValue, EpochTime } from '@_types/Time'
 import { DataframeState } from './Dataframe'
+import { DataframeAnalyticsAuthorization } from '@ml/_types/Authorization'
 
 export class DataframeAnalyticsSource {
   /** Index or indices on which to perform the analysis. It can be a single index or index pattern as well as an array of indices or patterns. NOTE: If your source indices contain documents with the same IDs, only the document that is indexed last appears in the destination index.*/
@@ -303,16 +304,20 @@ export class DataframeAnalysisFeatureProcessorTargetMeanEncoding {
 }
 
 export class DataframeAnalyticsSummary {
-  id: Id
-  source: DataframeAnalyticsSource
-  dest: DataframeAnalyticsDestination
+  allow_lazy_start?: boolean
   analysis: DataframeAnalysisContainer
-  description?: string
-  model_memory_limit?: string
-  max_num_threads?: integer
   analyzed_fields?: DataframeAnalysisAnalyzedFields
-  allow_lazy_start?: boolean
+  /**
+   * The security privileges that the job uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the job, this property is omitted.
+   */
+  authorization?: DataframeAnalyticsAuthorization
   create_time?: EpochTime<UnitMillis>
+  description?: string
+  dest: DataframeAnalyticsDestination
+  id: Id
+  max_num_threads?: integer
+  model_memory_limit?: string
+  source: DataframeAnalyticsSource
   version?: VersionString
 }
 

specification/ml/_types/Authorization.ts

@@ -17,6 +17,7 @@
  * under the License.
  */
 
+import { DataframeAnalyticsAuthorization } from '@ml/_types/Authorization'
 import {
   DataframeAnalysisAnalyzedFields,
   DataframeAnalysisContainer,
@@ -29,16 +30,17 @@ import { EpochTime, UnitMillis } from '@_types/Time'
 
 export class Response {
   body: {
-    id: Id
+    authorization?: DataframeAnalyticsAuthorization
+    allow_lazy_start: boolean
+    analysis: DataframeAnalysisContainer
+    analyzed_fields?: DataframeAnalysisAnalyzedFields
     create_time: EpochTime<UnitMillis>
-    version: VersionString
-    source: DataframeAnalyticsSource
     description?: string
     dest: DataframeAnalyticsDestination
-    model_memory_limit: string
-    allow_lazy_start: boolean
+    id: Id
     max_num_threads: integer
-    analysis: DataframeAnalysisContainer
-    analyzed_fields?: DataframeAnalysisAnalyzedFields
+    model_memory_limit: string
+    source: DataframeAnalyticsSource
+    version: VersionString
   }
 }

specification/ml/_types/Datafeed.ts

@@ -17,6 +17,7 @@
  * under the License.
  */
 
+import { DatafeedAuthorization } from '@ml/_types/Authorization'
 import { ChunkingConfig, DelayedDataCheckConfig } from '@ml/_types/Datafeed'
 import { Dictionary } from '@spec_utils/Dictionary'
 import { AggregationContainer } from '@_types/aggregations/AggregationContainer'
@@ -30,6 +31,7 @@ import { Duration } from '@_types/Time'
 export class Response {
   body: {
     aggregations: Dictionary<string, AggregationContainer>
+    authorization?: DatafeedAuthorization
     chunking_config: ChunkingConfig
     delayed_data_check_config?: DelayedDataCheckConfig
     datafeed_id: Id