Skip to content

Commit

Permalink
updated compatibility information (#189)
Browse files Browse the repository at this point in the history
* updated compatibility information
added row on table relating to the 2.x version of the client
added updated policy information regarding compatibility

Signed-off-by: Abhinav Garg <ag90@illinois.edu>

* Update opensearch/src/lib.rs

Co-authored-by: Andriy Redko <drreta@gmail.com>
Signed-off-by: Abhinav Garg <112351850+AbhinavGarg90@users.noreply.github.com>

* added exception warning

Signed-off-by: Abhinav Garg <ag90@illinois.edu>

* Update opensearch/src/lib.rs

fixed typo

Co-authored-by: Thomas Farr <xtansia@xtansia.com>
Signed-off-by: Abhinav Garg <112351850+AbhinavGarg90@users.noreply.github.com>

---------

Signed-off-by: Abhinav Garg <ag90@illinois.edu>
Signed-off-by: Abhinav Garg <112351850+AbhinavGarg90@users.noreply.github.com>
Co-authored-by: Andriy Redko <drreta@gmail.com>
Co-authored-by: Thomas Farr <xtansia@xtansia.com>
  • Loading branch information
3 people committed Oct 17, 2023
1 parent 94e7b72 commit 13d0d4b
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion opensearch/src/lib.rs
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

0 comments on commit 13d0d4b

Please sign in to comment.