updated compatibility information #189

AbhinavGarg90 · 2023-10-04T00:10:23Z

Description

updates comments regarding the compatibility policy to reflect that the client does not need to remain in major version lockstep with the server.

Issues Resolved

#178

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

added row on table relating to the 2.x version of the client added updated policy information regarding compatibility Signed-off-by: Abhinav Garg <[email protected]>

opensearch/src/lib.rs

codecov · 2023-10-04T00:29:04Z

Codecov Report

Merging #189 (c14dcce) into main (94e7b72) will increase coverage by 0.00%.
The diff coverage is n/a.

❗ Current head c14dcce differs from pull request most recent head 597590c. Consider uploading reports for the commit 597590c to get more accurate results

@@           Coverage Diff           @@
##             main     #189   +/-   ##
=======================================
  Coverage   73.82%   73.82%           
=======================================
  Files         402      401    -1     
  Lines       63738    63736    -2     
=======================================
  Hits        47055    47055           
+ Misses      16683    16681    -2

Flag	Coverage Δ
integration	`73.82% <ø> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 2 files with indirect coverage changes

dblock

I see tests in this PR run against OpenSearch 1.x and 2.x, so is this correct? AFAIK 2.x client is compatible with both OpenSearch 1.x and 2.x.

Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Abhinav Garg <[email protected]>

AbhinavGarg90 · 2023-10-07T17:22:39Z

I see tests in this PR run against OpenSearch 1.x and 2.x, so is this correct? AFAIK 2.x client is compatible with both OpenSearch 1.x and 2.x.

Could you please elaborate? What action is needed from my end?

Xtansia · 2023-10-08T21:53:10Z

I see tests in this PR run against OpenSearch 1.x and 2.x, so is this correct? AFAIK 2.x client is compatible with both OpenSearch 1.x and 2.x.

Mostly yes, though 2.x of the client dropped the "types" apis, so not 100% compatible with 1.x.

dblock · 2023-10-09T21:59:45Z

I see tests in this PR run against OpenSearch 1.x and 2.x, so is this correct? AFAIK 2.x client is compatible with both OpenSearch 1.x and 2.x.

Could you please elaborate? What action is needed from my end?

The line that says | 2.x | 2.x | is incorrect. It should be | 1.x - 2.x | 2.x | or something like that?

dblock · 2023-10-09T22:00:29Z

I see tests in this PR run against OpenSearch 1.x and 2.x, so is this correct? AFAIK 2.x client is compatible with both OpenSearch 1.x and 2.x.

Mostly yes, though 2.x of the client dropped the "types" apis, so not 100% compatible with 1.x.

I see. So do you think the code in this PR is correct? If so, then let's merge?

Xtansia · 2023-10-11T03:33:33Z

I see tests in this PR run against OpenSearch 1.x and 2.x, so is this correct? AFAIK 2.x client is compatible with both OpenSearch 1.x and 2.x.

Mostly yes, though 2.x of the client dropped the "types" apis, so not 100% compatible with 1.x.

I see. So do you think the code in this PR is correct? If so, then let's merge?

It's tricky as only listing 2.x as compatible definitely undersells the level of compatibility, but we also probably don't want to list 1.x without qualifying conditions in case we get complaints around missing functionality for 1.x.

But maybe we can do something like:

Rust client	OpenSearch
`1.x`	`1.x`
`2.x`	`2.x`, `1.x`^

^: With the exception of some previously deprecated APIs

AbhinavGarg90 · 2023-10-11T06:28:59Z

I see tests in this PR run against OpenSearch 1.x and 2.x, so is this correct? AFAIK 2.x client is compatible with both OpenSearch 1.x and 2.x.

Mostly yes, though 2.x of the client dropped the "types" apis, so not 100% compatible with 1.x.

I see. So do you think the code in this PR is correct? If so, then let's merge?

It's tricky as only listing 2.x as compatible definitely undersells the level of compatibility, but we also probably don't want to list 1.x without qualifying conditions in case we get complaints around missing functionality for 1.x.

But maybe we can do something like:

Rust client OpenSearch
1.x 1.x
2.x 2.x, 1.x^

^: With the exception of some previously deprecated APIs

this sounds like a good idea. Gives a fair warning to somebody, but still ensure they know that it is compatible to an extent. Should I commit that change?

Signed-off-by: Abhinav Garg <[email protected]>

AbhinavGarg90 · 2023-10-17T05:23:49Z

the additional line has been added. Does that look fine @Xtansia ?

Xtansia

Looks good, just a minor typo to fix please @AbhinavGarg90.

Thanks!

opensearch/src/lib.rs

fixed typo Co-authored-by: Thomas Farr <[email protected]> Signed-off-by: Abhinav Garg <[email protected]>

2.x's compatibility with 1.x server has been included in the comment

updated compatibility information

7c3393f

added row on table relating to the 2.x version of the client added updated policy information regarding compatibility Signed-off-by: Abhinav Garg <[email protected]>

AbhinavGarg90 requested review from dblock, Xtansia, VachaShah and reta as code owners October 4, 2023 00:10

reta reviewed Oct 4, 2023

View reviewed changes

opensearch/src/lib.rs Outdated Show resolved Hide resolved

reta added the skip-changelog Skip changelog verification label Oct 4, 2023

dblock previously requested changes Oct 4, 2023

View reviewed changes

Update opensearch/src/lib.rs

c14dcce

Co-authored-by: Andriy Redko <[email protected]> Signed-off-by: Abhinav Garg <[email protected]>

Xtansia added the OSCI-2023 label Oct 11, 2023

AbhinavGarg90 and others added 2 commits October 17, 2023 00:17

Merge branch 'opensearch-project:main' into fix-compatibility-policy

10bf73f

added exception warning

4068057

Signed-off-by: Abhinav Garg <[email protected]>

Xtansia requested changes Oct 17, 2023

View reviewed changes

opensearch/src/lib.rs Outdated Show resolved Hide resolved

Update opensearch/src/lib.rs

597590c

fixed typo Co-authored-by: Thomas Farr <[email protected]> Signed-off-by: Abhinav Garg <[email protected]>

Xtansia approved these changes Oct 17, 2023

View reviewed changes

Xtansia merged commit 13d0d4b into opensearch-project:main Oct 17, 2023
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

updated compatibility information #189

updated compatibility information #189

AbhinavGarg90 commented Oct 4, 2023

codecov bot commented Oct 4, 2023 •

edited

Loading

dblock left a comment

AbhinavGarg90 commented Oct 7, 2023

Xtansia commented Oct 8, 2023

dblock commented Oct 9, 2023

dblock commented Oct 9, 2023

Xtansia commented Oct 11, 2023

AbhinavGarg90 commented Oct 11, 2023

AbhinavGarg90 commented Oct 17, 2023

Xtansia left a comment •

edited

Loading

updated compatibility information #189

updated compatibility information #189

Conversation

AbhinavGarg90 commented Oct 4, 2023

Description

Issues Resolved

codecov bot commented Oct 4, 2023 • edited Loading

Codecov Report

dblock left a comment

Choose a reason for hiding this comment

AbhinavGarg90 commented Oct 7, 2023

Xtansia commented Oct 8, 2023

dblock commented Oct 9, 2023

dblock commented Oct 9, 2023

Xtansia commented Oct 11, 2023

AbhinavGarg90 commented Oct 11, 2023

AbhinavGarg90 commented Oct 17, 2023

Xtansia left a comment • edited Loading

Choose a reason for hiding this comment

codecov bot commented Oct 4, 2023 •

edited

Loading

Xtansia left a comment •

edited

Loading