Skip to content

Commit 712cf0b

Browse files
algolia-botcdhawkeshortcuts
committed
fix(specs): abtest v3 naming conflict with Metric type (#5090) (generated) [skip ci]
Co-authored-by: Christopher Hawke <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
1 parent fe3312f commit 712cf0b

File tree

12 files changed

+82
-35
lines changed

12 files changed

+82
-35
lines changed

‎clients/algoliasearch-client-javascript/packages/abtesting/model/addABTestsRequest.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import type { ABTestConfiguration } from './aBTestConfiguration';
44
import type { AddABTestsVariant } from './addABTestsVariant';
5-
import type { ParametersMetric } from './parametersMetric';
5+
import type { CreateMetric } from './createMetric';
66

77
export type AddABTestsRequest = {
88
/**
@@ -18,7 +18,7 @@ export type AddABTestsRequest = {
1818
/**
1919
* A/B test metrics involved in the test. Only these metrics will be considered when calculating results.
2020
*/
21-
metrics: Array<ParametersMetric>;
21+
metrics: Array<CreateMetric>;
2222

2323
configuration?: ABTestConfiguration | undefined;
2424

‎clients/algoliasearch-client-javascript/packages/abtesting/model/clientMethodProps.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
22

3-
import type { Metric } from '../model/metric';
3+
import type { MetricName } from '../model/metricName';
44

55
/**
66
* Properties for the `customDelete` method.
@@ -105,7 +105,7 @@ export type GetTimeseriesProps = {
105105
/**
106106
* List of metrics to retrieve. If not specified, all metrics are returned.
107107
*/
108-
metric?: Array<Metric> | undefined;
108+
metric?: Array<MetricName> | undefined;
109109
};
110110

111111
/**

‎clients/algoliasearch-client-javascript/packages/abtesting/model/parametersMetric.ts‎ renamed to ‎clients/algoliasearch-client-javascript/packages/abtesting/model/createMetric.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/**
44
* Defines a metric to be retrieved during an A/B test.
55
*/
6-
export type ParametersMetric = {
6+
export type CreateMetric = {
77
/**
88
* Name of the metric.
99
*/

‎clients/algoliasearch-client-javascript/packages/abtesting/model/index.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ export * from './abTestsVariantSearchParams';
88
export * from './addABTestsRequest';
99
export * from './addABTestsVariant';
1010
export * from './clientMethodProps';
11+
export * from './createMetric';
1112
export * from './customSearchParams';
1213
export * from './effectMetric';
1314
export * from './emptySearchFilter';
@@ -18,13 +19,13 @@ export * from './estimateABTestResponse';
1819
export * from './estimateConfiguration';
1920
export * from './filterEffects';
2021
export * from './listABTestsResponse';
21-
export * from './metric';
2222
export * from './metricDate';
2323
export * from './metricMetadata';
24+
export * from './metricName';
25+
export * from './metricResult';
2426
export * from './metricsFilter';
2527
export * from './minimumDetectableEffect';
2628
export * from './outliersFilter';
27-
export * from './parametersMetric';
2829
export * from './scheduleABTestResponse';
2930
export * from './scheduleABTestsRequest';
3031
export * from './status';

‎clients/algoliasearch-client-javascript/packages/abtesting/model/metricDate.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
22

3-
import type { Metric } from './metric';
3+
import type { MetricResult } from './metricResult';
44

55
export type MetricDate = {
66
/**
@@ -11,5 +11,5 @@ export type MetricDate = {
1111
/**
1212
* All ABTest metrics that were defined during test creation.
1313
*/
14-
metrics?: Array<Metric> | undefined;
14+
metrics?: Array<MetricResult> | undefined;
1515
};

‎clients/algoliasearch-client-javascript/packages/abtesting/model/metric.ts‎ renamed to ‎clients/algoliasearch-client-javascript/packages/abtesting/model/metricName.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
22

3-
export type Metric =
3+
export type MetricName =
44
| 'search_count'
55
| 'tracked_search_count'
66
| 'user_count'

‎clients/algoliasearch-client-javascript/packages/abtesting/model/metricResult.ts‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2+
3+
import type { MetricMetadata } from './metricMetadata';
4+
5+
export type MetricResult = {
6+
name: string;
7+
8+
/**
9+
* Date and time when the metric was last updated, in RFC 3339 format.
10+
*/
11+
updatedAt: string;
12+
13+
value: number;
14+
15+
/**
16+
* The upper bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).
17+
*/
18+
valueCIHigh?: number | undefined;
19+
20+
/**
21+
* The lower bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).
22+
*/
23+
valueCILow?: number | undefined;
24+
25+
/**
26+
* PValue for the first variant (control) will always be 0. For the other variants, pValue is calculated for the current variant based on the control.
27+
*/
28+
pValue: number;
29+
30+
/**
31+
* Dimension defined during test creation.
32+
*/
33+
dimension?: string | undefined;
34+
35+
metadata?: MetricMetadata | undefined;
36+
37+
/**
38+
* The value that was computed during error correction. It is used to determine significance of the metric pValue. The critical value is calculated using Bonferroni or Benjamini-Hochberg corrections, based on the given configuration during the A/B test creation.
39+
*/
40+
criticalValue?: number | undefined;
41+
42+
/**
43+
* Whether the pValue is significant or not based on the critical value and the error correction algorithm used.
44+
*/
45+
significant?: boolean | undefined;
46+
};

‎clients/algoliasearch-client-javascript/packages/abtesting/model/scheduleABTestsRequest.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
import type { ABTestConfiguration } from './aBTestConfiguration';
44
import type { AddABTestsVariant } from './addABTestsVariant';
5-
import type { ParametersMetric } from './parametersMetric';
5+
import type { CreateMetric } from './createMetric';
66

77
export type ScheduleABTestsRequest = {
88
/**
@@ -18,7 +18,7 @@ export type ScheduleABTestsRequest = {
1818
/**
1919
* A/B test metrics involved in the test. Only these metrics will be considered when calculating results.
2020
*/
21-
metrics: Array<ParametersMetric>;
21+
metrics: Array<CreateMetric>;
2222

2323
configuration?: ABTestConfiguration | undefined;
2424

‎clients/algoliasearch-client-javascript/packages/abtesting/model/variant.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
22

3-
import type { Metric } from './metric';
3+
import type { MetricResult } from './metricResult';
44
import type { VariantMetadata } from './variantMetadata';
55

66
export type Variant = {
@@ -27,7 +27,7 @@ export type Variant = {
2727
/**
2828
* All ABTest metrics that were defined during test creation.
2929
*/
30-
metrics: Array<Metric>;
30+
metrics: Array<MetricResult>;
3131

3232
metadata?: VariantMetadata | undefined;
3333
};

‎docs/bundled/abtesting-v3.json‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@
245245
"type": "array",
246246
"description": "A/B test metrics involved in the test. Only these metrics will be considered when calculating results.",
247247
"items": {
248-
"$ref": "#/components/schemas/parameters_metric"
248+
"$ref": "#/components/schemas/createMetric"
249249
}
250250
},
251251
"configuration": {
@@ -603,7 +603,7 @@
603603
"type": "array",
604604
"description": "A/B test metrics involved in the test. Only these metrics will be considered when calculating results.",
605605
"items": {
606-
"$ref": "#/components/schemas/parameters_metric"
606+
"$ref": "#/components/schemas/createMetric"
607607
}
608608
},
609609
"configuration": {
@@ -782,7 +782,7 @@
782782
"schema": {
783783
"type": "array",
784784
"items": {
785-
"$ref": "#/components/schemas/Metric"
785+
"$ref": "#/components/schemas/MetricName"
786786
}
787787
}
788788
}
@@ -999,7 +999,7 @@
999999
"winsorizedValue": 888.8
10001000
}
10011001
},
1002-
"metric": {
1002+
"metricResult": {
10031003
"type": "object",
10041004
"properties": {
10051005
"name": {
@@ -1090,7 +1090,7 @@
10901090
"type": "array",
10911091
"description": "All ABTest metrics that were defined during test creation.",
10921092
"items": {
1093-
"$ref": "#/components/schemas/metric"
1093+
"$ref": "#/components/schemas/metricResult"
10941094
}
10951095
},
10961096
"filterEffects": {
@@ -1400,7 +1400,7 @@
14001400
}
14011401
]
14021402
},
1403-
"parameters_metric": {
1403+
"createMetric": {
14041404
"type": "object",
14051405
"description": "Defines a metric to be retrieved during an A/B test.",
14061406
"properties": {
@@ -1501,7 +1501,7 @@
15011501
}
15021502
}
15031503
},
1504-
"Metric": {
1504+
"MetricName": {
15051505
"type": "string",
15061506
"enum": [
15071507
"search_count",

0 commit comments

Comments
 (0)