diff --git a/compiler-rs/clients_schema_to_openapi/src/schemas.rs b/compiler-rs/clients_schema_to_openapi/src/schemas.rs index 6add3f76a0..7be715e777 100644 --- a/compiler-rs/clients_schema_to_openapi/src/schemas.rs +++ b/compiler-rs/clients_schema_to_openapi/src/schemas.rs @@ -363,6 +363,10 @@ impl<'a> TypesAndComponents<'a> { _ => bail!("Unknown behavior {}", &bh.typ), } } + + // description + schema.schema_data.description = itf.base.description.clone(); + Ok(schema) } diff --git a/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm b/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm index dc456e4c6a..fef3326899 100644 Binary files a/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm and b/compiler-rs/compiler-wasm-lib/pkg/compiler_wasm_lib_bg.wasm differ diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index c4be817bd5..b88a4ef3c5 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -49962,6 +49962,7 @@ ] }, "_types.aggregations.SumAggregate": { + "description": "Sum aggregation result. `value` is always present and is zero if there were no values to process.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase" @@ -49982,6 +49983,7 @@ ] }, "_types.aggregations.WeightedAvgAggregate": { + "description": "Weighted average aggregation result. `value` is missing if the weight was set to zero.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase" @@ -49992,6 +49994,7 @@ ] }, "_types.aggregations.ValueCountAggregate": { + "description": "Value count aggregation result. `value` is always present.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase" @@ -50051,6 +50054,7 @@ ] }, "_types.aggregations.StatsAggregate": { + "description": "Statistics aggregation result. `min`, `max` and `avg` are missing if there were no values to process\n(`count` is zero).", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.AggregateBase" @@ -50604,6 +50608,7 @@ ] }, "_types.aggregations.MultiBucketBase": { + "description": "Base type for multi-bucket aggregation results that can hold sub-aggregations results.", "type": "object", "properties": { "doc_count": { @@ -50794,6 +50799,7 @@ ] }, "_types.aggregations.StringTermsAggregate": { + "description": "Result of a `terms` aggregation when the field is a string.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseStringTermsBucket" @@ -50911,6 +50917,7 @@ ] }, "_types.aggregations.LongTermsAggregate": { + "description": "Result of a `terms` aggregation when the field is some kind of whole number like a integer, long, or a date.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseLongTermsBucket" @@ -50995,6 +51002,7 @@ ] }, "_types.aggregations.DoubleTermsAggregate": { + "description": "Result of a `terms` aggregation when the field is some kind of decimal number like a float, double, or distance.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseDoubleTermsBucket" @@ -51079,6 +51087,7 @@ ] }, "_types.aggregations.UnmappedTermsAggregate": { + "description": "Result of a `terms` aggregation when the field is unmapped. `buckets` is always empty.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseVoid" @@ -51146,6 +51155,7 @@ "type": "object" }, "_types.aggregations.LongRareTermsAggregate": { + "description": "Result of the `rare_terms` aggregation when the field is some kind of whole number like a integer, long, or a date.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseLongRareTermsBucket" @@ -51212,6 +51222,7 @@ ] }, "_types.aggregations.StringRareTermsAggregate": { + "description": "Result of the `rare_terms` aggregation when the field is a string.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseStringRareTermsBucket" @@ -51275,6 +51286,7 @@ ] }, "_types.aggregations.UnmappedRareTermsAggregate": { + "description": "Result of a `rare_terms` aggregation when the field is unmapped. `buckets` is always empty.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseVoid" @@ -51385,6 +51397,7 @@ ] }, "_types.aggregations.SingleBucketAggregateBase": { + "description": "Base type for single-bucket aggregation results that can hold sub-aggregations results.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.AggregateBase" @@ -51753,6 +51766,7 @@ ] }, "_types.aggregations.DateRangeAggregate": { + "description": "Result of a `date_range` aggregation. Same format as a for a `range` aggregation: `from` and `to`\nin `buckets` are milliseconds since the Epoch, represented as a floating point number.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.RangeAggregate" @@ -51763,6 +51777,7 @@ ] }, "_types.aggregations.GeoDistanceAggregate": { + "description": "Result of a `geo_distance` aggregation. The unit for `from` and `to` is meters by default.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.RangeAggregate" @@ -52218,6 +52233,7 @@ ] }, "_types.aggregations.UnmappedSignificantTermsAggregate": { + "description": "Result of the `significant_terms` aggregation on an unmapped field. `buckets` is always empty.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.SignificantTermsAggregateBaseVoid" @@ -53098,6 +53114,7 @@ ] }, "_types.aggregations.CumulativeCardinalityAggregate": { + "description": "Result of the `cumulative_cardinality` aggregation", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.AggregateBase" @@ -53214,6 +53231,7 @@ ] }, "_types.GeoLine": { + "description": "A GeoJson GeoLine.", "type": "object", "properties": { "type": { @@ -53377,6 +53395,7 @@ ] }, "_types.ErrorCause": { + "description": "Cause and details about a request failure. This class defines the properties common to all error types.\nAdditional details are also provided, that depend on the error type.", "type": "object", "properties": { "type": { @@ -56218,6 +56237,7 @@ "type": "string" }, "_types.query_dsl.FieldAndFormat": { + "description": "A reference to a field with formatting instructions on how to return the value", "type": "object", "properties": { "field": { @@ -59910,6 +59930,7 @@ ] }, "_types.aggregations.BucketAggregationBase": { + "description": "Base type for bucket aggregations. These aggregations also accept sub-aggregations.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.Aggregation" @@ -60178,6 +60199,7 @@ ] }, "_types.aggregations.BucketKsAggregation": { + "description": "A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred\nto as a \"K-S test\" from now on) against a provided distribution, and the distribution implied\nby the documents counts in the configured sibling aggregation. Specifically, for some metric,\nassuming that the percentile intervals of the metric are known beforehand or have been computed\nby an aggregation, then one would use range aggregation for the sibling to compute the p-value\nof the distribution difference between the metric and the restriction of that metric to a subset\nof the documents. A natural use case is if the sibling aggregation range aggregation nested in a\nterms aggregation, in which case one compares the overall distribution of metric to its restriction\nto each term.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.BucketPathAggregation" @@ -60208,6 +60230,7 @@ ] }, "_types.aggregations.BucketCorrelationAggregation": { + "description": "A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.BucketPathAggregation" @@ -60307,6 +60330,7 @@ ] }, "_types.aggregations.CategorizeTextAggregation": { + "description": "A multi-bucket aggregation that groups semi-structured text into buckets. Each text\nfield is re-analyzed using a custom analyzer. The resulting tokens are then categorized\ncreating buckets of similarly formatted text values. This aggregation works best with machine\ngenerated text like system logs. Only the first 100 analyzed tokens are used to categorize the text.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.Aggregation" @@ -61636,6 +61660,7 @@ ] }, "_types.EmptyObject": { + "description": "For empty Class assignments", "type": "object" }, "_types.aggregations.MovingAverageAggregationBase": { @@ -72574,6 +72599,7 @@ ] }, "indices._types.MappingLimitSettings": { + "description": "Mapping Limit Settings", "type": "object", "properties": { "coerce": { @@ -74417,6 +74443,7 @@ ] }, "_types.mapping.MatchOnlyTextProperty": { + "description": "A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field\neffectively stores data the same way as a text field that only indexes documents (index_options: docs) and\ndisables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries\nthat need positions such as the match_phrase query perform slower as they need to look at the _source document\nto verify whether a phrase matches. All queries return constant scores that are equal to 1.0.", "type": "object", "properties": { "type": { @@ -75474,6 +75501,7 @@ ] }, "_types.mapping.GeoShapeProperty": { + "description": "The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles\nand polygons.", "allOf": [ { "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase" @@ -75563,6 +75591,7 @@ ] }, "_types.mapping.ShapeProperty": { + "description": "The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as\nrectangles and polygons.", "allOf": [ { "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase" @@ -76211,6 +76240,7 @@ } }, "indices._types.DataStreamLifecycleWithRollover": { + "description": "Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions,\nif asked.", "allOf": [ { "$ref": "#/components/schemas/indices._types.DataStreamLifecycle" @@ -76261,6 +76291,7 @@ } }, "indices._types.DataStreamLifecycle": { + "description": "Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration.", "type": "object", "properties": { "data_retention": { @@ -76317,6 +76348,7 @@ ] }, "indices._types.DataStreamOptionsTemplate": { + "description": "Data stream options template contains the same information as DataStreamOptions but allows them to be set explicitly to null.", "type": "object", "properties": { "failure_store": { @@ -76333,6 +76365,7 @@ } }, "indices._types.DataStreamFailureStoreTemplate": { + "description": "Template equivalent of DataStreamFailureStore that allows nullable values.", "type": "object", "properties": { "enabled": { @@ -76362,6 +76395,7 @@ } }, "indices._types.FailureStoreLifecycleTemplate": { + "description": "Template equivalent of FailureStoreLifecycle that allows nullable values.", "type": "object", "properties": { "data_retention": { @@ -77861,6 +77895,7 @@ ] }, "cluster.stats.ClusterIndicesShards": { + "description": "Contains statistics about shards assigned to selected nodes.", "type": "object", "properties": { "index": { @@ -78936,6 +78971,7 @@ } }, "_types.NodeStatistics": { + "description": "Contains statistics about the number of nodes selected by the request.", "type": "object", "properties": { "failures": { @@ -80857,6 +80893,7 @@ ] }, "_global.msearch.MultisearchHeader": { + "description": "Contains parameters used to limit or change the subsequent search body request.", "type": "object", "properties": { "allow_no_indices": { @@ -80987,6 +81024,7 @@ ] }, "_types.ErrorResponseBase": { + "description": "The response returned by Elasticsearch when request execution did not succeed.", "type": "object", "properties": { "error": { @@ -81334,6 +81372,7 @@ } }, "_global.health_report.MasterIsStableIndicator": { + "description": "MASTER_IS_STABLE", "allOf": [ { "$ref": "#/components/schemas/_global.health_report.BaseIndicator" @@ -81570,6 +81609,7 @@ } }, "_global.health_report.ShardsAvailabilityIndicator": { + "description": "SHARDS_AVAILABILITY", "allOf": [ { "$ref": "#/components/schemas/_global.health_report.BaseIndicator" @@ -81632,6 +81672,7 @@ ] }, "_global.health_report.DiskIndicator": { + "description": "DISK", "allOf": [ { "$ref": "#/components/schemas/_global.health_report.BaseIndicator" @@ -81674,6 +81715,7 @@ ] }, "_global.health_report.RepositoryIntegrityIndicator": { + "description": "REPOSITORY_INTEGRITY", "allOf": [ { "$ref": "#/components/schemas/_global.health_report.BaseIndicator" @@ -81706,6 +81748,7 @@ } }, "_global.health_report.DataStreamLifecycleIndicator": { + "description": "DATA_STREAM_LIFECYCLE", "allOf": [ { "$ref": "#/components/schemas/_global.health_report.BaseIndicator" @@ -81761,6 +81804,7 @@ ] }, "_global.health_report.IlmIndicator": { + "description": "ILM", "allOf": [ { "$ref": "#/components/schemas/_global.health_report.BaseIndicator" @@ -81803,6 +81847,7 @@ ] }, "_global.health_report.SlmIndicator": { + "description": "SLM", "allOf": [ { "$ref": "#/components/schemas/_global.health_report.BaseIndicator" @@ -81853,6 +81898,7 @@ ] }, "_global.health_report.ShardsCapacityIndicator": { + "description": "SHARDS_CAPACITY", "allOf": [ { "$ref": "#/components/schemas/_global.health_report.BaseIndicator" @@ -81897,6 +81943,7 @@ ] }, "_global.health_report.FileSettingsIndicator": { + "description": "FILE_SETTINGS", "allOf": [ { "$ref": "#/components/schemas/_global.health_report.BaseIndicator" @@ -82979,6 +83026,7 @@ ] }, "indices._types.DataStreamOptions": { + "description": "Data stream options contain the configuration of data stream level features for a given data stream, for example,\nthe failure store configuration.", "type": "object", "properties": { "failure_store": { @@ -82987,6 +83035,7 @@ } }, "indices._types.DataStreamFailureStore": { + "description": "Data stream failure store contains the configuration of the failure store for a given data stream.", "type": "object", "properties": { "enabled": { @@ -82999,6 +83048,7 @@ } }, "indices._types.FailureStoreLifecycle": { + "description": "The failure store lifecycle configures the data stream lifecycle configuration for failure indices.", "type": "object", "properties": { "data_retention": { @@ -83789,6 +83839,7 @@ ] }, "indices.resolve_cluster.ResolveClusterInfo": { + "description": "Provides information about each cluster request relevant to doing a cross-cluster search.", "type": "object", "properties": { "connected": { @@ -83817,6 +83868,7 @@ ] }, "_types.ElasticsearchVersionMinInfo": { + "description": "Reduced (minimal) info ElasticsearchVersion", "type": "object", "properties": { "build_flavor": { @@ -85214,6 +85266,7 @@ ] }, "inference._types.Message": { + "description": "An object representing part of the conversation.", "type": "object", "properties": { "content": { @@ -85252,6 +85305,7 @@ ] }, "inference._types.ContentObject": { + "description": "An object style representation of a single portion of a conversation.", "type": "object", "properties": { "text": { @@ -85269,6 +85323,7 @@ ] }, "inference._types.ToolCall": { + "description": "A tool call generated by the model.", "type": "object", "properties": { "id": { @@ -85289,6 +85344,7 @@ ] }, "inference._types.ToolCallFunction": { + "description": "The function that the model called.", "type": "object", "properties": { "arguments": { @@ -85316,6 +85372,7 @@ ] }, "inference._types.CompletionToolChoice": { + "description": "Controls which tool is called by the model.", "type": "object", "properties": { "type": { @@ -85332,6 +85389,7 @@ ] }, "inference._types.CompletionToolChoiceFunction": { + "description": "The tool choice function.", "type": "object", "properties": { "name": { @@ -85344,6 +85402,7 @@ ] }, "inference._types.CompletionTool": { + "description": "A list of tools that the model can call.", "type": "object", "properties": { "type": { @@ -85360,6 +85419,7 @@ ] }, "inference._types.CompletionToolFunction": { + "description": "The completion tool function definition.", "type": "object", "properties": { "description": { @@ -85390,6 +85450,7 @@ "type": "object" }, "inference._types.CompletionInferenceResult": { + "description": "Defines the completion result.", "type": "object", "properties": { "completion": { @@ -85404,6 +85465,7 @@ ] }, "inference._types.CompletionResult": { + "description": "The completion result object", "type": "object", "properties": { "result": { @@ -85425,6 +85487,7 @@ ] }, "inference._types.DeleteInferenceEndpointResult": { + "description": "Acknowledged response. For dry_run, contains the list of pipelines which reference the inference endpoint", "allOf": [ { "$ref": "#/components/schemas/_types.AcknowledgedResponseBase" @@ -85446,6 +85509,7 @@ ] }, "inference._types.InferenceEndpointInfo": { + "description": "Represents an inference endpoint as returned by the GET API", "allOf": [ { "$ref": "#/components/schemas/inference._types.InferenceEndpoint" @@ -85469,6 +85533,7 @@ ] }, "inference._types.InferenceEndpoint": { + "description": "Configuration options when storing the inference endpoint", "type": "object", "properties": { "chunking_settings": { @@ -85491,6 +85556,7 @@ ] }, "inference._types.InferenceChunkingSettings": { + "description": "Chunking configuration object", "type": "object", "properties": { "max_chunk_size": { @@ -85559,6 +85625,7 @@ "maxProperties": 1 }, "inference._types.TextEmbeddingByteResult": { + "description": "The text embedding result object for byte representation", "type": "object", "properties": { "embedding": { @@ -85577,6 +85644,7 @@ } }, "inference._types.TextEmbeddingResult": { + "description": "The text embedding result object", "type": "object", "properties": { "embedding": { @@ -85613,6 +85681,7 @@ } }, "inference._types.RankedDocument": { + "description": "The rerank result object representing a single ranked document\nid: the original index of the document in the request\nrelevance_score: the relevance_score of the document relative to the query\ntext: Optional, the text of the document, if requested", "type": "object", "properties": { "index": { @@ -85679,6 +85748,7 @@ ] }, "inference._types.RateLimitSetting": { + "description": "This setting helps to minimize the number of rate limit errors returned from the service.", "type": "object", "properties": { "requests_per_minute": { @@ -87103,6 +87173,7 @@ ] }, "inference._types.RerankedInferenceResult": { + "description": "Defines the response for a rerank request.", "type": "object", "properties": { "rerank": { @@ -87117,6 +87188,7 @@ ] }, "inference._types.SparseEmbeddingInferenceResult": { + "description": "The response format for the sparse embedding request.", "type": "object", "properties": { "sparse_embedding": { @@ -87241,6 +87313,7 @@ ] }, "ingest.geo_ip_stats.GeoIpNodeDatabases": { + "description": "Downloaded databases for the node. The field key is the node ID.", "type": "object", "properties": { "databases": { @@ -89294,6 +89367,7 @@ } }, "ingest._types.DocumentSimulation": { + "description": "The simulated document, with optional metadata.", "type": "object", "properties": { "_id": { @@ -91655,6 +91729,7 @@ ] }, "ml._types.DiscoveryNodeCompact": { + "description": "Alternative representation of DiscoveryNode used in ml.get_job_stats and ml.get_datafeed_stats", "type": "object", "properties": { "name": { @@ -91917,6 +91992,7 @@ ] }, "_types.IndicesOptions": { + "description": "Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded\nto actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices.", "type": "object", "properties": { "allow_no_indices": { @@ -93232,6 +93308,7 @@ "maxProperties": 1 }, "ml._types.TextClassificationInferenceOptions": { + "description": "Text classification configuration options", "type": "object", "properties": { "num_top_classes": { @@ -93281,6 +93358,7 @@ "maxProperties": 1 }, "ml._types.NlpBertTokenizationConfig": { + "description": "BERT and MPNet tokenization configuration options", "allOf": [ { "$ref": "#/components/schemas/ml._types.CommonTokenizationConfig" @@ -93323,6 +93401,7 @@ ] }, "ml._types.NlpRobertaTokenizationConfig": { + "description": "RoBERTa tokenization configuration options", "allOf": [ { "$ref": "#/components/schemas/ml._types.CommonTokenizationConfig" @@ -93360,6 +93439,7 @@ ] }, "ml._types.ZeroShotClassificationInferenceOptions": { + "description": "Zero shot classification configuration options", "type": "object", "properties": { "tokenization": { @@ -93397,6 +93477,7 @@ ] }, "ml._types.FillMaskInferenceOptions": { + "description": "Fill mask inference options", "type": "object", "properties": { "mask_token": { @@ -93474,6 +93555,7 @@ ] }, "ml._types.NerInferenceOptions": { + "description": "Named entity recognition options", "type": "object", "properties": { "tokenization": { @@ -93496,6 +93578,7 @@ } }, "ml._types.PassThroughInferenceOptions": { + "description": "Pass through configuration options", "type": "object", "properties": { "tokenization": { @@ -93511,6 +93594,7 @@ } }, "ml._types.TextEmbeddingInferenceOptions": { + "description": "Text embedding inference options", "type": "object", "properties": { "embedding_size": { @@ -93533,6 +93617,7 @@ ] }, "ml._types.TextExpansionInferenceOptions": { + "description": "Text expansion inference options", "type": "object", "properties": { "tokenization": { @@ -93551,6 +93636,7 @@ ] }, "ml._types.QuestionAnsweringInferenceOptions": { + "description": "Question answering inference options", "type": "object", "properties": { "num_top_classes": { @@ -98250,6 +98336,7 @@ } }, "_global.rank_eval.RankEvalMetricPrecision": { + "description": "Precision at K (P@k)", "allOf": [ { "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRatingTreshold" @@ -98291,6 +98378,7 @@ } }, "_global.rank_eval.RankEvalMetricRecall": { + "description": "Recall at K (R@k)", "allOf": [ { "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRatingTreshold" @@ -98301,6 +98389,7 @@ ] }, "_global.rank_eval.RankEvalMetricMeanReciprocalRank": { + "description": "Mean Reciprocal Rank", "allOf": [ { "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRatingTreshold" @@ -98311,6 +98400,7 @@ ] }, "_global.rank_eval.RankEvalMetricDiscountedCumulativeGain": { + "description": "Discounted cumulative gain (DCG)", "allOf": [ { "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricBase" @@ -98327,6 +98417,7 @@ ] }, "_global.rank_eval.RankEvalMetricExpectedReciprocalRank": { + "description": "Expected Reciprocal Rank (ERR)", "allOf": [ { "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricBase" @@ -99920,6 +100011,7 @@ ] }, "security._types.RemoteIndicesPrivileges": { + "description": "The subset of index level privileges that can be defined for remote clusters.", "type": "object", "properties": { "clusters": { @@ -99965,6 +100057,7 @@ ] }, "security._types.RemoteClusterPrivileges": { + "description": "The subset of cluster level privileges that can be defined for remote clusters.", "type": "object", "properties": { "clusters": { @@ -101687,6 +101780,7 @@ } }, "simulate.ingest.IngestDocumentSimulation": { + "description": "The results of ingest simulation on a single document. The _source of the document contains\nthe results after running all pipelines listed in executed_pipelines on the document. The\nlist of executed pipelines is derived from the pipelines that would be executed if this\ndocument had been ingested into _index.", "type": "object", "properties": { "_id": { @@ -103559,6 +103653,7 @@ ] }, "transform._types.Settings": { + "description": "The source of the data for the transform.", "type": "object", "properties": { "align_checkpoints": { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index d5e06b0b57..0e9e7ca06a 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -26959,6 +26959,7 @@ ] }, "_types.aggregations.SumAggregate": { + "description": "Sum aggregation result. `value` is always present and is zero if there were no values to process.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase" @@ -26979,6 +26980,7 @@ ] }, "_types.aggregations.WeightedAvgAggregate": { + "description": "Weighted average aggregation result. `value` is missing if the weight was set to zero.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase" @@ -26989,6 +26991,7 @@ ] }, "_types.aggregations.ValueCountAggregate": { + "description": "Value count aggregation result. `value` is always present.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.SingleMetricAggregateBase" @@ -27048,6 +27051,7 @@ ] }, "_types.aggregations.StatsAggregate": { + "description": "Statistics aggregation result. `min`, `max` and `avg` are missing if there were no values to process\n(`count` is zero).", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.AggregateBase" @@ -27601,6 +27605,7 @@ ] }, "_types.aggregations.MultiBucketBase": { + "description": "Base type for multi-bucket aggregation results that can hold sub-aggregations results.", "type": "object", "properties": { "doc_count": { @@ -27791,6 +27796,7 @@ ] }, "_types.aggregations.StringTermsAggregate": { + "description": "Result of a `terms` aggregation when the field is a string.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseStringTermsBucket" @@ -27908,6 +27914,7 @@ ] }, "_types.aggregations.LongTermsAggregate": { + "description": "Result of a `terms` aggregation when the field is some kind of whole number like a integer, long, or a date.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseLongTermsBucket" @@ -27992,6 +27999,7 @@ ] }, "_types.aggregations.DoubleTermsAggregate": { + "description": "Result of a `terms` aggregation when the field is some kind of decimal number like a float, double, or distance.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseDoubleTermsBucket" @@ -28076,6 +28084,7 @@ ] }, "_types.aggregations.UnmappedTermsAggregate": { + "description": "Result of a `terms` aggregation when the field is unmapped. `buckets` is always empty.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.TermsAggregateBaseVoid" @@ -28143,6 +28152,7 @@ "type": "object" }, "_types.aggregations.LongRareTermsAggregate": { + "description": "Result of the `rare_terms` aggregation when the field is some kind of whole number like a integer, long, or a date.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseLongRareTermsBucket" @@ -28209,6 +28219,7 @@ ] }, "_types.aggregations.StringRareTermsAggregate": { + "description": "Result of the `rare_terms` aggregation when the field is a string.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseStringRareTermsBucket" @@ -28272,6 +28283,7 @@ ] }, "_types.aggregations.UnmappedRareTermsAggregate": { + "description": "Result of a `rare_terms` aggregation when the field is unmapped. `buckets` is always empty.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.MultiBucketAggregateBaseVoid" @@ -28382,6 +28394,7 @@ ] }, "_types.aggregations.SingleBucketAggregateBase": { + "description": "Base type for single-bucket aggregation results that can hold sub-aggregations results.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.AggregateBase" @@ -28750,6 +28763,7 @@ ] }, "_types.aggregations.DateRangeAggregate": { + "description": "Result of a `date_range` aggregation. Same format as a for a `range` aggregation: `from` and `to`\nin `buckets` are milliseconds since the Epoch, represented as a floating point number.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.RangeAggregate" @@ -28760,6 +28774,7 @@ ] }, "_types.aggregations.GeoDistanceAggregate": { + "description": "Result of a `geo_distance` aggregation. The unit for `from` and `to` is meters by default.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.RangeAggregate" @@ -29215,6 +29230,7 @@ ] }, "_types.aggregations.UnmappedSignificantTermsAggregate": { + "description": "Result of the `significant_terms` aggregation on an unmapped field. `buckets` is always empty.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.SignificantTermsAggregateBaseVoid" @@ -30095,6 +30111,7 @@ ] }, "_types.aggregations.CumulativeCardinalityAggregate": { + "description": "Result of the `cumulative_cardinality` aggregation", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.AggregateBase" @@ -30211,6 +30228,7 @@ ] }, "_types.GeoLine": { + "description": "A GeoJson GeoLine.", "type": "object", "properties": { "type": { @@ -30374,6 +30392,7 @@ ] }, "_types.ErrorCause": { + "description": "Cause and details about a request failure. This class defines the properties common to all error types.\nAdditional details are also provided, that depend on the error type.", "type": "object", "properties": { "type": { @@ -33209,6 +33228,7 @@ "type": "string" }, "_types.query_dsl.FieldAndFormat": { + "description": "A reference to a field with formatting instructions on how to return the value", "type": "object", "properties": { "field": { @@ -36868,6 +36888,7 @@ ] }, "_types.aggregations.BucketAggregationBase": { + "description": "Base type for bucket aggregations. These aggregations also accept sub-aggregations.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.Aggregation" @@ -37136,6 +37157,7 @@ ] }, "_types.aggregations.BucketKsAggregation": { + "description": "A sibling pipeline aggregation which executes a two sample Kolmogorov–Smirnov test (referred\nto as a \"K-S test\" from now on) against a provided distribution, and the distribution implied\nby the documents counts in the configured sibling aggregation. Specifically, for some metric,\nassuming that the percentile intervals of the metric are known beforehand or have been computed\nby an aggregation, then one would use range aggregation for the sibling to compute the p-value\nof the distribution difference between the metric and the restriction of that metric to a subset\nof the documents. A natural use case is if the sibling aggregation range aggregation nested in a\nterms aggregation, in which case one compares the overall distribution of metric to its restriction\nto each term.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.BucketPathAggregation" @@ -37166,6 +37188,7 @@ ] }, "_types.aggregations.BucketCorrelationAggregation": { + "description": "A sibling pipeline aggregation which executes a correlation function on the configured sibling multi-bucket aggregation.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.BucketPathAggregation" @@ -37265,6 +37288,7 @@ ] }, "_types.aggregations.CategorizeTextAggregation": { + "description": "A multi-bucket aggregation that groups semi-structured text into buckets. Each text\nfield is re-analyzed using a custom analyzer. The resulting tokens are then categorized\ncreating buckets of similarly formatted text values. This aggregation works best with machine\ngenerated text like system logs. Only the first 100 analyzed tokens are used to categorize the text.", "allOf": [ { "$ref": "#/components/schemas/_types.aggregations.Aggregation" @@ -38594,6 +38618,7 @@ ] }, "_types.EmptyObject": { + "description": "For empty Class assignments", "type": "object" }, "_types.aggregations.MovingAverageAggregationBase": { @@ -47592,6 +47617,7 @@ ] }, "indices._types.MappingLimitSettings": { + "description": "Mapping Limit Settings", "type": "object", "properties": { "coerce": { @@ -48605,6 +48631,7 @@ ] }, "_types.mapping.MatchOnlyTextProperty": { + "description": "A variant of text that trades scoring and efficiency of positional queries for space efficiency. This field\neffectively stores data the same way as a text field that only indexes documents (index_options: docs) and\ndisables norms (norms: false). Term queries perform as fast if not faster as on text fields, however queries\nthat need positions such as the match_phrase query perform slower as they need to look at the _source document\nto verify whether a phrase matches. All queries return constant scores that are equal to 1.0.", "type": "object", "properties": { "type": { @@ -49662,6 +49689,7 @@ ] }, "_types.mapping.GeoShapeProperty": { + "description": "The `geo_shape` data type facilitates the indexing of and searching with arbitrary geo shapes such as rectangles\nand polygons.", "allOf": [ { "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase" @@ -49751,6 +49779,7 @@ ] }, "_types.mapping.ShapeProperty": { + "description": "The `shape` data type facilitates the indexing of and searching with arbitrary `x, y` cartesian shapes such as\nrectangles and polygons.", "allOf": [ { "$ref": "#/components/schemas/_types.mapping.DocValuesPropertyBase" @@ -50399,6 +50428,7 @@ } }, "indices._types.DataStreamLifecycleWithRollover": { + "description": "Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions,\nif asked.", "allOf": [ { "$ref": "#/components/schemas/indices._types.DataStreamLifecycle" @@ -50449,6 +50479,7 @@ } }, "indices._types.DataStreamLifecycle": { + "description": "Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration.", "type": "object", "properties": { "data_retention": { @@ -50505,6 +50536,7 @@ ] }, "indices._types.DataStreamOptionsTemplate": { + "description": "Data stream options template contains the same information as DataStreamOptions but allows them to be set explicitly to null.", "type": "object", "properties": { "failure_store": { @@ -50521,6 +50553,7 @@ } }, "indices._types.DataStreamFailureStoreTemplate": { + "description": "Template equivalent of DataStreamFailureStore that allows nullable values.", "type": "object", "properties": { "enabled": { @@ -50550,6 +50583,7 @@ } }, "indices._types.FailureStoreLifecycleTemplate": { + "description": "Template equivalent of FailureStoreLifecycle that allows nullable values.", "type": "object", "properties": { "data_retention": { @@ -53181,6 +53215,7 @@ ] }, "indices._types.DataStreamOptions": { + "description": "Data stream options contain the configuration of data stream level features for a given data stream, for example,\nthe failure store configuration.", "type": "object", "properties": { "failure_store": { @@ -53189,6 +53224,7 @@ } }, "indices._types.DataStreamFailureStore": { + "description": "Data stream failure store contains the configuration of the failure store for a given data stream.", "type": "object", "properties": { "enabled": { @@ -53201,6 +53237,7 @@ } }, "indices._types.FailureStoreLifecycle": { + "description": "The failure store lifecycle configures the data stream lifecycle configuration for failure indices.", "type": "object", "properties": { "data_retention": { @@ -53837,6 +53874,7 @@ ] }, "inference._types.Message": { + "description": "An object representing part of the conversation.", "type": "object", "properties": { "content": { @@ -53875,6 +53913,7 @@ ] }, "inference._types.ContentObject": { + "description": "An object style representation of a single portion of a conversation.", "type": "object", "properties": { "text": { @@ -53892,6 +53931,7 @@ ] }, "inference._types.ToolCall": { + "description": "A tool call generated by the model.", "type": "object", "properties": { "id": { @@ -53912,6 +53952,7 @@ ] }, "inference._types.ToolCallFunction": { + "description": "The function that the model called.", "type": "object", "properties": { "arguments": { @@ -53939,6 +53980,7 @@ ] }, "inference._types.CompletionToolChoice": { + "description": "Controls which tool is called by the model.", "type": "object", "properties": { "type": { @@ -53955,6 +53997,7 @@ ] }, "inference._types.CompletionToolChoiceFunction": { + "description": "The tool choice function.", "type": "object", "properties": { "name": { @@ -53967,6 +54010,7 @@ ] }, "inference._types.CompletionTool": { + "description": "A list of tools that the model can call.", "type": "object", "properties": { "type": { @@ -53983,6 +54027,7 @@ ] }, "inference._types.CompletionToolFunction": { + "description": "The completion tool function definition.", "type": "object", "properties": { "description": { @@ -54013,6 +54058,7 @@ "type": "object" }, "inference._types.CompletionInferenceResult": { + "description": "Defines the completion result.", "type": "object", "properties": { "completion": { @@ -54027,6 +54073,7 @@ ] }, "inference._types.CompletionResult": { + "description": "The completion result object", "type": "object", "properties": { "result": { @@ -54048,6 +54095,7 @@ ] }, "inference._types.DeleteInferenceEndpointResult": { + "description": "Acknowledged response. For dry_run, contains the list of pipelines which reference the inference endpoint", "allOf": [ { "$ref": "#/components/schemas/_types.AcknowledgedResponseBase" @@ -54069,6 +54117,7 @@ ] }, "inference._types.InferenceEndpointInfo": { + "description": "Represents an inference endpoint as returned by the GET API", "allOf": [ { "$ref": "#/components/schemas/inference._types.InferenceEndpoint" @@ -54092,6 +54141,7 @@ ] }, "inference._types.InferenceEndpoint": { + "description": "Configuration options when storing the inference endpoint", "type": "object", "properties": { "chunking_settings": { @@ -54114,6 +54164,7 @@ ] }, "inference._types.InferenceChunkingSettings": { + "description": "Chunking configuration object", "type": "object", "properties": { "max_chunk_size": { @@ -54182,6 +54233,7 @@ "maxProperties": 1 }, "inference._types.TextEmbeddingByteResult": { + "description": "The text embedding result object for byte representation", "type": "object", "properties": { "embedding": { @@ -54200,6 +54252,7 @@ } }, "inference._types.TextEmbeddingResult": { + "description": "The text embedding result object", "type": "object", "properties": { "embedding": { @@ -54236,6 +54289,7 @@ } }, "inference._types.RankedDocument": { + "description": "The rerank result object representing a single ranked document\nid: the original index of the document in the request\nrelevance_score: the relevance_score of the document relative to the query\ntext: Optional, the text of the document, if requested", "type": "object", "properties": { "index": { @@ -54302,6 +54356,7 @@ ] }, "inference._types.RateLimitSetting": { + "description": "This setting helps to minimize the number of rate limit errors returned from the service.", "type": "object", "properties": { "requests_per_minute": { @@ -55726,6 +55781,7 @@ ] }, "inference._types.RerankedInferenceResult": { + "description": "Defines the response for a rerank request.", "type": "object", "properties": { "rerank": { @@ -55740,6 +55796,7 @@ ] }, "inference._types.SparseEmbeddingInferenceResult": { + "description": "The response format for the sparse embedding request.", "type": "object", "properties": { "sparse_embedding": { @@ -57708,6 +57765,7 @@ } }, "ingest._types.DocumentSimulation": { + "description": "The simulated document, with optional metadata.", "type": "object", "properties": { "_id": { @@ -59849,6 +59907,7 @@ ] }, "_types.IndicesOptions": { + "description": "Controls how to deal with unavailable concrete indices (closed or missing), how wildcard expressions are expanded\nto actual indices (all, closed or open indices) and how to deal with wildcard expressions that resolve to no indices.", "type": "object", "properties": { "allow_no_indices": { @@ -60565,6 +60624,7 @@ "maxProperties": 1 }, "ml._types.TextClassificationInferenceOptions": { + "description": "Text classification configuration options", "type": "object", "properties": { "num_top_classes": { @@ -60614,6 +60674,7 @@ "maxProperties": 1 }, "ml._types.NlpBertTokenizationConfig": { + "description": "BERT and MPNet tokenization configuration options", "allOf": [ { "$ref": "#/components/schemas/ml._types.CommonTokenizationConfig" @@ -60656,6 +60717,7 @@ ] }, "ml._types.NlpRobertaTokenizationConfig": { + "description": "RoBERTa tokenization configuration options", "allOf": [ { "$ref": "#/components/schemas/ml._types.CommonTokenizationConfig" @@ -60693,6 +60755,7 @@ ] }, "ml._types.ZeroShotClassificationInferenceOptions": { + "description": "Zero shot classification configuration options", "type": "object", "properties": { "tokenization": { @@ -60730,6 +60793,7 @@ ] }, "ml._types.FillMaskInferenceOptions": { + "description": "Fill mask inference options", "type": "object", "properties": { "mask_token": { @@ -60807,6 +60871,7 @@ ] }, "ml._types.NerInferenceOptions": { + "description": "Named entity recognition options", "type": "object", "properties": { "tokenization": { @@ -60829,6 +60894,7 @@ } }, "ml._types.PassThroughInferenceOptions": { + "description": "Pass through configuration options", "type": "object", "properties": { "tokenization": { @@ -60844,6 +60910,7 @@ } }, "ml._types.TextEmbeddingInferenceOptions": { + "description": "Text embedding inference options", "type": "object", "properties": { "embedding_size": { @@ -60866,6 +60933,7 @@ ] }, "ml._types.TextExpansionInferenceOptions": { + "description": "Text expansion inference options", "type": "object", "properties": { "tokenization": { @@ -60884,6 +60952,7 @@ ] }, "ml._types.QuestionAnsweringInferenceOptions": { + "description": "Question answering inference options", "type": "object", "properties": { "num_top_classes": { @@ -62494,6 +62563,7 @@ ] }, "_global.msearch.MultisearchHeader": { + "description": "Contains parameters used to limit or change the subsequent search body request.", "type": "object", "properties": { "allow_no_indices": { @@ -62642,6 +62712,7 @@ ] }, "_types.ErrorResponseBase": { + "description": "The response returned by Elasticsearch when request execution did not succeed.", "type": "object", "properties": { "error": { @@ -63144,6 +63215,7 @@ } }, "_global.rank_eval.RankEvalMetricPrecision": { + "description": "Precision at K (P@k)", "allOf": [ { "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRatingTreshold" @@ -63185,6 +63257,7 @@ } }, "_global.rank_eval.RankEvalMetricRecall": { + "description": "Recall at K (R@k)", "allOf": [ { "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRatingTreshold" @@ -63195,6 +63268,7 @@ ] }, "_global.rank_eval.RankEvalMetricMeanReciprocalRank": { + "description": "Mean Reciprocal Rank", "allOf": [ { "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricRatingTreshold" @@ -63205,6 +63279,7 @@ ] }, "_global.rank_eval.RankEvalMetricDiscountedCumulativeGain": { + "description": "Discounted cumulative gain (DCG)", "allOf": [ { "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricBase" @@ -63221,6 +63296,7 @@ ] }, "_global.rank_eval.RankEvalMetricExpectedReciprocalRank": { + "description": "Expected Reciprocal Rank (ERR)", "allOf": [ { "$ref": "#/components/schemas/_global.rank_eval.RankEvalMetricBase" @@ -64898,6 +64974,7 @@ ] }, "transform._types.Settings": { + "description": "The source of the data for the transform.", "type": "object", "properties": { "align_checkpoints": {