Skip to content

Latest commit

 

History

History
266 lines (248 loc) · 34.3 KB

CHANGELOG.md

File metadata and controls

266 lines (248 loc) · 34.3 KB
Raw

CHANGELOG

Inspired from Keep a Changelog

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)

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)

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)

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)

0.1.0 - 2024-10-25

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 replication namespace API specifications (#464)
  • 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)
  • Added cancelled_task_percentage and current_cancellation_eligible_tasks_count to ShardSearchBackpressureTaskCancellationStats (#483)
  • Added detailed test coverage report (#513)
  • Added 404 responses to /_alias/{name} and /{index}/_alias/{name} (#519)
  • Added asynchronous_search (#525)
  • Added DELETE /_plugins/_ml/tasks/{task_id} (#530)
  • Added /_plugins/_flow_framework (#508)
  • Added AwarenessAttributeStats to /_cluster/health (#534)
  • Added cache_reserved_in_bytes to ClusterFileSystem (#534)
  • Added cluster_manager to ClusterNodeCount (#534)
  • Added support for query with terms in _search (#546)(#564)(#570)
  • Added h, bytes, time parameters to cat API tests (#551)
  • Added terminated_early to count@200 (#547)
  • Added request and response schemas for /_cluster/routing/awareness/{attribute}/weights (#524)
  • Added request and response schemas for /_cluster/decommission/awareness (#524)
  • Added Bytes component of type number (#552)
  • Added xy_shape query (#531)
  • Added /_plugins/_flow_framework/, _search, state/_search, _provision, _deprovision, _steps, and _status (#508) (#833)
  • Added /_plugins/_ism/policies, add, remove, change_policy, explain, and retry (#568) (#578)
  • Added /_plugins/refresh_search_analyzers (#578)
  • Added /_bulk/stream (#584)
  • Added /_plugins/_ml/agents/_register, /_plugins/_ml/connectors/_create, DELETE /_plugins/_ml/agents/{agent_id}, DELETE /_plugins/_ml/connectors/{connector_id} (#228)
  • Added the context query param to the put_script APIs (#586)
  • Added persian_stem filter (#592)
  • Added 404 response for DELETE /{index}, GET /{index}/_doc/{id}, DELETE /{index}/_doc/{id} (#589)
  • Added ability to pass InlineScript as a simple string (#605)
  • Added config_id and config_id_list to /_plugins/_notifications/configs query parameters (#594)
  • Added a release workflow triggered on a tag (#635)
  • Added API spec for query insights plugin (#625)
  • Added API spec for adjust_pure_negative for bool queries (#641)
  • Added a spec style checker #620.
  • Added remote_store to node Stats (#643)

Changed

  • Replaced Smithy with a native OpenAPI spec (#189)
  • Refactored spec tester internals to improve reusability (#302)
  • Renamed main release tag to main-latest (#321)
  • Replaced usages of Opensearch with OpenSearch (#335)
  • Prevented merger tool from printing warnings when used by tester tool (#359)
  • Replaced the deprecated fs.rmdirSync with fs.rmSync (#359)
  • Added better context for non-2XX responses when --verbose is used with the tester tool (#359)
  • Locked testing for next release of OpenSearch to a specific SHA (#431)
  • Replaced nullable with null type (#436)
  • Split test suite (#472)
  • Changed WriteResponseBase's _primary_term, _seq_no & _version to have int64 format (#530)
  • Adjusted indices, shards cat API to test against unassigned indices (#551)
  • Corrected Sort schema for /_search's request body (#529)
  • Rename Bytes component to StorageType (#552)
  • Rename ByteSize to StorageSize (#552)
  • Split Percentage into PercentageNumber, PercentageString (#573)
  • Unified all routing query params to take a string or array of strings (#586)
  • Changed rank_eval's search_type query param to use the SearchType enum rather than a plain string (#586)
  • Changed cluster.reroute's metric path param to use an enum of metrics (#586)
  • Changed indices.stats's metric path param to use an enum of metrics (#586)
  • Changed CleanupRepositoryResults' properties to be int64s (#587)

Deprecated

Removed

  • Removed the ability to skip an individual spec test (#358)
  • Removed shape query (#531)
  • Removed unsupported DataStream Lifecycle types (#600)
  • Removed unsupported runtime field types (#634)

Fixed

  • Fixed GitHub pages (#215)
  • Fixed missing 201 response in /{index}/_doc/{id} (#331)
  • Fixed SlowlogThresholds (#341)
  • Fixed from_address in SmtpAccount (#341)
  • Fixed pages_processed in /_plugins/_rollup (#341)
  • Fixed _bulk spec request and response types (#355)
  • Fixed text/plain response in /_cat (#357)
  • Fixed /_cat/cluster_manager, /_cat/allocation, /_cat/shards, and /_cat/thread_pool (#373)
  • Fixed optional field in /_nodes (#365)
  • Fixed /{index}/_open can return a task (#376)
  • Fixed _source in bulk responses (#375)
  • Fixed /{index}/_dangling that can return nodes and cluster_name (#391)
  • Fixed Metadata schema (#399)
  • Fixed /_data_stream health status and required fields (#401)
  • Fixed query DSL match that supports a field name and value (#405)
  • Fixed /_mapping with index in query (#385)
  • Fixed duplicate /_nodes/{node_id} path (#416)
  • Fixed _source accepting an array of fields in /_search (#430)
  • Fixed _update_by_query with a simple term (#451)
  • Fixed Duration to allow for non-integers (#479)
  • Fixed accuracy of the index stats schemas (#491)
  • Fixed security spec to add support for 400 and 403s (#439)
  • Fixed required parameters in NodeInfo and NodeOperatingSystemInfo (#483)
  • Fixed query DSL neural field query_image set contentEncoding and model_id as optional (#512)
  • Fixed knn query specification (#538)(#580)
  • Fixed content-type for /hot_threads (#543)
  • Fixed geo_distance query spec (#560)
  • Fixed /_cluster/settings returning flat results (#545)
  • Fixed missing fields in _cat API (#551)
  • Fixed geo_distance query spec (#561)
  • Fixed geo_bounding_box and geo_shape queries (#531)
  • Fixed tasks namespace schemas (#520)
  • Fixed /_plugins/_transform/_preview (#568)
  • Fixed create/delete/index operation in _bulk (#582)
  • Add mode and compression to k-NN index creation and search, and add rescore and oversample_factor to k-NN search (#588)
  • Fixed /{index}/_search with aggregations (#576)
  • Fixed inaccurate numeric type (#597)(#598)(#600)(#612)
  • Fixed mapping and analysis types (#600)
  • Fixed RestStatus responses in DELETE /_plugins/_notifications/configs/{config_id} (#594)
  • Fixed GET /_snapshot_/{repository}/{snapshot} (#608)
  • Fixed POST /_snapshot/{repository}/{snapshot}/_restore when wait_for_completion is false and GET /{index}/_recovery (#611)

Security