diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index 5a1b0c6d36..5cfb93f7c9 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -286,29 +286,24 @@ actions: externalDocs: description: Templating a role query url: https://www.elastic.co/guide/en/elasticsearch/reference/master/field-and-document-access-control.html#templating-role-query -# Annotate items that are not shown in Bump.sh due to depth limits - # These hopefully can be fixed by adding branch levels in Bump.sh since the info doesn't exist elsewhere - - target: "$.components['schemas']['ml._types:TrainedModelConfigMetadata'].properties" - description: Add x-model to trained_model_configs > metadata > total_feature_importance - update: - total_feature_importance: - x-model: true - - target: "$.components['schemas']['ml._types:Detector'].properties" - description: Add x-model to anomaly detection job > analysis_config > detectors > custom_rules - update: - custom_rules: - x-model: true - - target: "$.components['schemas']['ml._types:DetectorRead'].properties" - description: Add x-model to anomaly detection jobs > analysis_config > detectors > custom_rules - update: - custom_rules: - x-model: true - - target: "$.components['schemas']['ml.put_trained_model:TargetMeanEncodingPreprocessor'].properties" - description: Add x-model to data frame analytics job > analysis> classification > feature_processors > target_mean_encoding > target_map +# Abbreviate and annotate items that are not shown in Bump.sh due to depth limits + - target: "$.components['schemas']['ml._types:Datafeed'].properties.query" + description: Remove query object from anomaly detection datafeed + remove: true + - target: "$.components['schemas']['ml._types:Datafeed'].properties" + description: Re-add a simplified query object in anomaly detection datafeed update: - target_map: + query: x-model: true -# Override definitions for common schema objects that should have context-specific details + type: object + description: > + The Elasticsearch query domain-specific language (DSL). + This value corresponds to the query object in an Elasticsearch search POST body. + All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. + By default, this property has the following value: `{"match_all": {"boost": 1}}`. + externalDocs: + url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html + description: Query DSL - target: "$.components['schemas']['ml._types:CategorizationAnalyzerDefinition'].properties.tokenizer" description: Remove tokenizer object from ML anomaly detection analysis config remove: true @@ -328,38 +323,38 @@ actions: Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2). `ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify `"tokenizer": "ml_classic"` in your `categorization_analyzer`. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/master/analysis-tokenizers.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html description: Tokenizer reference - - target: "$.components['schemas']['graph._types:Hop'].properties.query" - description: Remove query object from graph explore connections schema + - target: "$.components['schemas']['ml._types:DataframeAnalyticsSource'].properties.query" + description: Remove query object from data frame analytics source remove: true - - target: "$.components['schemas']['graph._types:Hop'].properties" - description: "Re-add simplified query object in graph explore connections schema" - update: + - target: "$.components['schemas']['ml._types:DataframeAnalyticsSource'].properties" + description: Re-add a simplified query object in data frame analytics source + update: query: x-model: true type: object description: > - An optional guiding query that constrains the Graph API as it explores connected terms. - For example, you might want to direct the Graph API to ignore older data by specifying a query that identifies recent documents. + The Elasticsearch query domain-specific language (DSL). + This value corresponds to the query object in an Elasticsearch search POST body. + All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch. + By default, this property has the following value: `{"match_all": {}}`. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/master/query-dsl.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html description: Query DSL - - target: "$.components['schemas']['_global.scripts_painless_execute:PainlessContextSetup'].properties.query" - description: Remove query object from painless script context setup schema + - target: "$.components['schemas']['transform._types:Source'].properties.query" + description: Remove query object from transform source remove: true - - target: "$.components['schemas']['_global.scripts_painless_execute:PainlessContextSetup'].properties" - description: "Re-add simplified query object in painless script context setup schema" - update: + - target: "$.components['schemas']['transform._types:Source'].properties" + description: Re-add a simplified query object in transform source + update: query: x-model: true type: object description: > - This property applies only when `score` is specified as the script `context`. - Use this property to specify a query for computing a score. - Besides deciding whether or not the document matches, the query clause also calculates a relevance score in the `_score` metadata field. + A query clause that retrieves a subset of data from the source index. externalDocs: - url: https://www.elastic.co/guide/en/elasticsearch/reference/master/query-dsl.html + url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html description: Query DSL # Examples - target: "$.components['requestBodies']['async_search.submit']"