Skip to content

Releases

OpenSearch OpenAPI Spec (main)

Pre-release

Choose a tag to compare

@github-actions github-actions released this 22 May 15:03
944944b

[Unreleased]

  • Added specs for Search Relevance Workbench plugin for scheduling endpoints (#967)
  • Added specs for UBI plugin endpoints (#845)

Added

  • Added apis for searching within search relevance objects such as search configurations, judgments, query sets, and experiments (#1064)
  • Added remaining APIs for LTR including store element operations, model management, feature set operations, routing support, and POST support for update operations (#935)
  • Added specs for alert and finding endpoints of security_analytics plugin (#907)
  • Added template to QueryContainer (#904)
  • Added specs for Search Relevance Workbench plugin for stats endpoints (#920)
  • Added time_in_execution and time_in_execution_millis to PendingTask (#922)
  • Added phase_results_processor to NodeInfoSearchPipelines (#922)
  • Added new neural search stats and response filtering parameters (include_individual_nodes, include_all_nodes, include_info) to neural stats API (#921)
  • Added target_index_settings to Index Rollups API from index-management plugin (#822)
  • Changed the type of the DocStatus properties from int32 to int64 (#933)
  • Add pull-based ingestion APIs and properties. Also add replication type in index settings (#926)
  • Added additional_config to ModelConfig (#936)
  • Added all_active config to the IngestionSource under index settings (#965)
  • Added x-protobuf-excluded vendor extension (#980)
  • Added search_pipeline, verbose_pipeline, include_named_queries_score and derived to search_request_body. primary to ShardFailure, header to ErrorCause and Replace InnerHits fields from type Fields to FieldAndFormat(#981)
  • Add if_seq_no and if_primary_term to UpdateAction (#986)
  • Add title to search and bulk requestBody and replace bulk response path from BulkResponseBase to BulkResponse (#987)
  • Add filter to HybridQuery (#988)
  • Add x-protobuf-type vendor extension to override type for protobuf and apply x-protobuf-excluded to global parameters (#989)
  • Add x-protobuf-name vendor extension and add index parameters to search and bulk API (#993)
  • Added semantic field type (#995)
  • Add x-protobuf-required vendor extension for enforcing required Protobuf fields (#1002)
  • Add RepositoryStatsSnapshot schema to ShardRepositoriesStats in nodes.stats API (#997)
  • Add x-protobuf-excluded to SearchResult::hits (#1012)
  • Add x-protobuf-excluded to QueryContainer::template (#1013)
  • Add proto compatibility check workflow for PRs and post-deployment (#1020)
  • Split proto check and comment into separate workflows and addressing "Not Found" errors for posting proto compatibility reports.(#1023),(#1026),(#1028)
  • Add new 3.3 ML APIs (#1010)
  • Add new ML stream APIs (#1031)
  • Add msearch allow_partial_results flag (#1061)
  • Add title to ml.predict_model_stream and ml.execute_agent_stream requestBody (#1072)
  • Added agentic query type, agentic_query_translator request processor, and agentic_context response processor (#1073)

Removed

  • Remove unused cardinality aggregation execution hints - save_memory_heuristic/save_time_heuristic/segment_ordinals (#970)
  • Remove unsupported PinnedQuery and mark x-version-deprecated to field cutoff_frequency in MultiMatchQuery (#1000)
  • Remove force from VersionType (#1017)
  • Remove fields from SearchResult (#1018)
  • Remove redundant type:object from *Aggregate types (#1083)
  • Removed unpublished titlecase@1.1.3 dependency; replaced with local implementation (#1111)
  • Removed unused dependencies: eslint-config-standard-with-typescript, eslint-plugin-import, eslint-plugin-n, eslint-plugin-promise, @eslint/eslintrc

Fixed

  • Fixed HitsMetadata to mark max_score as required (#1103)
  • Fixed create_pit keep_alive query parameter to be required (#1102)
  • Fixed ISM index parameters to use Indices type instead of IndexName for multi-index support (#1097)
  • Fixed failures field type in PauseIngestionResponse and ResumeIngestionResponse from array to map keyed by index name, matching server serialization (#1107)
  • Fixed the default parameters for data_stream/_stats and shard_stores/status (#931)
  • Fixed the type of SearchStats's concurrent_avg_slice_count to be a double (#942)
  • Fixed name and metadata missing from metric aggregations (#969)
  • Fixed the type of param in pull-based ingestion's ingestion_source to take in Object for value instead of string (#945)
  • Fixed fields in TermsAggregation, CardinalityExecutionMode (#982)
  • Fixed TermsQuery _name and boost type (#984)
  • Fixed SearchResult::hits specification (#1011)
  • Fixed the type of Hit's matched_queries to be either an array or a map to support when include_named_queries_score is true (#1015)
  • Fixed aggregation schema strict mode compliance: restructured MetricAggregationBase and TermsAggregation by moving field and script into optional anyOf branches; added value_type to MinAggregation and MaxAggregation; updated ValueType enum (added byte, float, integer, range, short, unsigned_long; removed date_nanos); changed min_doc_count and shard_min_doc_count in TermsAggregation from int32 to int64 (#1056)

Security

Read more