OpenSearch OpenAPI Spec (main)

[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 Protob...

v0.2.0

Added

• Added specs for LTR plugin for store endpoints (#861)
• Added defaults for Snapshot APIs (#830)
• Added defaults for Snapshot API request body fields (#846)
• Added specs for LTR plugin for stats endpoints (#786)
• Added defaults for Cluster APIs (#824)
• Added aggs alias for nested aggregations (#818)
• 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 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)
• Added POST /_plugins/_ml/_train/{algorithm_name}, _predict/{algorithm_name}/{model_id}, and _train_predict/{algorithm_name} (#755)
• Added PUT /_plugins/_ml/model_groups/{model_group_id}, GET /_plugins/_ml/model_groups/_search, and POST /_plugins/_ml/model_groups/_search (#760)
• Added GET /_plugins/_ml/connectors/{connector_id}, _search, POST /_plugins/_ml/connectors/_search, and PUT /_plugins/_ml/connectors/{connector_id} (#764)
• Added the ability to skip an individual chapter test (#765)
• Added uploading of test spec logs (#767)
• Added aggs property as an alias to aggregations in requestBody of search #774
• Added POST /_plugins/_ml/memory, POST /_plugins/_ml/memory/_search, {memory_id}/_search, {memory_id}/messages, PUT /_plugins/_ml/memory/{memory_id}, message/{message_id}, GET /_plugins/_ml/memory, GET /_plugins/_ml/memory/{memory_id}, _search, message/{message_id}, {memory_id}/messages, {memory_id}/_search, message/{message_id}/traces, and DELETE /_plugins/_ml/memory/{memory_id} (#771)
• Added support for evaluating response payloads in prologues and epilogues (#772)
• Added GET /_plugins/_ml/models/{model_id}, POST /_plugins/_ml/models/_search, POST /_plugins/_ml/models/_unload, _undeploy, _upload, meta, _register_meta, POST /_plugins/_ml/models/{model_id}/_load, _predict, _unload, chunk/{chunk_number}, upload_chunk/{chunk_number}, and PUT /_plugins/_ml/models/{model_id} (#733)
• Added GET, POST, PUT, DELETE /_plugins/_ml/controllers/{model_id} (#779)
• Added GET /_plugins/_ml/profile, GET /_plugins/_ml/profile/models, models/{model_id}, tasks, tasks/{task_id} (#787)
• Added GET /_plugins/_ml/stats/, stats/{stat}, {nodeId}/stats/, {nodeId}/stats/{stat} (#794)
• Added GET, POST /_plugins/_ml/tasks/_search, GET /_plugins/_ml/tools, tools/{tool_name} (#797)
• Added POST /_plugins/_ml/agents/{agent_id}/_execute, GET /_plugins/_ml/agents/{agent_id}, GET, POST /_plugins/_ml/agents/_search (#798)
• Added a warning for test file names that don't match the API being tested (#793)
• Added time field to the GetStats schema in _common.yml (#803)
• Added version for POST /_plugins/_ml/_train/{algorithm_name}, _predict/{algorithm_name}/{model_id}, and _train_predict/{algorithm_name} (#763)
• Added POST _plugins/_security/api/internalusers/{username} response 201 (#810)
• Added POST /_plugins/_ml/_execute/{algorithm_name} (#811)
• Added search suggester types ([#817](https://github.com/opensearch-...

v0.1.0

Added

• Added CHANGELOG (#309)
• Added a spec test framework (#299)
• Added tests for the framework (#310)
• Added workflow to determine API changes (#297)
• Added link checking (#269)
• Added API coverage (#210)
• Added license headers to TypeScript code (#311)
• Added npm run test:spec -- --dry-run --verbose (#303)
• Added npm run test:unit and test:integ (#320)
• Added code coverage to tools' tests (#323)
• Added a YAML linter (#312)
• Added linter to validate order of spec operations (#325) (#326)
• Added support to read outputs from requests in tests(#324)
• Added eslint-plugin-eslint-comments (#333)
• Added distribution field to OpenSearchVersionInfo (#336)
• Added created_time and last_updated_time to ml.get_model_group@200 (#342)
• Added spellcheck linter (#341)
• Added tests for response payload (#347)
• Added cancel_after_time_interval and phase_took in _search (#353)
• Added support for testing application/x-ndjson payloads (#355)
• Added TESTING_GUIDE.md (#359)
• Added StoryValidator to validate stories before running them (#354)
• Added support for text/plain responses in _cat APIs (#360)
• Added support for application/yaml responses (#363)
• Added test for search with seq_no_primary_term (#367)
• Added a linter for parameter sorting (#369)
• Added AjvErrorsParser to print more informative error messages (#364)
• Added JsonSchemaValidator, a wrapper for AJV (#364)
• Added support for application/cbor responses (#371)
• Added /_plugins/_sql, close, explain and stats (#379)
• Added support for application/smile responses (#386)
• Added doc_status, remote_store, segment_replication and unreferenced_file_cleanups_performed to SegmentStats (#395)
• Added concurrent_query_* and search_idle_reactivate_count_total fields to SearchStats (#395)
• Added remote_store to TranslogStats (#395)
• Added file to /_cache/clear and /{index}/_cache/clear (#396)
• Added strict_allow_templates option for the dynamic mapping parameter (#408)
• Added a workflow to run tests against the next version of OpenSearch (#409)
• Added support for skipping tests using semver range (#410)
• Added cluster_manager_timeout to HEAD /{index} (#421)
• Added missing fields to /_nodes/stats (#415)
• Added missing metrics options to /_nodes/stats (#422)
• Added tests against OpenSearch 1.3 (#424)
• Added is_hidden to /{index}/_alias/{name} and /{index}/_aliases/{name} (#429)
• Added ignore_unmapped to GeoDistanceQuery (#427)
• Added missing variants of indices.put_alias (#434)
• Added plugins to NodeInfoSettings (#442)
• Added test coverage (#443)
• Added --opensearch-version to merger that excludes schema elements per semver (#428)
• Added retry to tester to support asynchronous tasks (#453)
• Added passing OPENSEARCH_JAVA_OPTS into the docker container used for tests (#454)
• Added a warning on mulitple paths being tested in the same file (#452)
• Added validation of titles and descriptions in info and schema objects (#463)
• Added /_plugins/_query/settings (#456)
• Added /_plugins/_ppl, explain and stats (#460)
• Added tests against OpenSearch 3.0 (#459)
• Added support for request headers in tests #461
• Added metadata additionalProperties to ErrorCause (#462)
• Added creation_date field to DanglingIndex (#462)
• Added doc on cluster create-index blocked workaround (#465)
• Added observability namespace API specifications (#474)
• Added support for reusing output variables as keys in payload expectations (#471)
• Added support for running tests against Amazon OpenSearch (#476)
• Added API spec for security plugin (#271)
• Added /_plugins/_security/api/certificates/ (#439)
• Added /_plugins/_ml/models/{model_id}/_deploy, _undeploy and knn_vector type in passage_embedding (#504)
• Added PersonalizeSearchRanking, RetrievalAugmentedGeneration, Rerank, Collapse, TruncateHits, SortResponseProcessor and SplitResponseProcessor (#505)
• Added /_plugins/_security/api/certificates/ to API spec (#439)
• Added support for annotating and testing the API spec against multiple OpenSearch distributions (#483)
• Added read_time, write_time, queue_size and io_time_in_millis to IoStatDevice (#483)
• Added total_rejections_breakup to ShardIndexingPressureStats ([#483](https://github.com/o...