opensearch-api-specification icon indicating copy to clipboard operation
opensearch-api-specification copied to clipboard

API specification for OpenSearch

OpenSearch logo

OpenSearch API Specification

  • OpenSearch API Specification
  • Welcome!
  • Project Resources
  • Code of Conduct
  • Developer Guide
  • OpenSearch API Specs
  • Security
  • License
  • Copyright

Welcome!

opensearch-api-specification is an open source, community-driven collection of API model specifications for OpenSearch APIs. The API models are created using the Smithy Interface Definition Language (IDL). Smithy is an open source IDL which is protocol agnostic, extensible and supports code generation.

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 [email protected] with any additional questions or comments.

Developer Guide

See DEVELOPER_GUIDE.

OpenSearch API Specs

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

Security

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page or 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.

Copyright

Copyright OpenSearch Contributors. See NOTICE for details.