Deprecate legacy API #390

tannerjones4075 · 2023-10-10T20:33:29Z

Description

Deprecated: uses a nonexistent legacy REST API (/_template). In OpenSearch v2.x the correct REST API is /_index_template, which is accessible by the correct method in the following location: opensearchapi/api.indices.put_index_template.go

Issues Resolved

Removing a legacy API that creates confusion among current use of the API

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.

dblock · 2023-10-10T21:53:45Z

Looks like some documentation changes came along that you didn't mean to?

If the API doesn't work (users get an error today if they call it?), you can delete it I think. This is why we need to be using a code generator from spec ... is this code generated by any chance?

tannerjones4075 · 2023-10-10T22:02:25Z

Are you referring to the code 27-31 for the unneeded documentation? I working on another issue to modify/create the generator #284. To my knowledge, this is not generated code. @VachaShah please correct me if I am wrong?

VachaShah · 2023-10-10T22:05:20Z

Are you referring to the code 27-31 for the unneeded documentation? I working on another issue to modify/create the generator #284. To my knowledge, this is not generated code. @VachaShah please correct me if I am wrong?

Yeah for the generator part, this code used to be generated before the fork but not anymore. @tannerjones4075 is working on getting the generator going so these kind of bugs don't crop up.

dblock

I tried to make it clearer.

CHANGELOG.md

opensearchapi/api.indices.put_template.go

tannerjones4075 · 2023-10-13T01:36:50Z

@dblock or @VachaShah is this good to merge?

dblock · 2023-10-13T13:42:28Z

@dblock or @VachaShah is this good to merge?

No, you need to rebase this PR and it shouldn't include the unrelated docker documentation change, just the deprecated parts. Look at the GitHub diff to make sure you got the right things - let us know if you need help!

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

dblock

Code LGTM.

Can you explain what "uses a nonexistent legacy REST API (/_template) correct REST API is /_index_template use IndicesPutSettings instead" actually means? When I read it, to me it sounds like these methods use something that doesn't work. What am I missing?

tannerjones4075 · 2023-10-13T18:17:27Z

Code LGTM.

Can you explain what "uses a nonexistent legacy REST API (/_template) correct REST API is /_index_template use IndicesPutSettings instead" actually means? When I read it, to me it sounds like these methods use something that doesn't work. What am I missing?

There is a legacy API that currently works but it creates confusion as there is a new API. Deprecating the legacy API that creates confusion among current user will and shift them to the new API. As @Jakob3xD explained that deprecation is correct.

dblock · 2023-10-13T18:21:40Z

I'm leaving this to @Jakob3xD to review/merge! Thanks.

Jakob3xD

Can you also please update all the other template files.

opensearchapi/api.indices.get_template.go
opensearchapi/api.indices.exists_template.go
opensearchapi/api.indices.delete_template.go

CHANGELOG.md

opensearchapi/api.indices.put_template.go

Co-authored-by: Jakob <jakob.hahn@hetzner.com> Signed-off-by: Tanner Jones <78619684+tannerjones4075@users.noreply.github.com>

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

tannerjones4075 · 2023-10-16T16:57:42Z

Can you also please update all the other template files.

opensearchapi/api.indices.get_template.go

opensearchapi/api.indices.exists_template.go

opensearchapi/api.indices.delete_template.go

I have added the deprecated statement to above locations.

…d back in IndicesExistsTemplate that was delete by mistake Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

* deprecated legacy REST API /_template Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * deprecated legacy REST API /_template Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * removed deprecated header at the top of the doc Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * added deprecated notes to the CHANGELOG.md Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Corrected deprecation statement Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Update CHANGELOG.md Co-authored-by: Jakob <jakob.hahn@hetzner.com> Signed-off-by: Tanner Jones <78619684+tannerjones4075@users.noreply.github.com> * Updated deprecated message on api.indices.put_template.go Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Added deprecated message on api.indices.exists_template.go Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Added deprecated message on api.indices.delete_template.go Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Added deprecated message on api.indices.get_template.go Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Updated deprecated message on api.indices.exists_template.go and added back in IndicesExistsTemplate that was delete by mistake Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> --------- Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> Signed-off-by: Tanner Jones <78619684+tannerjones4075@users.noreply.github.com> Co-authored-by: Jakob <jakob.hahn@hetzner.com>

* deprecated legacy REST API /_template Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * deprecated legacy REST API /_template Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * removed deprecated header at the top of the doc Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * added deprecated notes to the CHANGELOG.md Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Corrected deprecation statement Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Update CHANGELOG.md Co-authored-by: Jakob <jakob.hahn@hetzner.com> Signed-off-by: Tanner Jones <78619684+tannerjones4075@users.noreply.github.com> * Updated deprecated message on api.indices.put_template.go Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Added deprecated message on api.indices.exists_template.go Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Added deprecated message on api.indices.delete_template.go Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Added deprecated message on api.indices.get_template.go Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Updated deprecated message on api.indices.exists_template.go and added back in IndicesExistsTemplate that was delete by mistake Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> --------- Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> Signed-off-by: Tanner Jones <78619684+tannerjones4075@users.noreply.github.com> Co-authored-by: Jakob <jakob.hahn@hetzner.com> Signed-off-by: Vacha Shah <vachshah@amazon.com>

* tannerjones4075- update developer guide (#385) * Updating DEVELOPER_GUIDE.md file to include docker build instructions Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Updating DEVELOPER_GUIDE.md file to include docker build instructions Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Updating DEVELOPER_GUIDE.md file and CHANGELOG Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Removed link from localhost:9200 Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> --------- Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> Signed-off-by: Vacha Shah <vachshah@amazon.com> * Bump github.com/aws/aws-sdk-go from 1.45.20 to 1.45.24 (#387) * Bump github.com/aws/aws-sdk-go from 1.45.20 to 1.45.24 Bumps [github.com/aws/aws-sdk-go](https://github.com/aws/aws-sdk-go) from 1.45.20 to 1.45.24. - [Release notes](https://github.com/aws/aws-sdk-go/releases) - [Commits](aws/aws-sdk-go@v1.45.20...v1.45.24) --- updated-dependencies: - dependency-name: github.com/aws/aws-sdk-go dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Update changelog Signed-off-by: dependabot[bot] <support@github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com> * Bump github.com/aws/aws-sdk-go-v2 from 1.21.0 to 1.21.1 (#388) * Bump github.com/aws/aws-sdk-go-v2 from 1.21.0 to 1.21.1 Bumps [github.com/aws/aws-sdk-go-v2](https://github.com/aws/aws-sdk-go-v2) from 1.21.0 to 1.21.1. - [Release notes](https://github.com/aws/aws-sdk-go-v2/releases) - [Commits](aws/aws-sdk-go-v2@v1.21.0...v1.21.1) --- updated-dependencies: - dependency-name: github.com/aws/aws-sdk-go-v2 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Update changelog Signed-off-by: dependabot[bot] <support@github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com> * Bump github.com/aws/aws-sdk-go-v2/config from 1.18.43 to 1.18.44 (#389) * Bump github.com/aws/aws-sdk-go-v2/config from 1.18.43 to 1.18.44 Bumps [github.com/aws/aws-sdk-go-v2/config](https://github.com/aws/aws-sdk-go-v2) from 1.18.43 to 1.18.44. - [Release notes](https://github.com/aws/aws-sdk-go-v2/releases) - [Commits](aws/aws-sdk-go-v2@config/v1.18.43...config/v1.18.44) --- updated-dependencies: - dependency-name: github.com/aws/aws-sdk-go-v2/config dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Update changelog Signed-off-by: dependabot[bot] <support@github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com> * Bump golang.org/x/net from 0.7.0 to 0.17.0 (#391) * Bump golang.org/x/net from 0.7.0 to 0.17.0 Bumps [golang.org/x/net](https://github.com/golang/net) from 0.7.0 to 0.17.0. - [Commits](golang/net@v0.7.0...v0.17.0) --- updated-dependencies: - dependency-name: golang.org/x/net dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> * Update changelog Signed-off-by: dependabot[bot] <support@github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com> * Update DEVELOPER_GUID, Add Coverage + go ling to Makefile, Run CI tests on all branches (#392) * .github: run test workflows for all branches, test against 2.9,2.10 Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com> * Makefile: use docker golangci-lint, run integration test on `.` folder, change coverage generation Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com> * Update DEVELOPER_GUIDE Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com> --------- Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com> Signed-off-by: Vacha Shah <vachshah@amazon.com> * Updated linter version to 1.54.2 (#394) * Updated linter version to 1.54.2 Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Updated CHANGELOG.md Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Updated CHANGELOG.md Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Updated CHANGELOG.md - moved linter update to Dependencies Bumps Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> --------- Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> Signed-off-by: Daniel (dB.) Doubrovkine <dblock@dblock.org> Co-authored-by: Daniel (dB.) Doubrovkine <dblock@dblock.org> Signed-off-by: Vacha Shah <vachshah@amazon.com> * Deprecate legacy API (#390) * deprecated legacy REST API /_template Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * deprecated legacy REST API /_template Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * removed deprecated header at the top of the doc Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * added deprecated notes to the CHANGELOG.md Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Corrected deprecation statement Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Update CHANGELOG.md Co-authored-by: Jakob <jakob.hahn@hetzner.com> Signed-off-by: Tanner Jones <78619684+tannerjones4075@users.noreply.github.com> * Updated deprecated message on api.indices.put_template.go Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Added deprecated message on api.indices.exists_template.go Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Added deprecated message on api.indices.delete_template.go Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Added deprecated message on api.indices.get_template.go Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> * Updated deprecated message on api.indices.exists_template.go and added back in IndicesExistsTemplate that was delete by mistake Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> --------- Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> Signed-off-by: Tanner Jones <78619684+tannerjones4075@users.noreply.github.com> Co-authored-by: Jakob <jakob.hahn@hetzner.com> Signed-off-by: Vacha Shah <vachshah@amazon.com> * Bump github.com/aws/aws-sdk-go-v2/config from 1.18.44 to 1.19.0 (#398) * Bump github.com/aws/aws-sdk-go-v2/config from 1.18.44 to 1.19.0 Bumps [github.com/aws/aws-sdk-go-v2/config](https://github.com/aws/aws-sdk-go-v2) from 1.18.44 to 1.19.0. - [Release notes](https://github.com/aws/aws-sdk-go-v2/releases) - [Changelog](https://github.com/aws/aws-sdk-go-v2/blob/v1.19.0/CHANGELOG.md) - [Commits](aws/aws-sdk-go-v2@config/v1.18.44...v1.19.0) --- updated-dependencies: - dependency-name: github.com/aws/aws-sdk-go-v2/config dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * Update changelog Signed-off-by: dependabot[bot] <support@github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com> * Bump github.com/aws/aws-sdk-go from 1.45.24 to 1.45.26 (#397) * Bump github.com/aws/aws-sdk-go from 1.45.24 to 1.45.26 Bumps [github.com/aws/aws-sdk-go](https://github.com/aws/aws-sdk-go) from 1.45.24 to 1.45.26. - [Release notes](https://github.com/aws/aws-sdk-go/releases) - [Commits](aws/aws-sdk-go@v1.45.24...v1.45.26) --- updated-dependencies: - dependency-name: github.com/aws/aws-sdk-go dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> * Update changelog Signed-off-by: dependabot[bot] <support@github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com> * Bump client version to 2.4.0 Signed-off-by: Vacha Shah <vachshah@amazon.com> --------- Signed-off-by: Tanner Jones <alltechguyblog@gmail.com> Signed-off-by: Vacha Shah <vachshah@amazon.com> Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com> Signed-off-by: Daniel (dB.) Doubrovkine <dblock@dblock.org> Signed-off-by: Tanner Jones <78619684+tannerjones4075@users.noreply.github.com> Co-authored-by: Tanner Jones <78619684+tannerjones4075@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <dependabot[bot]@users.noreply.github.com> Co-authored-by: Jakob <jakob.hahn@hetzner.com> Co-authored-by: Daniel (dB.) Doubrovkine <dblock@dblock.org>

tannerjones4075 requested review from dblock, VijayanB, VachaShah and Jakob3xD as code owners October 10, 2023 20:33

dblock reviewed Oct 11, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

opensearchapi/api.indices.put_template.go Outdated Show resolved Hide resolved

tannerjones4075 added 5 commits October 13, 2023 08:44

deprecated legacy REST API /_template

52b3eb8

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

deprecated legacy REST API /_template

38c0fba

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

removed deprecated header at the top of the doc

4d4bec5

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

added deprecated notes to the CHANGELOG.md

76d1948

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

Corrected deprecation statement

48c0af8

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

tannerjones4075 force-pushed the deprecate_legacy_API branch from 22d0c71 to 48c0af8 Compare October 13, 2023 16:46

dblock changed the title ~~Tannerjones4075 deprecate legacy API~~ Deprecate legacy API Oct 13, 2023

dblock reviewed Oct 13, 2023

View reviewed changes

Jakob3xD reviewed Oct 15, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

opensearchapi/api.indices.put_template.go Outdated Show resolved Hide resolved

tannerjones4075 and others added 5 commits October 16, 2023 07:27

Update CHANGELOG.md

fb35d23

Co-authored-by: Jakob <jakob.hahn@hetzner.com> Signed-off-by: Tanner Jones <78619684+tannerjones4075@users.noreply.github.com>

Updated deprecated message on api.indices.put_template.go

0cee963

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

Added deprecated message on api.indices.exists_template.go

be86608

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

Added deprecated message on api.indices.delete_template.go

d247800

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

Added deprecated message on api.indices.get_template.go

42695a9

Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

Updated deprecated message on api.indices.exists_template.go and adde…

6e7f10a

…d back in IndicesExistsTemplate that was delete by mistake Signed-off-by: Tanner Jones <alltechguyblog@gmail.com>

dblock approved these changes Oct 16, 2023

View reviewed changes

dblock merged commit deb8f64 into opensearch-project:main Oct 16, 2023
47 checks passed

tannerjones4075 deleted the deprecate_legacy_API branch October 16, 2023 17:45

tannerjones4075 mentioned this pull request Oct 16, 2023

[BUG] Malfunctioning/confusing/redundant Index template method #151

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate legacy API #390

Deprecate legacy API #390

tannerjones4075 commented Oct 10, 2023

dblock commented Oct 10, 2023 •

edited

tannerjones4075 commented Oct 10, 2023

VachaShah commented Oct 10, 2023

dblock left a comment

tannerjones4075 commented Oct 13, 2023

dblock commented Oct 13, 2023

dblock left a comment

tannerjones4075 commented Oct 13, 2023

dblock commented Oct 13, 2023

Jakob3xD left a comment

tannerjones4075 commented Oct 16, 2023 •

edited

Deprecate legacy API #390

Deprecate legacy API #390

Conversation

tannerjones4075 commented Oct 10, 2023

Description

Issues Resolved

dblock commented Oct 10, 2023 • edited

tannerjones4075 commented Oct 10, 2023

VachaShah commented Oct 10, 2023

dblock left a comment

Choose a reason for hiding this comment

tannerjones4075 commented Oct 13, 2023

dblock commented Oct 13, 2023

dblock left a comment

Choose a reason for hiding this comment

tannerjones4075 commented Oct 13, 2023

dblock commented Oct 13, 2023

Jakob3xD left a comment

Choose a reason for hiding this comment

tannerjones4075 commented Oct 16, 2023 • edited

dblock commented Oct 10, 2023 •

edited

tannerjones4075 commented Oct 16, 2023 •

edited