update variant rule

margaretjgu · margaretjgu · commit f8784ec15a14 · 2025-11-05T10:49:42.000-05:00
diff --git a/specification/_global/search/SearchRequest.ts b/specification/_global/search/SearchRequest.ts
@@ -463,7 +463,7 @@ export interface Request extends RequestBase {
      * @availability serverless
      * @ext_doc_id knn-approximate
      */
-    // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
     knn?: KnnSearch | KnnSearch[]
     /**
      * The Reciprocal Rank Fusion (RRF) to use.
@@ -495,7 +495,7 @@ export interface Request extends RequestBase {
     /**
      * Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.
      */
-    // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
     rescore?: Rescore | Rescore[]
     /**
      * A retriever is a specification to describe top documents returned from a search.
diff --git a/specification/_global/search/_types/FieldCollapse.ts b/specification/_global/search/_types/FieldCollapse.ts
@@ -32,7 +32,7 @@ export class FieldCollapse {
   /**
    * The number of inner hits and their sort order
    */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   inner_hits?: InnerHits | InnerHits[]
   /**
    * The number of concurrent requests allowed to retrieve the inner_hits per group
diff --git a/specification/_global/search/_types/SearchRequestBody.ts b/specification/_global/search/_types/SearchRequestBody.ts
@@ -98,7 +98,7 @@ export class SearchRequestBody {
    * @availability serverless
    * @ext_doc_id knn-approximate
    */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   knn?: KnnSearch | KnnSearch[]
   /**
    * The Reciprocal Rank Fusion (RRF) to use.
@@ -130,7 +130,7 @@ export class SearchRequestBody {
   /**
    * Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.
    */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   rescore?: Rescore | Rescore[]
   /**
    * A retriever is a specification to describe top documents returned from a search.
diff --git a/specification/_global/search/_types/suggester.ts b/specification/_global/search/_types/suggester.ts
@@ -50,23 +50,22 @@ export class SuggestBase {
  * @variant name=completion
  */
 export class CompletionSuggest<TDocument> extends SuggestBase {
-  options: // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
-  CompletionSuggestOption<TDocument> | CompletionSuggestOption<TDocument>[]
+  options:
+    | CompletionSuggestOption<TDocument>
+    | CompletionSuggestOption<TDocument>[]
 }
 
 /**
  * @variant name=phrase
  */
 export class PhraseSuggest extends SuggestBase {
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
   options: PhraseSuggestOption | PhraseSuggestOption[]
 }
 
 /**
  * @variant name=term
  */
 export class TermSuggest extends SuggestBase {
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
   options: TermSuggestOption | TermSuggestOption[]
 }
 
diff --git a/specification/_types/Knn.ts b/specification/_types/Knn.ts
@@ -51,7 +51,7 @@ export interface KnnSearch {
   /** Boost value to apply to kNN scores */
   boost?: float
   /** Filters for the kNN search query */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   filter?: QueryContainer | QueryContainer[]
   /** The minimum similarity for a vector to be considered a match */
   similarity?: float
@@ -87,7 +87,7 @@ export interface KnnQuery extends QueryBase {
   /** The final number of nearest neighbors to return as top hits */
   k?: integer
   /** Filters for the kNN search query */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   filter?: QueryContainer | QueryContainer[]
   /** The minimum similarity for a vector to be considered a match */
   similarity?: float
diff --git a/specification/_types/Retriever.ts b/specification/_types/Retriever.ts
@@ -53,7 +53,7 @@ export class RetrieverContainer {
 
 export class RetrieverBase {
   /** Query to filter the documents that can match. */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   filter?: QueryContainer | QueryContainer[]
   /** Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. */
   min_score?: float
@@ -64,7 +64,7 @@ export class RetrieverBase {
 export class RescorerRetriever extends RetrieverBase {
   /** Inner retriever. */
   retriever: RetrieverContainer
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   rescore: Rescore | Rescore[]
 }
 
diff --git a/specification/_types/aggregations/metric.ts b/specification/_types/aggregations/metric.ts
@@ -439,7 +439,7 @@ export class TopMetricsAggregation extends MetricAggregationBase {
   /**
    * The fields of the top document to return.
    */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   metrics?: TopMetricsValue | TopMetricsValue[]
   /**
    * The number of top documents from which to return metrics.
diff --git a/specification/_types/analysis/phonetic-plugin.ts b/specification/_types/analysis/phonetic-plugin.ts
@@ -64,7 +64,7 @@ export enum PhoneticRuleType {
 export class PhoneticTokenFilter extends TokenFilterBase {
   type: 'phonetic'
   encoder: PhoneticEncoder
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   languageset?: PhoneticLanguage | PhoneticLanguage[]
   max_code_len?: integer
   name_type?: PhoneticNameType
diff --git a/specification/_types/query_dsl/compound.ts b/specification/_types/query_dsl/compound.ts
@@ -34,7 +34,7 @@ export class BoolQuery extends QueryBase {
    * The clause (query) must appear in matching documents.
    * However, unlike `must`, the score of the query will be ignored.
    */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   filter?: QueryContainer | QueryContainer[]
   /**
    * Specifies the number or percentage of `should` clauses returned documents must match.
@@ -44,18 +44,18 @@ export class BoolQuery extends QueryBase {
   /**
    * The clause (query) must appear in matching documents and will contribute to the score.
    */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   must?: QueryContainer | QueryContainer[]
   /**
    * The clause (query) must not appear in the matching documents.
    * Because scoring is ignored, a score of `0` is returned for all documents.
    */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   must_not?: QueryContainer | QueryContainer[]
   /**
    * The clause (query) should appear in the matching document.
    */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   should?: QueryContainer | QueryContainer[]
 }
 
diff --git a/specification/_types/query_dsl/specialized.ts b/specification/_types/query_dsl/specialized.ts
@@ -119,7 +119,7 @@ export class MoreLikeThisQuery extends QueryBase {
   /**
    * Specifies free form text and/or a single or multiple documents for which you want to find similar documents.
    */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   like: Like | Like[]
   /**
    * The maximum document frequency above which the terms are ignored from the input document.
@@ -166,7 +166,7 @@ export class MoreLikeThisQuery extends QueryBase {
   /**
    * Used in combination with `like` to exclude documents that match a set of terms.
    */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   unlike?: Like | Like[]
   version?: VersionNumber
   /** @server_default 'internal' */
diff --git a/specification/async_search/submit/AsyncSearchSubmitRequest.ts b/specification/async_search/submit/AsyncSearchSubmitRequest.ts
@@ -228,7 +228,7 @@ export interface Request extends RequestBase {
      * @availability stack since=8.4.0
      * @availability serverless
      */
-    // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
     knn?: KnnSearch | KnnSearch[]
     /**
      * Minimum _score for matching documents. Documents with a lower _score are
@@ -241,7 +241,7 @@ export interface Request extends RequestBase {
      * Defines the search definition using the Query DSL.
      */
     query?: QueryContainer
-    // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
     rescore?: Rescore | Rescore[]
     /**
      * Retrieve a script evaluation (based on different fields) for each hit.
diff --git a/specification/connector/sync_job_list/SyncJobListRequest.ts b/specification/connector/sync_job_list/SyncJobListRequest.ts
@@ -60,7 +60,7 @@ export interface Request extends RequestBase {
     /**
      * A comma-separated list of job types to fetch the sync jobs for
      */
-    // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
     job_type?: SyncJobType | SyncJobType[]
   }
 }
diff --git a/specification/eql/search/EqlSearchRequest.ts b/specification/eql/search/EqlSearchRequest.ts
@@ -131,7 +131,7 @@ export interface Request extends RequestBase {
     /**
      * Query, written in Query DSL, used to filter the events on which the EQL query runs.
      */
-    // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
     filter?: QueryContainer | QueryContainer[]
     keep_alive?: Duration
     keep_on_completion?: boolean
@@ -158,7 +158,7 @@ export interface Request extends RequestBase {
     /**
      * Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit.
      */
-    // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
     fields?: FieldAndFormat | FieldAndFormat[]
     /**
      * @server_default tail
diff --git a/specification/fleet/search/SearchRequest.ts b/specification/fleet/search/SearchRequest.ts
@@ -185,7 +185,7 @@ export interface Request extends RequestBase {
      * Defines the search definition using the Query DSL.
      */
     query?: QueryContainer
-    // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
     rescore?: Rescore | Rescore[]
     /**
      * Retrieve a script evaluation (based on different fields) for each hit.
diff --git a/specification/indices/_types/IndexSegmentSort.ts b/specification/indices/_types/IndexSegmentSort.ts
@@ -21,11 +21,11 @@ import { Fields } from '@_types/common'
 
 export class IndexSegmentSort {
   field?: Fields
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   order?: SegmentSortOrder | SegmentSortOrder[]
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   mode?: SegmentSortMode | SegmentSortMode[]
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   missing?: SegmentSortMissing | SegmentSortMissing[]
 }
 
diff --git a/specification/indices/resolve_index/ResolveIndexRequest.ts b/specification/indices/resolve_index/ResolveIndexRequest.ts
@@ -70,7 +70,7 @@ export interface Request extends RequestBase {
      * @availability stack since=9.2.0 stability=stable
      * @availability serverless stability=stable visibility=public
      */
-    // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
     mode?: IndexMode | IndexMode[]
     /**
      * Specifies a subset of projects to target using project
diff --git a/specification/indices/shard_stores/IndicesShardStoresRequest.ts b/specification/indices/shard_stores/IndicesShardStoresRequest.ts
@@ -77,7 +77,7 @@ export interface Request extends RequestBase {
     /**
      * List of shard health statuses used to limit the request.
      */
-    // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
     status?: ShardStoreStatus | ShardStoreStatus[]
   }
 }
diff --git a/specification/indices/update_aliases/types.ts b/specification/indices/update_aliases/types.ts
@@ -48,7 +48,7 @@ export class AddAction {
    * Aliases for the action.
    * Index alias names support date math.
    */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   aliases?: IndexAlias | IndexAlias[]
   /**
    * Query used to limit documents the alias can access.
@@ -105,7 +105,7 @@ export class RemoveAction {
    * Aliases for the action.
    * Index alias names support date math.
    */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   aliases?: IndexAlias | IndexAlias[]
   /**
    * Data stream or index for the action.
diff --git a/specification/ingest/_types/Processors.ts b/specification/ingest/_types/Processors.ts
@@ -1053,7 +1053,7 @@ export class InferenceProcessor extends ProcessorBase {
    * Input fields for inference and output (destination) fields for the inference results.
    * This option is incompatible with the target_field and field_map options.
    */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   input_output?: InputConfig | InputConfig[]
 
   /**
diff --git a/specification/ml/_types/inference.ts b/specification/ml/_types/inference.ts
@@ -494,7 +494,7 @@ export class InferenceResponseResult {
    * For regression models, its a numerical value
    * For classification models, it may be an integer, double, boolean or string depending on prediction type
    */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   predicted_value?: PredictedValue | PredictedValue[]
 
   /**
diff --git a/specification/nodes/_types/Stats.ts b/specification/nodes/_types/Stats.ts
@@ -55,7 +55,7 @@ export class Stats {
   /**
    * IP address and port for the node.
    */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   ip?: Ip | Ip[]
   /**
    * JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes.
diff --git a/specification/nodes/info/types.ts b/specification/nodes/info/types.ts
@@ -241,7 +241,6 @@ export class NodeInfoSettingsTransportFeatures {
 }
 
 export class NodeInfoSettingsNetwork {
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
   host?: Host | Host[]
 }
 
diff --git a/specification/query_rules/_types/QueryRuleset.ts b/specification/query_rules/_types/QueryRuleset.ts
@@ -48,7 +48,7 @@ export class QueryRule {
    * The criteria that must be met for the rule to be applied.
    * If multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.
    */
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   criteria: QueryRuleCriteria | QueryRuleCriteria[]
   /**
    * The actions to take when the rule is matched.
diff --git a/specification/query_rules/put_rule/QueryRulePutRequest.ts b/specification/query_rules/put_rule/QueryRulePutRequest.ts
@@ -69,7 +69,7 @@ export interface Request extends RequestBase {
      * The criteria that must be met for the rule to be applied.
      * If multiple criteria are specified for a rule, all criteria must be met for the rule to be applied.
      */
-    // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
     criteria: QueryRuleCriteria | QueryRuleCriteria[]
     /**
      * The actions to take when the rule is matched.
diff --git a/specification/query_rules/put_ruleset/QueryRulesetPutRequest.ts b/specification/query_rules/put_ruleset/QueryRulesetPutRequest.ts
@@ -54,7 +54,6 @@ export interface Request extends RequestBase {
    */
   /** @codegen_name query_ruleset */
   body: {
-    // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
     rules: QueryRule | QueryRule[]
   }
 }
diff --git a/specification/security/get_user/SecurityGetUserRequest.ts b/specification/security/get_user/SecurityGetUserRequest.ts
@@ -42,7 +42,7 @@ export interface Request extends RequestBase {
   ]
   path_parts: {
     /** An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves information about all users. */
-    // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
     username?: Username | Username[]
   }
   query_parameters: {
diff --git a/specification/security/get_user_profile/Request.ts b/specification/security/get_user_profile/Request.ts
@@ -45,7 +45,7 @@ export interface Request extends RequestBase {
     /**
      * A unique identifier for the user profile.
      */
-    // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
     uid: UserProfileId | UserProfileId[]
   }
   query_parameters: {
diff --git a/specification/snapshot/get/SnapshotGetRequest.ts b/specification/snapshot/get/SnapshotGetRequest.ts
@@ -154,7 +154,7 @@ export interface Request extends RequestBase {
      * @availability stack since=9.1.0
      * @availability serverless
      */
-    // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
     state?: SnapshotState | SnapshotState[]
     /**
      * If `true`, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.
diff --git a/specification/synonyms/put_synonym/SynonymsPutRequest.ts b/specification/synonyms/put_synonym/SynonymsPutRequest.ts
@@ -53,7 +53,7 @@ export interface Request extends RequestBase {
     /**
      * The synonym rules definitions for the synonyms set.
      */
-    // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
     synonyms_set: SynonymRule | SynonymRule[]
   }
   query_parameters: {
diff --git a/specification/watcher/_types/Schedule.ts b/specification/watcher/_types/Schedule.ts
@@ -86,11 +86,11 @@ export class ScheduleContainer {
   daily?: DailySchedule
   hourly?: HourlySchedule
   interval?: Duration
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   monthly?: TimeOfMonth | TimeOfMonth[]
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   weekly?: TimeOfWeek | TimeOfWeek[]
-  // eslint-disable-next-line es-spec-validator/prefer-tagged-variants -- TODO: use tagged variant
+
   yearly?: TimeOfYear | TimeOfYear[]
 }
 
diff --git a/specification/watcher/stats/WatcherStatsRequest.ts b/specification/watcher/stats/WatcherStatsRequest.ts
diff --git a/validator/rules/prefer-tagged-variants.js b/validator/rules/prefer-tagged-variants.js
diff --git a/validator/test/prefer-tagged-variants.test.js b/validator/test/prefer-tagged-variants.test.js
