OpenSearch OpenAPI Spec (main)

[Unreleased]

Added

• Added API specs for query groups lifecycle APIs (#649)
• Added Python and Ruby spec validators (#646)
• Added verbose output of the story being evaluated (#646)
• Added _search with sort: direction (#658)
• Added _common.mapping:FlatObjectProperty (#661)
• Added HEAD /{index}/_doc/{id} returning 404 (#670)
• Added _common.mapping:IcuCollationKeywordProperty (#666)
• Added /_cluster/stats/{metric}/nodes/{node_id} and /_cluster/stats/{metric}/{index_metric}/nodes/{node_id} (#639)
• Added PhoneAnalyzer from analysis-phonenumber plugin (#609)
• Added /_list/indices & /_list/shards api specs (#613)
• Added GET and HEAD /{index}/_source/{id} returning 404 (#673)
• Added rename_alias_pattern and rename_alias_replacement to /_snapshot/{repository}/{snapshot}/_restore body parameters (#615)
• Added resource_stats to TaskInfoBase (#692)
• Added s to /_ingest/processor/grok (#689)
• Added schema for security API error responses (#646)
• Added aggregations to /nodes/_usage/{metric} requests and responses (#615)
• Added missing status to /_search/template response (#702)
• Added _type to rank_eval API specs (#704)
• Added request body to _search_shards API specs (#709)
• Added NodeAttributes as additional property in shard_stores API specs (#715)
• Added missing repository query parameter to /_cat/snapshots (#700)
• Added sm namespace API specifications (#701)
• Added schema for /_plugins/_knn/stats, /_plugins/_knn/models/{model_id}, _train and _search (#704)
• Added retry support in prologues and epilogues (#713)
• Added response schema for DELETE /_plugins/_rollup/jobs/{id}, POST /_plugins/_rollup/jobs/{id}/_start and _stop (#716)
• Added response schema for PUT and DELETE /_plugins/_transform/{id} (#722)
• Added response schema for GET /_plugins/_knn/warmup/{index} (#717)
• Added support for multiple test verbs (#724)
• Added support for using a certificate and key in tests (#731)
• Added _type to termvector and mtermvector (#734)
• Added missing cancelled and resource_stats to /_reindex/{task_id}/_rethrottle (#740)
• Added missing cancellation_time_millis to POST /_tasks/_cancel (#747)
• Added support for combining output variables (#737)
• Added 404 response to /_search/scroll (#749)
• Added node_failures to DELETE /_search/scroll and DELETE /_search/scroll/{scroll_id} (#749)

Removed

• Removed unsupported _common.mapping:SourceField's mode field and associated _common.mapping:SourceFieldMode enum (#652)
• Removed unsupported _common.mapping:DenseVectorProperty, _common.mapping:SparseVectorProperty, and _common.mapping:FlattenedProperty (#666)
• Removed unsupported time series dimension properties and types (#666)
• Removed unsupported script and on_script_error from NumberPropertyBase (#666)
• Removed unsupported required from ppl responses (#646)
• Removed invalid externalDocs from flow_framework.create/update::query.use_case (#646)
• Removed unsupported cause and create from /_index_template/_simulate_index/{name} (#691)
• Removed mappings from required in indices.simulate_template#Template (#691)
• Removed HealthStatusCapatilized and merged it with HealthStatus (#725)
• Removed id from required in indices.termvectors@200 (#734)

Fixed

• Spec passes OpenAPI 3.1.0 validations (#646)
• Disallowed characters (::, @, and :) in key names are replaced with ___ on merge (#646)
• Added missing required to path parameters (#646)
• Added missing schema parent to response types (#646)
• Fixed incorrect style in indices.get_mapping::query.index (#646)
• Fixed /{index}/_create/{id} returning 201 (#669)
• Fixed ml._common.yaml#SearchModelsResponse and SearchModelsHitsHit (#672)
• Fixed refresh options to allow boolean and string (#673)
• Fixed value type in ExplanationDetail and added _type to explain@200 (#685)
• Fixed index settings types (#684)
• Fixed POST and DELETE /_dangling/{index_uuid} returning 202 (#686)
• Fixed response schema for /_nodes/reload_secure_settings and /_nodes/{node_id}/reload_secure_settings (#694)
• Fixed /_ingest/pipeline/{id}/_simulate response docs/_source field schema (#689)
• Fixed /_scripts/painless/_execute request and response schema (#699)
• Fixed fields in Hit allowing primitive arrays (#699)
• Fixed hits in rank_eval allowing numbers (#704)
• Fixed query DSL schemas (#706)
• Fixed content-type of GET /_plugins/_observability/_local/stats (#711)
• Fixed tenant in ObservabilityObject request body to not be required (#711)
• Fixed response code in PUT /_plugins/_rollup/jobs/{id} (#716)
• Fixed response schema for /_render/template and /_render/template/{id} (#724)
• Fixed data stream schema numeric property types (#725)
• Fixed snapshot status numeric property types (#729)
• Fixed request schema for PATCH /_plugins/_security/api/nodesdn (#731)
• Fixed response schema for GET /_plugins/_security/api/nodesdn/{cluster_name} (#731)
• Fixed request body for /_search/scroll/{scroll_id} (#732)
• Fixed type in _msearch/template (#735)
• Fixed indices API schemas (#750)

Changed

• Changed tasks._common:TaskInfo and tasks._common:TaskGroup to be composed of a tasks._common:TaskInfoBase (#683)
• Changed SearchModelsQuery, CreateConnectorRequest & RegisterAgentsRequest to be defined inline of request bodies (#725)
• Changed indices.data_streams_stats:DataStreamsStatsItem to instead be indices._common:DataStreamStats (#725)
• Changed naming of snapshot._common's Status, ShardsStats, ShardsStatsStage, ShardsStatsSummary and ShardsStatsSummaryItem schemas to be prefixed with Snapshot (#730)

Links

• Build Artifact