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

Jump to bottom

[Deprecation] Deprecate cat master API in favor of cat cluster_manager #1800

Merged
merged 1 commit into from
Jun 29, 2022
Merged

[Deprecation] Deprecate cat master API in favor of cat cluster_manager #1800

merged 1 commit into from
Jun 29, 2022

Conversation

manasvinibs
Copy link
Member

Signed-off-by: Manasvini B Suryanarayana [email protected]

Description

As part of the meta issue opensearch-project/OpenSearch#2589 to track the plan and progress of applying inclusive naming across OpenSearch Repositories.

In this change, we are deprecating cat/_master API and adding _cat/cluster_manager endpoint.

Issues Resolved

#1686

Check List

  • New functionality includes testing.
    • All tests pass
      • yarn test:jest
      • yarn test:jest_integration
      • yarn test:ftr
  • New functionality has been documented.
  • Commits are signed per the DCO using --signoff

@manasvinibs manasvinibs requested a review from a team as a code owner June 24, 2022 21:57
@manasvinibs manasvinibs self-assigned this Jun 24, 2022
joshuarrrr
joshuarrrr approved these changes Jun 24, 2022
View reviewed changes
Copy link
Member

@joshuarrrr joshuarrrr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple questions about whether these files were generated or manually updated, but in either case the changes seem fine.

src/plugins/console/server/lib/spec_definitions/json/generated/cat.cluster_manager.json
@@ -0,0 +1,21 @@
{
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For my own learning, is there documentation for the steps for updating these generated definitions?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! Thanks to @kavilla and @CPTNB, we now have it published here - https://cptnb.github.io/opensearch-dashboards-dev-docs/core-plugins/console/console/

src/core/server/server.api.md
@@ -1041,9 +1041,11 @@ export interface LegacyAPICaller {
(endpoint: 'cat.help', params: CatHelpParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['help']>;
// (undocumented)
(endpoint: 'cat.indices', params: CatIndicesParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['indices']>;
// (undocumented)
// @deprecated (undocumented)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a useful annotation, but it looks like it was maybe added manually? The comment at the top of the file implies this should be generated. Not a problem, but it means the deprecation notice might be lost upon regeneration.

kavilla
kavilla reviewed Jun 25, 2022
View reviewed changes
src/core/server/opensearch/legacy/api_types.ts
@@ -232,6 +232,7 @@ export interface LegacyAPICaller {
(endpoint: 'cat.help', params: CatHelpParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['help']>;
(endpoint: 'cat.indices', params: CatIndicesParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['indices']>;
(endpoint: 'cat.master', params: CatCommonParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['master']>;
(endpoint: 'cat.cluster_manager', params: CatCommonParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['master']>;
Copy link
Member

@kavilla kavilla Jun 25, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does the return type not work for Client['cat']['cluster_manager']? This might require the bumping of the Node client https://github.com/opensearch-project/opensearch-js/blob/e008fe82dc19b156d4eab8acf7022d36641878af/api/api/cat.js#L268

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added an issue here: #1818

@kavilla kavilla merged commit 4ea645e into opensearch-project:main Jun 29, 2022
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jun 29, 2022
@manasvinibs @github-actions
[Deprecation] Deprecate cat master API in favor of cat cluster_manager (
cd1d810 
#1800)

Resolves the issue :
#1686

Signed-off-by: Manasvini B Suryanarayana <[email protected]>
(cherry picked from commit 4ea645e)
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Jun 29, 2022
Merged
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jun 29, 2022
@manasvinibs @github-actions
[Deprecation] Deprecate cat master API in favor of cat cluster_manager (
3ac37f5 
#1800)

Resolves the issue :
#1686

Signed-off-by: Manasvini B Suryanarayana <[email protected]>
(cherry picked from commit 4ea645e)
@opensearch-trigger-bot opensearch-trigger-bot bot mentioned this pull request Jun 29, 2022
Merged
kavilla pushed a commit that referenced this pull request Jun 29, 2022
@opensearch-trigger-bot @manasvinibs
[Deprecation] Deprecate cat master API in favor of cat cluster_manager (
956865d 
#1800) (#1820)

Resolves the issue :
#1686

Signed-off-by: Manasvini B Suryanarayana <[email protected]>
(cherry picked from commit 4ea645e)

Co-authored-by: Manasvini B Suryanarayana <[email protected]>
@kavilla kavilla linked an issue Jun 29, 2022 that may be closed by this pull request
[Deprecation] Deprecate cat master API in favor of cat cluster_manager #1686
Closed
kavilla pushed a commit that referenced this pull request Jul 5, 2022
@opensearch-trigger-bot @manasvinibs
[Deprecation] Deprecate cat master API in favor of cat cluster_manager (
b534c04 
#1800) (#1819)

Resolves the issue :
#1686

Signed-off-by: Manasvini B Suryanarayana <[email protected]>
(cherry picked from commit 4ea645e)

Co-authored-by: Manasvini B Suryanarayana <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joshuarrrr joshuarrrr joshuarrrr approved these changes

@kavilla kavilla kavilla approved these changes

Assignees

@manasvinibs manasvinibs

Labels
backport 2.x deprecation v2.1.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Deprecation] Deprecate cat master API in favor of cat cluster_manager
3 participants
@manasvinibs @joshuarrrr @kavilla