https://github.com/opensearch-project/opensearch-api-specification
API specification for OpenSearch
https://github.com/opensearch-project/opensearch-api-specification
Last synced: 2 months ago
JSON representation
API specification for OpenSearch
- Host: GitHub
- URL: https://github.com/opensearch-project/opensearch-api-specification
- Owner: opensearch-project
- License: apache-2.0
- Created: 2022-02-14T20:40:21.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T06:09:43.000Z (about 1 year ago)
- Last Synced: 2024-04-13T21:54:45.454Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 1.39 MB
- Stars: 26
- Watchers: 20
- Forks: 19
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
## OpenSearch API Specification
[](https://codecov.io/github/opensearch-project/opensearch-api-specification)
[](https://github.com/opensearch-project/opensearch-api-specification/actions/workflows/test-tools-unit.yml)
[](https://github.com/opensearch-project/opensearch-api-specification/actions/workflows/test-tools-integ.yml)
[](https://github.com/opensearch-project/opensearch-api-specification/actions/workflows/test-spec.yml)
[](https://github.com/opensearch-project/opensearch-api-specification/actions/workflows/validate-spec-lint.yml)
- [OpenSearch API Specification](#opensearch-api-specification)
- [Welcome!](#welcome)
- [OpenSearch API Source of Truth](#opensearch-api-source-of-truth)
- [Working in this Repo](#working-in-this-repo)
- [Project Resources](#project-resources)
- [Code of Conduct](#code-of-conduct)
- [Security](#security)
- [License](#license)
- [Copyright](#copyright)
## Welcome!
The `opensearch-api-specification` is an open source, community-driven collection of API model specifications for [OpenSearch](https://github.com/opensearch-project/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](https://github.com/opensearch-project/opensearch-api-specification/releases).
### 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](spec/), and [publishes](https://github.com/opensearch-project/opensearch-api-specification/releases) a single-file OpenAPI 3.1.0 spec. The latter is used to [generate OpenSearch language clients](https://github.com/opensearch-project/opensearch-clients/issues/19), [generate mechanical parts of the OpenSearch documentation](https://github.com/opensearch-project/documentation-website/issues/7700), and will be used to [generate the OpenSearch server API itself](https://github.com/opensearch-project/OpenSearch/issues/3090).
### Working in this Repo
Because of our legacy, the specification is produced by reading the [OpenSearch documentation](https://opensearch.org/docs/latest/) and reverse-engineering code. Thus, a good place to start contributing to this repo is to [identify a missing API and to add it](https://github.com/opensearch-project/opensearch-api-specification/issues/168) by following the [developer guide](DEVELOPER_GUIDE.md). This repo also contains a set of [test tools](TESTING_GUIDE.md) 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](https://github.com/opensearch-project/opensearch-api-specification/pulls?q=is%3Apr+is%3Aclosed).
## Project Resources
* [Current Release](https://github.com/opensearch-project/opensearch-api-specification/releases/download/main-latest/opensearch-openapi.yaml)
* [Developer Guide](DEVELOPER_GUIDE.md).
* [Client Generator Guide](CLIENT_GENERATOR_GUIDE.md).
* [Spec Publishing Guide](PUBLISHING_GUIDE.md).
* [Project Website](https://opensearch.org/)
* [API Playground](https://opensearch-project.github.io/opensearch-api-specification/)
* [Downloads](https://opensearch.org/downloads.html)
* [Documentation](https://opensearch.org/docs/)
* Need help? Try [Forums](https://forum.opensearch.org/)
* [Project Principles](https://opensearch.org/#principles)
* [Contributing Guidelines](CONTRIBUTING.md)
## Code of Conduct
This project has adopted the [Amazon Open Source Code of Conduct](CODE_OF_CONDUCT.md). For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq), or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
## Security
If you discover a potential security issue in this project we ask that you notify OpenSearch Security directly via email to [email protected]. Please do **not** create a public GitHub issue.
## License
This project is licensed under the [Apache v2.0 License](LICENSE.txt).
## Copyright
Copyright OpenSearch Contributors. See [NOTICE](NOTICE.txt) for details.