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)

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)

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)
• Added missing repository query parameter to /_cat/snapshots (#700)
• Fixed hits in rank_eval allowing numbers (#704)

Changed

• Changed tasks._common:TaskInfo and tasks._common:TaskGroup to be composed of a tasks._common:TaskInfoBase (#683)

Links

• Build Artifact

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