[9.0] Deprecate Behavioral Analytics CRUD apis (#122960)

docs/changelog/122960.yaml

@@ -0,0 +1,10 @@
+pr: 122960
+summary: Deprecate Behavioral Analytics CRUD apis
+area: Search
+type: deprecation
+issues: [ ]
+deprecation:
+  title: Deprecate Behavioral Analytics CRUD apis
+  area: Search
+  details: Behavioral Analytics has been deprecated as of 9.0.0 and will be removed in a future release. The APIs will still work for now, but will emit warning headers that the API has been deprecated.
+  impact: Behavioral Analytics has been deprecated as of 9.0.0 and will be removed in a future release.

docs/reference/behavioral-analytics/apis/delete-analytics-collection.asciidoc

@@ -2,6 +2,7 @@
 [[delete-analytics-collection]]
 === Delete Analytics Collection
 
+deprecated:[9.0.0]
 beta::[]
 
 ++++
@@ -14,15 +15,6 @@ beta::[]
 For the most up-to-date API details, refer to {api-es}/group/endpoint-analytics[Behavioral analytics APIs].
 --
 
-////
-[source,console]
-----
-PUT _application/analytics/my_analytics_collection
-----
-// TESTSETUP
-
-////
-
 Removes a <<behavioral-analytics-overview,Behavioral Analytics>> Collection and its associated data stream.
 
 [[delete-analytics-collection-request]]
@@ -59,3 +51,4 @@ The following example deletes the Analytics Collection named `my_analytics_colle
 ----
 DELETE _application/analytics/my_analytics_collection/
 ----
+// TEST[skip:Behavioral Analytics APIs emit deprecation warnings and will not be updated]

docs/reference/behavioral-analytics/apis/index.asciidoc

@@ -1,6 +1,7 @@
 [[behavioral-analytics-apis]]
 == Behavioral Analytics APIs
 
+deprecated:[9.0.0]
 beta::[]
 
 ++++

docs/reference/behavioral-analytics/apis/list-analytics-collection.asciidoc

@@ -2,6 +2,7 @@
 [[list-analytics-collection]]
 === List Analytics Collections
 
+deprecated:[9.0.0]
 beta::[]
 
 ++++
@@ -14,22 +15,6 @@ beta::[]
 For the most up-to-date API details, refer to {api-es}/group/endpoint-analytics[Behavioral analytics APIs].
 --
 
-////
-[source,console]
-----
-PUT _application/analytics/my_analytics_collection
-PUT _application/analytics/my_analytics_collection2
-----
-// TESTSETUP
-
-[source,console]
-----
-DELETE _application/analytics/my_analytics_collection
-DELETE _application/analytics/my_analytics_collection2
-----
-// TEARDOWN
-////
-
 Returns information about <<behavioral-analytics-overview,Behavioral Analytics>> Collections.
 
 [[list-analytics-collection-request]]
@@ -46,8 +31,9 @@ Requires the `manage_behavioral_analytics` cluster privilege.
 ==== {api-path-parms-title}
 
 `<criteria>`::
-(optional, string)
-Criteria is used to find a matching analytics collection. This could be the name of the collection or a pattern to match multiple. If not specified, will return all analytics collections.
+(optional, string) Criteria is used to find a matching analytics collection.
+This could be the name of the collection or a pattern to match multiple.
+If not specified, will return all analytics collections.
 
 [[list-analytics-collection-response-codes]]
 ==== {api-response-codes-title}
@@ -66,6 +52,7 @@ The following example lists all configured Analytics Collections:
 ----
 GET _application/analytics/
 ----
+// TEST[skip:Behavioral Analytics APIs emit deprecation warnings and will not be updated]
 
 A sample response:
 
@@ -91,6 +78,7 @@ The following example returns the Analytics Collection that matches `my_analytic
 ----
 GET _application/analytics/my_analytics_collection
 ----
+// TEST[skip:Behavioral Analytics APIs emit deprecation warnings and will not be updated]
 
 A sample response:
 
@@ -111,6 +99,7 @@ The following example returns all Analytics Collections prefixed with `my`:
 ----
 GET _application/analytics/my*
 ----
+// TEST[skip:Behavioral Analytics APIs emit deprecation warnings and will not be updated]
 
 A sample response:
 

docs/reference/behavioral-analytics/apis/post-analytics-collection-event.asciidoc

@@ -2,6 +2,7 @@
 [[post-analytics-collection-event]]
 === Post Event to an Analytics Collection
 
+deprecated:[9.0.0]
 beta::[]
 
 ++++
@@ -14,20 +15,6 @@ beta::[]
 For the most up-to-date API details, refer to {api-es}/group/endpoint-analytics[Behavioral analytics APIs].
 --
 
-////
-[source,console]
-----
-PUT _application/analytics/my_analytics_collection
-----
-// TESTSETUP
-
-[source,console]
-----
-DELETE _application/analytics/my_analytics_collection
-----
-// TEARDOWN
-////
-
 Post an event to a <<behavioral-analytics-overview,Behavioral Analytics>> Collection.
 
 [[post-analytics-collection-event-request]]
@@ -105,3 +92,4 @@ POST _application/analytics/my_analytics_collection/event/search_click
   }
 }
 ----
+// TEST[skip:Behavioral Analytics APIs emit deprecation warnings and will not be updated]

docs/reference/behavioral-analytics/apis/put-analytics-collection.asciidoc

@@ -2,6 +2,7 @@
 [[put-analytics-collection]]
 === Put Analytics Collection
 
+deprecated:[9.0.0]
 beta::[]
 
 ++++
@@ -14,14 +15,6 @@ beta::[]
 For the most up-to-date API details, refer to {api-es}/group/endpoint-analytics[Behavioral analytics APIs].
 --
 
-////
-[source,console]
-----
-DELETE _application/analytics/my_analytics_collection
-----
-// TEARDOWN
-////
-
 Creates a <<behavioral-analytics-overview,Behavioral Analytics>> Collection.
 
 [[put-analytics-collection-request]]
@@ -55,3 +48,4 @@ The following example creates a new Analytics Collection called `my_analytics_co
 ----
 PUT _application/analytics/my_analytics_collection
 ----
+// TEST[skip:Behavioral Analytics APIs emit deprecation warnings and will not be updated]

docs/reference/search/search-your-data/behavioral-analytics/behavioral-analytics-api.asciidoc

@@ -1,9 +1,12 @@
 [[behavioral-analytics-api]]
 === Behavioral Analytics API overview
+
 ++++
 <titleabbrev>API overview</titleabbrev>
 ++++
 
+deprecated:[9.0.0]
+
 This page outlines all the APIs available for behavioral analytics and links to their documentation.
 
 [discrete]

docs/reference/search/search-your-data/behavioral-analytics/behavioral-analytics-cors.asciidoc

@@ -4,6 +4,8 @@
 <titleabbrev>Set up CORs</titleabbrev>
 ++++
 
+deprecated:[9.0.0]
+
 Behavioral Analytics sends events directly to the {es} API.
 This means that the browser makes requests to the {es} API directly.
 {es} supports https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS[Cross-Origin Resource Sharing (CORS)^], but this feature is disabled by default.
@@ -43,4 +45,4 @@ On Elastic Cloud, you can do this by {cloud}/ec-add-user-settings.html#ec-add-us
 ==== Proxy the request through a server that supports CORS
 
 If you are unable to enable CORS on {es}, you can proxy the request through a server that supports CORS.
-This is more complicated, but is a viable option.
+This is more complicated, but is a viable option.

docs/reference/search/search-your-data/behavioral-analytics/behavioral-analytics-event-reference.asciidoc

@@ -4,6 +4,8 @@
 <titleabbrev>Events reference</titleabbrev>
 ++++
 
+deprecated:[9.0.0]
+
 Behavioral Analytics logs events using the {ecs-ref}/ecs-reference.html[Elastic Common Schema^], including a custom field set for analytics events.
 Refer to <<behavioral-analytics-event-reference-examples,examples>> of the full data objects that are logged.
 

docs/reference/search/search-your-data/behavioral-analytics/behavioral-analytics-event.asciidoc

@@ -4,6 +4,8 @@
 <titleabbrev>View events</titleabbrev>
 ++++
 
+deprecated:[9.0.0]
+
 [TIP]
 ====
 Refer to <<behavioral-analytics-event-reference>> for a complete list of the fields logged by events.

docs/reference/search/search-your-data/behavioral-analytics/behavioral-analytics-overview.asciidoc

@@ -1,6 +1,9 @@
 [[behavioral-analytics-overview]]
 == Search analytics
 
+deprecated:[9.0.0]
+
+
 Behavioral Analytics is an analytics event collection platform.
 Use these tools to analyze your users' searching and clicking behavior.
 Leverage this information to improve the relevance of your search results and identify gaps in your content.

docs/reference/search/search-your-data/behavioral-analytics/behavioral-analytics-start.asciidoc

@@ -4,6 +4,8 @@
 <titleabbrev>Get started</titleabbrev>
 ++++
 
+deprecated:[9.0.0]
+
 You can manage your analytics in the {kib} UI.
 Go to *Search > Behavioral Analytics* to get started.
 

rest-api-spec/src/main/resources/rest-api-spec/api/search_application.delete_behavioral_analytics.json

@@ -6,6 +6,10 @@
     },
     "stability": "experimental",
     "visibility": "public",
+    "deprecated": {
+      "version": "9.0.0",
+      "description": "Behavioral Analytics has been deprecated and will be removed in a future release."
+    },
     "headers": {
       "accept": [
         "application/json"

rest-api-spec/src/main/resources/rest-api-spec/api/search_application.get_behavioral_analytics.json

@@ -6,6 +6,10 @@
     },
     "stability": "experimental",
     "visibility": "public",
+    "deprecated": {
+      "version": "9.0.0",
+      "description": "Behavioral Analytics has been deprecated and will be removed in a future release."
+    },
     "headers": {
       "accept": [
         "application/json"
@@ -24,10 +28,10 @@
           "methods": [
             "GET"
           ],
-          "parts":{
-            "name":{
-              "type":"list",
-              "description":"A comma-separated list of analytics collections to limit the returned information"
+          "parts": {
+            "name": {
+              "type": "list",
+              "description": "A comma-separated list of analytics collections to limit the returned information"
             }
           }
         }

rest-api-spec/src/main/resources/rest-api-spec/api/search_application.post_behavioral_analytics_event.json

@@ -6,6 +6,10 @@
     },
     "stability": "experimental",
     "visibility": "public",
+    "deprecated": {
+      "version": "9.0.0",
+      "description": "Behavioral Analytics has been deprecated and will be removed in a future release."
+    },
     "headers": {
       "accept": [
         "application/json"

rest-api-spec/src/main/resources/rest-api-spec/api/search_application.put_behavioral_analytics.json

@@ -5,6 +5,10 @@
       "description": "Creates a behavioral analytics collection."
     },
     "stability": "experimental",
+    "deprecated": {
+      "version": "9.0.0",
+      "description": "Behavioral Analytics has been deprecated and will be removed in a future release."
+    },
     "visibility": "public",
     "headers": {
       "accept": [

x-pack/plugin/ent-search/qa/rest/build.gradle

@@ -37,3 +37,11 @@ testClusters.configureEach {
 artifacts {
   restXpackTests(new File(projectDir, "src/yamlRestTest/resources/rest-api-spec/test"))
 }
+
+
+tasks.named("yamlRestCompatTestTransform").configure(
+  { task ->
+    // Behavioral Analytics is deprecated with 9.0.0.
+    task.addAllowedWarning("Behavioral Analytics is deprecated and will be removed in a future release.")
+  }
+)

x-pack/plugin/ent-search/qa/rest/src/yamlRestTest/resources/rest-api-spec/test/entsearch/20_usage.yml

@@ -27,6 +27,8 @@ teardown:
 
 ---
 "xpack usage includes Enterprise Search":
+  - requires:
+      test_runner_features: [ allowed_warnings ]
 
   - do:
       xpack.usage: { }
@@ -79,6 +81,8 @@ teardown:
                     query: "{{query_string}}"
 
   - do:
+      allowed_warnings:
+        - "Behavioral Analytics is deprecated and will be removed in a future release."
       search_application.put_behavioral_analytics:
         name: test-analytics-collection
 
@@ -113,6 +117,8 @@ teardown:
   }
 
   - do:
+      allowed_warnings:
+        - "Behavioral Analytics is deprecated and will be removed in a future release."
       search_application.delete_behavioral_analytics:
         name: test-analytics-collection