/opensearch-api-specification

API specification for OpenSearch

Primary LanguageTypeScriptApache License 2.0Apache-2.0

OpenSearch logo

OpenSearch API Specification

Welcome!

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.

To contribute to this project or to track the developments head over to Projects board. Follow the Developer guide and Contributing guidelines for instructions on building and contributing to opensearch-api-specification.

Project Resources

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ, or contact opensource-codeofconduct@amazon.com with any additional questions or comments.

Developer Guide

See DEVELOPER_GUIDE.

Client Generator Guide

See CLIENT_GENERATOR_GUIDE.

Published Spec

OpenSearch API Specs are hosted at https://opensearch-project.github.io/opensearch-api-specification/. See PUBLISHING_SPECS for more information.

Click here to download the latest OpenSearch OpenAPI yaml file.

Security

If you discover a potential security issue in this project we ask that you notify OpenSearch Security directly via email to security@opensearch.org. Please do not create a public GitHub issue.

License

This project is licensed under the Apache v2.0 License.

Copyright

Copyright OpenSearch Contributors. See NOTICE for details.