From a87cdc33a97e778de8bf5640d59b50ad40c35d76 Mon Sep 17 00:00:00 2001 From: Christopher Hawke Date: Thu, 10 Jul 2025 13:19:15 -0400 Subject: [PATCH 1/3] fix(spec): abtest v3 naming conflict with Metric type --- specs/abtesting-v3/common/schemas/Variant.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specs/abtesting-v3/common/schemas/Variant.yml b/specs/abtesting-v3/common/schemas/Variant.yml index d7c69e7ebed..2d89dc532bb 100644 --- a/specs/abtesting-v3/common/schemas/Variant.yml +++ b/specs/abtesting-v3/common/schemas/Variant.yml @@ -40,9 +40,9 @@ metrics: type: array description: All ABTest metrics that were defined during test creation. items: - $ref: '#/metric' + $ref: '#/metricResult' -metric: +metricResult: type: object properties: name: From 62f9e184d079cd3a0235705c3875bd1d4dc85004 Mon Sep 17 00:00:00 2001 From: Christopher Hawke Date: Thu, 10 Jul 2025 13:38:53 -0400 Subject: [PATCH 2/3] fix: metric name in timeseries --- specs/abtesting-v3/common/schemas/Timeseries.yml | 2 +- specs/abtesting-v3/paths/timeseries.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specs/abtesting-v3/common/schemas/Timeseries.yml b/specs/abtesting-v3/common/schemas/Timeseries.yml index 377e10abcbf..7707c40d6af 100644 --- a/specs/abtesting-v3/common/schemas/Timeseries.yml +++ b/specs/abtesting-v3/common/schemas/Timeseries.yml @@ -42,7 +42,7 @@ metricDate: metrics: $ref: 'Variant.yml#/metrics' -Metric: +MetricName: type: string enum: - search_count diff --git a/specs/abtesting-v3/paths/timeseries.yml b/specs/abtesting-v3/paths/timeseries.yml index de530f062fd..cfd5945b7e9 100644 --- a/specs/abtesting-v3/paths/timeseries.yml +++ b/specs/abtesting-v3/paths/timeseries.yml @@ -16,7 +16,7 @@ get: schema: type: array items: - $ref: '../common/schemas/Timeseries.yml#/Metric' + $ref: '../common/schemas/Timeseries.yml#/MetricName' responses: '200': description: OK From 163c50b37c7ce41d04d7cbacf28700aa48db36c2 Mon Sep 17 00:00:00 2001 From: Christopher Hawke Date: Thu, 10 Jul 2025 15:10:25 -0400 Subject: [PATCH 3/3] feat: reduce confusion further --- specs/abtesting-v3/common/parameters.yml | 2 +- specs/abtesting-v3/paths/abtests.yml | 4 ++-- specs/abtesting-v3/paths/scheduleABTest.yml | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specs/abtesting-v3/common/parameters.yml b/specs/abtesting-v3/common/parameters.yml index e88c606ebf5..8fd88185351 100644 --- a/specs/abtesting-v3/common/parameters.yml +++ b/specs/abtesting-v3/common/parameters.yml @@ -138,7 +138,7 @@ filterEffects: description: Number of tracked searches removed from the A/B test. example: 237 -metric: +createMetric: type: object description: Defines a metric to be retrieved during an A/B test. properties: diff --git a/specs/abtesting-v3/paths/abtests.yml b/specs/abtesting-v3/paths/abtests.yml index e31ce03e6c1..51a698e25d0 100644 --- a/specs/abtesting-v3/paths/abtests.yml +++ b/specs/abtesting-v3/paths/abtests.yml @@ -25,9 +25,9 @@ post: $ref: '../common/schemas/AddABTestsVariant.yml#/AddABTestsVariant' metrics: type: array - description: A/B test metrics involved in the test. Only these metrics will be considered when calculating results. + description: A/B test metrics involved in the test. Only these metrics will be considered when calculating results. items: - $ref: '../common/parameters.yml#/metric' + $ref: '../common/parameters.yml#/createMetric' configuration: $ref: '../common/schemas/ABTest.yml#/ABTestConfiguration' endAt: diff --git a/specs/abtesting-v3/paths/scheduleABTest.yml b/specs/abtesting-v3/paths/scheduleABTest.yml index c8d4f2d4865..4b6bc647708 100644 --- a/specs/abtesting-v3/paths/scheduleABTest.yml +++ b/specs/abtesting-v3/paths/scheduleABTest.yml @@ -28,7 +28,7 @@ post: type: array description: A/B test metrics involved in the test. Only these metrics will be considered when calculating results. items: - $ref: '../common/parameters.yml#/metric' + $ref: '../common/parameters.yml#/createMetric' configuration: $ref: '../common/schemas/ABTest.yml#/ABTestConfiguration' scheduledAt: