Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated compatibility information #189

Merged
merged 5 commits into from
Oct 17, 2023
Merged

updated compatibility information #189

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7c3393f
updated compatibility information
AbhinavGarg90 Oct 4, 2023
c14dcce
Update opensearch/src/lib.rs
AbhinavGarg90 Oct 7, 2023
10bf73f
Merge branch 'opensearch-project:main' into fix-compatibility-policy
AbhinavGarg90 Oct 17, 2023
4068057
added exception warning
AbhinavGarg90 Oct 17, 2023
597590c
Update opensearch/src/lib.rs
AbhinavGarg90 Oct 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion opensearch/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,11 @@
//!
//! # Versions and Compatibility
//!
//! | Rust client | OpenSearch |
//! | Rust client | OpenSearch |
//! |-------------|---------------|
//! | 1.x | 1.x |
//! | 2.x | 2.x, 1.x^ |
//! - ^: With the exception of some previously deprecated APIs
//!
//! A major version of the client is compatible with the same major version of OpenSearch.
//! Since OpenSearch is developed following [Semantic Versioning](https://semver.org/) principles,
Expand All @@ -42,6 +44,10 @@
//! In the latter case, a 1.4.0 client won't contain API functions for APIs that are introduced in
//! OpenSearch 1.5.0+, but for all other APIs available in OpenSearch, the respective API
//! functions on the client will be compatible.
//!
//! In some instances, a new major version of OpenSearch may remain compatible with an
//! older major version of the client, which may not warrant a need to update the client.
//! Please consult COMPATIBILITY.md for more details.
//!
//! **No compatibility assurances are given between different major versions of the client and
//! OpenSearch**. Major differences likely exist between major versions of OpenSearch, particularly
Expand Down
Loading