Skip to content

Deprecate Behavioral Analytics CRUD apis #122960

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
Merged
merged 13 commits into from
Feb 25, 2025
Merged

Deprecate Behavioral Analytics CRUD apis #122960

merged 13 commits into from
Feb 25, 2025

Conversation

kderusso
Copy link
Member

@kderusso kderusso commented Feb 19, 2025 •
edited
Loading

Deprecates the Behavioral Analytics CRUD APIs and issues the following warning headers when the APIs are used: "Behavioral Analytics is deprecated and will be removed in a future release."

@kderusso kderusso changed the title Kderusso/deprecate behavioral analytics crud apis Deprecate Behavioral Analytics CRUD apis Feb 19, 2025
@kderusso kderusso mentioned this pull request Feb 19, 2025
Merged
@kderusso kderusso added auto-backport Automatically create backport pull requests when merged :SearchOrg/Relevance Label for the Search (solution/org) Relevance team v9.0.0 >deprecation labels Feb 19, 2025
@elasticsearchmachine
Copy link
Collaborator

Hi @kderusso, 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.

@github-actions GitHub Actions
Copy link
Contributor

Warning

It looks like this PR modifies one or more .asciidoc files. These files are being migrated to Markdown, and any changes merged now will be lost. See the migration guide for details.

kderusso
kderusso commented Feb 20, 2025
View reviewed changes
docs/reference/behavioral-analytics/apis/delete-analytics-collection.asciidoc
----
DELETE _application/analytics/my_analytics_collection/
----
// TEST[skip:Behavioral Analytics APIs emit deprecation warnings and will not be updated]
Copy link
Member Author

Choose a reason for hiding this comment

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

There appears to be a bug in our test framework as emitting warnings during test setup can't be handled. Since we're not going to be updating these APIs my solution was to skip the tests.

kderusso
kderusso commented Feb 20, 2025
View reviewed changes
x-pack/plugin/build.gradle
Copy link
Member Author

Choose a reason for hiding this comment

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

Whitespace/auto-formatting

@kderusso kderusso mentioned this pull request Feb 20, 2025
Closed
@kderusso
Copy link
Member Author

I have created a followup request to update Markdown docs: elastic/docs-content#541

@github-actions GitHub Actions
Copy link
Contributor

Warning

It looks like this PR modifies one or more .asciidoc files. These files are being migrated to Markdown, and any changes merged now will be lost. See the migration guide for details.

@kderusso kderusso marked this pull request as ready for review February 20, 2025 18:43
@kderusso kderusso requested a review from a team February 20, 2025 18:43
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/search-eng (Team:SearchOrg)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/search-relevance (Team:Search - Relevance)

@github-actions GitHub Actions
Copy link
Contributor

Warning

It looks like this PR modifies one or more .asciidoc files. These files are being migrated to Markdown, and any changes merged now will be lost. See the migration guide for details.

@github-actions GitHub Actions
Copy link
Contributor

Warning

It looks like this PR modifies one or more .asciidoc files. These files are being migrated to Markdown, and any changes merged now will be lost. See the migration guide for details.

@pquentin pquentin mentioned this pull request Feb 21, 2025
Merged
@efegurkan @leemthompo
Update docs formatting
ee45a5d 
Co-authored-by: Liam Thompson <[email protected]>
@github-actions GitHub Actions
Copy link
Contributor

Warning

It looks like this PR modifies one or more .asciidoc files. These files are being migrated to Markdown, and any changes merged now will be lost. See the migration guide for details.

@github-actions GitHub Actions
Copy link
Contributor

Warning

It looks like this PR modifies one or more .asciidoc files. These files are being migrated to Markdown, and any changes merged now will be lost. See the migration guide for details.

@github-actions GitHub Actions
Copy link
Contributor

Warning

It looks like this PR modifies one or more .asciidoc files. These files are being migrated to Markdown, and any changes merged now will be lost. See the migration guide for details.

ioanatia
ioanatia approved these changes Feb 25, 2025
View reviewed changes
Copy link
Contributor

@ioanatia ioanatia left a comment

Choose a reason for hiding this comment

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

Looks good - I am not sure what to do about the docs migration warning.
@leemthompo we should be good to merge, can you please check the PR?

there is another thing we should add - the UpdateForV10 annotation.
See example:

elasticsearch/x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/ilm/FreezeAction.java

Lines 27 to 29 in e843849

@Deprecated
@UpdateForV10(owner = UpdateForV10.Owner.DATA_MANAGEMENT)
public class FreezeAction implements LifecycleAction {

but I am okay at adding this in a follow up, there might be other things we need to annotate in the ent-search plugin.

@efegurkan efegurkan merged commit ae6474d into elastic:main Feb 25, 2025
16 of 17 checks passed
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
✅ 9.0

@kderusso kderusso mentioned this pull request Feb 25, 2025
Merged
kderusso added a commit to kderusso/elasticsearch that referenced this pull request Feb 25, 2025
@kderusso @efegurkan @leemthompo
Deprecate Behavioral Analytics CRUD apis (elastic#122960)
0a72912 
* Deprecate Behavioral Analytics CRUD APIs

* Add allowed warning for REST Compatibility tests

* Update docs/changelog/122960.yaml

* Update changelog

* Update docs to add deprecation flags and fix failing tests

* Update changelog

* Update changelog again

* Update docs formatting

Co-authored-by: Liam Thompson <[email protected]>

* Skip asciidoc test

---------

Co-authored-by: Efe Gürkan YALAMAN <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Efe Gürkan YALAMAN <[email protected]>
elasticsearchmachine pushed a commit that referenced this pull request Feb 25, 2025
@kderusso @efegurkan @leemthompo
Deprecate Behavioral Analytics CRUD apis (#122960) (#123383)
c260308 
* Deprecate Behavioral Analytics CRUD APIs

* Add allowed warning for REST Compatibility tests

* Update docs/changelog/122960.yaml

* Update changelog

* Update docs to add deprecation flags and fix failing tests

* Update changelog

* Update changelog again

* Update docs formatting



* Skip asciidoc test

---------

Co-authored-by: Efe Gürkan YALAMAN <[email protected]>
Co-authored-by: Liam Thompson <[email protected]>
Co-authored-by: Efe Gürkan YALAMAN <[email protected]>
@efegurkan efegurkan mentioned this pull request Feb 25, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@efegurkan efegurkan efegurkan left review comments

@ioanatia ioanatia ioanatia approved these changes

@leemthompo leemthompo leemthompo approved these changes

Assignees

No one assigned

Labels

auto-backport Automatically create backport pull requests when merged >deprecation :SearchOrg/Relevance Label for the Search (solution/org) Relevance team v9.0.0 v9.1.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@kderusso @elasticsearchmachine @efegurkan @ioanatia @leemthompo