README.md

April 21, 2025 · View on GitHub

OpenSearch API Specification

OpenSearch API Specification
Welcome!
- OpenSearch API Source of Truth
- Working in this Repo
Project Resources
Code of Conduct
Security
License
Copyright

The opensearch-api-specification is an open source, community-driven collection of API model specifications for OpenSearch APIs. The API models are written in OpenAPI format and are used to generate client libraries and documentation. You can find the latest release of the API specification here.

OpenSearch API Source of Truth

This repo aims to be the complete source of truth for OpenSearch and OpenSearch Dashboards REST APIs, including plugins. To be the source of truth, this repo accurately represents APIs in YAML, and publishes a single-file OpenAPI 3.1.0 spec. The latter is used to generate OpenSearch language clients, generate mechanical parts of the OpenSearch documentation, and will be used to generate the OpenSearch server API itself.

Working in this Repo

Because of our legacy, the specification is produced by reading the OpenSearch documentation and reverse-engineering code. Thus, a good place to start contributing to this repo is to identify a missing API and to add it by following the developer guide. This repo also contains a set of test tools that ensure the correctness of this API and infrastructure that evaluates the gap between the OpenSearch server and this API spec by comparing REST routes registered in a running OpenSearch to the list of the APIs in this repo. You can see the latest API and test coverage numbers in the comments automatically added to any recently merged pull requests.