Skip to content

OpenSearch OpenAPI Spec (main)

Pre-release
Pre-release

Choose a tag to compare

View all tags
@github-actions github-actions released this 12 Mar 05:38
main-latest
a2b4f35
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

[Unreleased]

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

Added

  • 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)

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)

Fixed

  • 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)
  • Fixed TermsAggregation value_type type from string to ValueType, enforce enum (#1057)
  • Exclude FilterContainer and order in TermsAggregation in spec (#1059)
  • Fix AggregationContainer to inherit Aggregation type, and remove unnamed field name from Aggregation. Remove geo_point and range from ValueType. Exclude aggs alias from protobufs. (#1060)
  • Fixed Terms aggregation response schemas: corrected field name doc_count_error to doc_count_error_upper_bound, simplified buckets to array-only, added nested aggregations support, and added missing UnsignedLongTermsAggregate (#1063)
  • Fixed partition field formats in TermsPartition from int64 to int32 and removed x-protobuf-excluded from order field in aggregations schema (#1065)
  • Fix AggregationContainer for all bucket aggregations so that aggs/aggregations are siblings of the aggregation type(#1069)

Changed

  • Changed schema of NodeInfoSearchPipelines's response_processors & request_processors to use NodeInfoSearchPipelineProcessor instead of NodeInfoIngestProcessor (#922)
  • Changed knn stats response types to use int64s instead of numbers (#942)
  • Moved sub aggregations into BucketAggregationBase as their usage is only valid here (#971)
  • Remove deprecated rehash option from CardinalityAggregation (#975)
  • Changed type mappings for Protobuf conversion (#991)
  • Change MultiTermQueryRewrite type to string (#1002)
  • Removed Aggregation reference from BucketAggregationBase, MetricAggregationBase, BucketPathAggregation, BucketSortAggregation, MatrixAggregation, TTestAggregation, and WeightedAverageAggregation; simplified BucketAggregationBase, BucketPathAggregation, BucketSortAggregation, MatrixAggregation, TTestAggregation, and WeightedAverageAggregation by removing unnecessary allOf wrapper (#1067)
  • Replace x-protobuf-type to x-protobuf-data-type (#1068)
  • Refactored Aggregate schema to inherit AggregateBase at top level using allOf, removing redundant AggregateBase references from all intermediate and concrete aggregate types (PercentilesAggregateBase, SingleMetricAggregateBase, StatsAggregateBase, MultiBucketAggregateBase, SingleBucketAggregateBase, CardinalityAggregate, GeoBoundsAggregate, GeoCentroidAggregate, ScriptedMetricAggregate, TopHitsAggregate, BoxPlotAggregate, TTestAggregate, RateAggregate, CumulativeCardinalityAggregate, MatrixStatsAggregate) (#1070)

Links

Assets 4
Loading