[Cloud Experiments] Deprecate APIs (#188163)

elastic · Jul 15, 2024 · 166b312 · 166b312
1 parent c5165d9
commit 166b312
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/docs/developer/plugin-list.asciidoc b/docs/developer/plugin-list.asciidoc
@@ -503,7 +503,8 @@ The plugin exposes the static DefaultEditorController class to consume.
 
 
 |{kib-repo}blob/{branch}/x-pack/plugins/cloud_integrations/cloud_experiments/README.mdx[cloudExperiments]
-|The Cloud Experiments Service provides the necessary APIs to implement A/B testing scenarios, fetching the variations in configuration and reporting back metrics to track conversion rates of the experiments.
+|[!WARNING]
+These APIs are deprecated and should not be used as we're working on a replacement Core Feature Flags Service that will arrive soon.
 
 
 |{kib-repo}blob/{branch}/x-pack/plugins/cloud_integrations/cloud_full_story/README.md[cloudFullStory]

diff --git a/x-pack/plugins/cloud_integrations/cloud_experiments/README.mdx b/x-pack/plugins/cloud_integrations/cloud_experiments/README.mdx
@@ -9,6 +9,9 @@ tags: ['kibana', 'dev', 'contributor', 'api docs', 'cloud', 'a/b testing', 'expe
 
 # Kibana Cloud Experiments Service
 
+> [!WARNING]  
+> These APIs are deprecated and should not be used as we're working on a replacement Core Feature Flags Service that will arrive _soon_.
+
 The Cloud Experiments Service provides the necessary APIs to implement A/B testing scenarios, fetching the variations in configuration and reporting back metrics to track conversion rates of the experiments.
 
 The `cloudExperiments` plugin is disabled by default and only enabled on Elastic Cloud deployments.

diff --git a/x-pack/plugins/cloud_integrations/cloud_experiments/common/types.ts b/x-pack/plugins/cloud_integrations/cloud_experiments/common/types.ts
@@ -19,6 +19,7 @@ export type CloudExperimentsFeatureFlagNames = keyof typeof FEATURE_FLAG_NAMES;
  * The contract of the start lifecycle method
  *
  * @public
+ * @deprecated in favor of the upcoming Core Feature Flags Service.
  */
 export interface CloudExperimentsPluginStart {
   /**
@@ -27,6 +28,7 @@ export interface CloudExperimentsPluginStart {
    * @param defaultValue The fallback value in case no variation is found.
    *
    * @public
+   * @deprecated in favor of the upcoming Core Feature Flags Service.
    */
   getVariation: <Data>(
     featureFlagName: CloudExperimentsFeatureFlagNames,
@@ -37,6 +39,7 @@ export interface CloudExperimentsPluginStart {
    * @param metric {@link CloudExperimentsMetric}
    *
    * @public
+   * @deprecated in favor of the upcoming Core Feature Flags Service.
    */
   reportMetric: <Data>(metric: CloudExperimentsMetric<Data>) => void;
 }