Skip to content

OpenSearch OpenAPI Spec (main)

Pre-release
Pre-release
Compare
Choose a tag to compare
@github-actions github-actions released this 20 Sep 17:01
main-latest
c6c0c41
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.

Unreleased

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

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])(#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)

Deprecated

Removed

  • Removed the ability to skip an individual spec test (#358)
  • Removed shape query (#531)

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)

Security

Links

Assets 4
Loading