Skip to content

Conversation

PeteGillinElastic
Copy link
Member

@PeteGillinElastic PeteGillinElastic commented Oct 23, 2024

This removes the local parameter from the GET /_alias, HEAD /_alias, and GET /_cat/aliases APIs. This option became a no-op and was deprecated in 8.12 by #101815.

We continue to accept the parameter (deprecated, with no other effect) in v8 compatibility mode for GET /_alias and HEAD /_alias. We don't do this for GET /_cat/aliases where the compatibility policy does not apply.

This removes the `local` attribute from the `GET /_alias`, `HEAD /_alias`, and `GET /_cat/aliases` APIs. This option became a no-op and was deprecated in 8.12 by elastic#101815.
@PeteGillinElastic PeteGillinElastic added :Data Management/Indices APIs APIs to create and manage indices and templates :Data Management/CAT APIs Text APIs behind /_cat >deprecation v9.0.0 and removed v9.0.0 labels Oct 23, 2024
@elasticsearchmachine
Copy link
Collaborator

Hi @PeteGillinElastic, I've created a changelog YAML for you. Note that since this PR is labelled >deprecation, you need to update the changelog YAML to fill out the extended information sections.

@elasticsearchmachine
Copy link
Collaborator

Hi @PeteGillinElastic, I've updated the changelog YAML for you. Note that since this PR is labelled >breaking, you need to update the changelog YAML to fill out the extended information sections.

@PeteGillinElastic PeteGillinElastic changed the title Remove deprecated local attribute from alias APIs Remove deprecated local parameter from alias APIs Oct 23, 2024
@PeteGillinElastic
Copy link
Member Author

@elasticmachine update branch

@elasticmachine
Copy link
Collaborator

merge conflict between base and head

@PeteGillinElastic PeteGillinElastic marked this pull request as ready for review October 24, 2024 11:09
@PeteGillinElastic PeteGillinElastic requested a review from a team as a code owner October 24, 2024 11:09
@elasticsearchmachine elasticsearchmachine added the Team:Data Management Meta label for data/management team label Oct 24, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-data-management (Team:Data Management)

task.skipTest("indices.sort/10_basic/Index Sort", "warning does not exist for compatibility")
task.skipTest("search/330_fetch_fields/Test search rewrite", "warning does not exist for compatibility")
task.skipTest("indices.create/21_synthetic_source_stored/object param - nested object with stored array", "temporary until backported")
task.skipTest("cat.aliases/10_basic/Deprecated local parameter", "CAT APIs not covered by compatibility policy")
Copy link
Member Author

Choose a reason for hiding this comment

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

N.B. Even if we did implement BWC in the code, we'd still have to skip this test because the test framework does not send the compatible-with headers for CAT APIs.

@masseyke masseyke self-requested a review October 24, 2024 14:41
Copy link
Member

@masseyke masseyke left a comment

Choose a reason for hiding this comment

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

LGTM

@PeteGillinElastic PeteGillinElastic merged commit d7a9575 into elastic:main Oct 24, 2024
16 checks passed
@PeteGillinElastic PeteGillinElastic deleted the remove-deprecated-local-from-get-aliases branch October 24, 2024 14:58
georgewallace pushed a commit to georgewallace/elasticsearch that referenced this pull request Oct 25, 2024
This removes the `local` parameter from the `GET /_alias`, `HEAD /_alias`, and `GET /_cat/aliases` APIs. This option became a no-op and was deprecated in 8.12 by elastic#101815. We continue to accept the parameter (deprecated, with no other effect) in v8 compatibility mode for `GET /_alias` and `HEAD /_alias`. We don't do this for `GET /_cat/aliases` where the [compatibility policy does not apply](https://github.com/elastic/elasticsearch/blob/main/REST_API_COMPATIBILITY.md#when-not-to-apply).
jfreden pushed a commit to jfreden/elasticsearch that referenced this pull request Nov 4, 2024
This removes the `local` parameter from the `GET /_alias`, `HEAD /_alias`, and `GET /_cat/aliases` APIs. This option became a no-op and was deprecated in 8.12 by elastic#101815. We continue to accept the parameter (deprecated, with no other effect) in v8 compatibility mode for `GET /_alias` and `HEAD /_alias`. We don't do this for `GET /_cat/aliases` where the [compatibility policy does not apply](https://github.com/elastic/elasticsearch/blob/main/REST_API_COMPATIBILITY.md#when-not-to-apply).
@leemthompo
Copy link
Contributor

@PeteGillinElastic is this PR relevant to the serverless changelog? [FYI this question is based on 9.0 breaking changes]

@PeteGillinElastic
Copy link
Member Author

I think this depends on the policy for the serverless changelog. This property was deprecated and ignored since 8.0.0, so nobody should have been using it in serverless. I don't know whether this should be mentioned or not.

Also, this change was made in October, before serverless GA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>breaking :Data Management/Indices APIs APIs to create and manage indices and templates Team:Data Management Meta label for data/management team v9.0.0

5 participants