github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Cloud Experiments] Deprecate APIs (#188163)

Browse source
This commit is contained in:
Alejandro Fernández Haro 2024-07-15 10:54:32 +02:00 • committed by GitHub
parent c5165d9afe
commit 166b31246f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 8 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/developer/plugin-list.asciidoc
View file

@ -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]

3
x-pack/plugins/cloud_integrations/cloud_experiments/README.mdx
View file

@ -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.

3
x-pack/plugins/cloud_integrations/cloud_experiments/common/types.ts
View file

@ -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;
}