Skip to content

Commit b4c4109

Browse files
cdhawkeclaude
andauthored
fix(specs): flag analytics patterns endpoints with x-beta (#6954)
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
1 parent 54e8dc4 commit b4c4109

7 files changed

Lines changed: 18 additions & 24 deletions

File tree

โ€Žspecs/analytics/common/schemas/patterns.ymlโ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Schemas for the Beta semantic patterns query framework (/3/patterns/*).
1+
# Schemas for the semantic patterns query framework (/3/patterns/*).
22

33
FieldReference:
44
type: object

โ€Žspecs/analytics/paths/patterns/getPatternsFields.ymlโ€Ž

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@ get:
22
tags:
33
- pattern
44
operationId: getPatternsFields
5+
x-beta: true
56
x-acl: []
67
security: []
7-
summary: (Beta) Retrieve the field catalog
8+
summary: Retrieve the field catalog
89
description: |
9-
**Beta**: this endpoint is under active development and may change without notice.
10-
1110
Returns the static catalog of analytics fields, grouped by domain and usage (metrics, filters,
1211
groups, distributions). No authentication is required. Use it to discover valid `(domain, kind)`
1312
pairs before building the other `/3/patterns/*` queries; two fields are combinable in one query

โ€Žspecs/analytics/paths/patterns/queryPatternsDistribution.ymlโ€Ž

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@ post:
22
tags:
33
- pattern
44
operationId: queryPatternsDistribution
5+
x-beta: true
56
x-acl:
67
- analytics
7-
summary: (Beta) Query a numeric distribution
8+
summary: Query a numeric distribution
89
description: |
9-
**Beta**: this endpoint is under active development and may change without notice.
10-
1110
Buckets one or more numeric fields into histograms and returns an object keyed by `histogram<Field>`,
1211
each mapping a bin label to a count. `distributions` and `parameters` are required; `filters` is
1312
optional. Discover valid field kinds per domain with `/3/patterns/fields`.

โ€Žspecs/analytics/paths/patterns/queryPatternsScalar.ymlโ€Ž

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@ post:
22
tags:
33
- pattern
44
operationId: queryPatternsScalar
5+
x-beta: true
56
x-acl:
67
- analytics
7-
summary: (Beta) Query single-row aggregates
8+
summary: Query single-row aggregates
89
description: |
9-
**Beta**: this endpoint is under active development and may change without notice.
10-
1110
Aggregates the requested `metrics` over the whole period and returns a single object keyed by metric
1211
kind. `metrics` and `parameters` are required; `filters` is optional. Discover valid field kinds per
1312
domain with `/3/patterns/fields`.

โ€Žspecs/analytics/paths/patterns/queryPatternsTable.ymlโ€Ž

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@ post:
22
tags:
33
- pattern
44
operationId: queryPatternsTable
5+
x-beta: true
56
x-acl:
67
- analytics
7-
summary: (Beta) Query a grouped table
8+
summary: Query a grouped table
89
description: |
9-
**Beta**: this endpoint is under active development and may change without notice.
10-
1110
Returns `rows`, each a flat object of the requested fields. `metrics` and `parameters` are required;
1211
`groupBy`, `filters`, and `orderBy` are optional, though `orderBy` is required when `groupBy` is set.
1312
Discover valid field kinds per domain with `/3/patterns/fields`.

โ€Žspecs/analytics/paths/patterns/queryPatternsTimeseries.ymlโ€Ž

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@ post:
22
tags:
33
- pattern
44
operationId: queryPatternsTimeseries
5+
x-beta: true
56
x-acl:
67
- analytics
7-
summary: (Beta) Query a metrics time series
8+
summary: Query a metrics time series
89
description: |
9-
**Beta**: this endpoint is under active development and may change without notice.
10-
1110
Returns one time series per `groupBy` combination, each with period `totals` and a per-day metric
1211
breakdown. `metrics` and `parameters` are required; `groupBy` and `filters` are optional. Discover
1312
valid field kinds per domain with `/3/patterns/fields`.

โ€Žspecs/analytics/spec.ymlโ€Ž

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ info:
5656
5757
The current version of the Analytics API is version 2, indicated by the `/2/` in each endpoint's URL.
5858
59-
A Beta semantic patterns framework is also available under `/3/patterns/*` for building custom
60-
analytics queries. These endpoints are under active development and may change without notice.
59+
A semantic patterns framework is also available under `/3/patterns/*` for building custom
60+
analytics queries.
6161
6262
## Query aggregation
6363
@@ -99,11 +99,10 @@ tags:
9999
description: |
100100
Metrics related to filters.
101101
- name: pattern
102-
x-displayName: Patterns (Beta)
102+
x-displayName: Patterns
103103
description: |
104-
Beta โ€” the semantic patterns query framework (`/3/patterns/*`).
104+
The semantic patterns query framework (`/3/patterns/*`).
105105
Build custom analytics queries from metrics, groupBy, filters, and parameters.
106-
These endpoints are under active development and may change without notice.
107106
- name: revenue
108107
x-displayName: Revenue
109108
description: |
@@ -190,9 +189,9 @@ paths:
190189
/2/status:
191190
$ref: 'paths/status/getStatus.yml'
192191

193-
# ##############################
194-
# ### Patterns (Beta) โ€” /3/ ####
195-
# ##############################
192+
# ######################
193+
# ### Patterns โ€” /3/ ###
194+
# ######################
196195
/3/patterns/fields:
197196
$ref: 'paths/patterns/getPatternsFields.yml'
198197
/3/patterns/timeseries:

0 commit comments

Comments
ย (0)