Skip to content

Commit 80dff95

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Remove meta from RUM retention filters APIs (#2286)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 765fb41 commit 80dff95

17 files changed

+45
-241
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2025-03-11 13:16:50.144910",
8-
"spec_repo_commit": "d7618fa5"
7+
"regenerated": "2025-03-11 16:30:31.555356",
8+
"spec_repo_commit": "baf04a80"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-03-11 13:16:50.165212",
13-
"spec_repo_commit": "d7618fa5"
12+
"regenerated": "2025-03-11 16:30:31.570839",
13+
"spec_repo_commit": "baf04a80"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 13 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -684,7 +684,7 @@ components:
684684
schema:
685685
type: string
686686
RumApplicationIDParameter:
687-
description: Application ID.
687+
description: RUM application ID.
688688
in: path
689689
name: app_id
690690
required: true
@@ -25518,8 +25518,6 @@ components:
2551825518
properties:
2551925519
attributes:
2552025520
$ref: '#/components/schemas/RumRetentionFilterCreateAttributes'
25521-
meta:
25522-
$ref: '#/components/schemas/RumRetentionFilterMeta'
2552325521
type:
2552425522
$ref: '#/components/schemas/RumRetentionFilterType'
2552525523
required:
@@ -25541,8 +25539,6 @@ components:
2554125539
$ref: '#/components/schemas/RumRetentionFilterAttributes'
2554225540
id:
2554325541
$ref: '#/components/schemas/RumRetentionFilterID'
25544-
meta:
25545-
$ref: '#/components/schemas/RumRetentionFilterMeta'
2554625542
type:
2554725543
$ref: '#/components/schemas/RumRetentionFilterType'
2554825544
type: object
@@ -25574,12 +25570,6 @@ components:
2557425570
description: ID of retention filter in UUID.
2557525571
example: 051601eb-54a0-abc0-03f9-cc02efa18892
2557625572
type: string
25577-
RumRetentionFilterMeta:
25578-
description: The object describing metadata of a RUM retention filter.
25579-
properties:
25580-
source:
25581-
$ref: '#/components/schemas/RumRetentionFilterSource'
25582-
type: object
2558325573
RumRetentionFilterQuery:
2558425574
description: The query string for a RUM retention filter.
2558525575
example: '@session.has_replay:true'
@@ -25597,20 +25587,6 @@ components:
2559725587
maximum: 100
2559825588
minimum: 0
2559925589
type: integer
25600-
RumRetentionFilterSource:
25601-
description: The type of RUM events to filter on.
25602-
enum:
25603-
- ui
25604-
- terraform
25605-
- default
25606-
- unknown
25607-
example: terraform
25608-
type: string
25609-
x-enum-varnames:
25610-
- UI
25611-
- TERRAFORM
25612-
- DEFAULT
25613-
- UNKNOWN
2561425590
RumRetentionFilterType:
2561525591
default: retention_filters
2561625592
description: The type of the resource. The value should always be retention_filters.
@@ -25641,8 +25617,6 @@ components:
2564125617
$ref: '#/components/schemas/RumRetentionFilterUpdateAttributes'
2564225618
id:
2564325619
$ref: '#/components/schemas/RumRetentionFilterID'
25644-
meta:
25645-
$ref: '#/components/schemas/RumRetentionFilterMeta'
2564625620
type:
2564725621
$ref: '#/components/schemas/RumRetentionFilterType'
2564825622
required:
@@ -25673,7 +25647,8 @@ components:
2567325647
description: 'The list of RUM retention filter IDs along with their corresponding
2567425648
type to reorder.
2567525649

25676-
All retention filter IDs should be included in the list created for an application.'
25650+
All retention filter IDs should be included in the list created for a RUM
25651+
application.'
2567725652
properties:
2567825653
data:
2567925654
description: A list of RUM retention filter IDs along with type.
@@ -25691,7 +25666,7 @@ components:
2569125666
type: array
2569225667
type: object
2569325668
RumRetentionFiltersResponse:
25694-
description: All RUM retention filters for an application.
25669+
description: All RUM retention filters for a RUM application.
2569525670
properties:
2569625671
data:
2569725672
description: A list of RUM retention filters.
@@ -46244,10 +46219,10 @@ paths:
4624446219
- rum_apps_write
4624546220
/api/v2/rum/applications/{app_id}/relationships/retention_filters:
4624646221
patch:
46247-
description: 'Order RUM retention filters for an application.
46222+
description: 'Order RUM retention filters for a RUM application.
4624846223

46249-
Returns RUM retention filter objects without attributes and meta from the
46250-
request body when the request is successful.'
46224+
Returns RUM retention filter objects without attributes from the request body
46225+
when the request is successful.'
4625146226
operationId: OrderRetentionFilters
4625246227
parameters:
4625346228
- $ref: '#/components/parameters/RumApplicationIDParameter'
@@ -46277,7 +46252,7 @@ paths:
4627746252
x-codegen-request-body-name: body
4627846253
/api/v2/rum/applications/{app_id}/retention_filters:
4627946254
get:
46280-
description: Get the list of RUM retention filters for an application.
46255+
description: Get the list of RUM retention filters for a RUM application.
4628146256
operationId: ListRetentionFilters
4628246257
parameters:
4628346258
- $ref: '#/components/parameters/RumApplicationIDParameter'
@@ -46296,7 +46271,7 @@ paths:
4629646271
tags:
4629746272
- Rum Retention Filters
4629846273
post:
46299-
description: 'Create a RUM retention filter for an application.
46274+
description: 'Create a RUM retention filter for a RUM application.
4630046275

4630146276
Returns RUM retention filter objects from the request body when the request
4630246277
is successful.'
@@ -46329,7 +46304,7 @@ paths:
4632946304
x-codegen-request-body-name: body
4633046305
/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}:
4633146306
delete:
46332-
description: Delete a RUM retention filter for an application.
46307+
description: Delete a RUM retention filter for a RUM application.
4633346308
operationId: DeleteRetentionFilter
4633446309
parameters:
4633546310
- $ref: '#/components/parameters/RumApplicationIDParameter'
@@ -46347,7 +46322,7 @@ paths:
4634746322
tags:
4634846323
- Rum Retention Filters
4634946324
get:
46350-
description: Get a RUM retention filter for an application.
46325+
description: Get a RUM retention filter for a RUM application.
4635146326
operationId: GetRetentionFilter
4635246327
parameters:
4635346328
- $ref: '#/components/parameters/RumApplicationIDParameter'
@@ -46369,7 +46344,7 @@ paths:
4636946344
tags:
4637046345
- Rum Retention Filters
4637146346
patch:
46372-
description: 'Update a RUM retention filter for an application.
46347+
description: 'Update a RUM retention filter for a RUM application.
4637346348

4637446349
Returns RUM retention filter objects from the request body when the request
4637546350
is successful.'
@@ -53819,7 +53794,7 @@ tags:
5381953794
url: https://docs.datadoghq.com/real_user_monitoring/platform/generate_metrics/
5382053795
name: Rum Metrics
5382153796
- description: Manage retention filters through [Manage Applications](https://app.datadoghq.com/rum/list)
53822-
for your organization.
53797+
of RUM for your organization.
5382353798
name: Rum Retention Filters
5382453799
- description: Create and manage your security rules, signals, filters, and more.
5382553800
See the [Datadog Security page](https://docs.datadoghq.com/security/) for more

cassettes/features/v2/rum_retention_filters/Create-a-RUM-retention-filter-returns-Created-response.yml

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cassettes/features/v2/rum_retention_filters/Get-a-RUM-retention-filter-returns-OK-response.yml

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cassettes/features/v2/rum_retention_filters/Get-all-RUM-retention-filters-returns-OK-response.yml

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

cassettes/features/v2/rum_retention_filters/Update-a-RUM-retention-filter-returns-Updated-response.yml

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/v2/rum-retention-filters/CreateRetentionFilter.rb

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,6 @@
1313
sample_rate: 50,
1414
enabled: true,
1515
}),
16-
meta: DatadogAPIClient::V2::RumRetentionFilterMeta.new({
17-
source: DatadogAPIClient::V2::RumRetentionFilterSource::TERRAFORM,
18-
}),
1916
}),
2017
})
2118
p api_instance.create_retention_filter("a33671aa-24fd-4dcd-ba4b-5bbdbafe7690", body)

features/v2/rum_retention_filters.feature

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
@endpoint(rum-retention-filters) @endpoint(rum-retention-filters-v2)
22
Feature: Rum Retention Filters
33
Manage retention filters through [Manage
4-
Applications](https://app.datadoghq.com/rum/list) for your organization.
4+
Applications](https://app.datadoghq.com/rum/list) of RUM for your
5+
organization.
56

67
Background:
78
Given a valid "apiKeyAuth" key in the system
@@ -20,7 +21,7 @@ Feature: Rum Retention Filters
2021
Scenario: Create a RUM retention filter returns "Created" response
2122
Given new "CreateRetentionFilter" request
2223
And request contains "app_id" parameter with value "a33671aa-24fd-4dcd-ba4b-5bbdbafe7690"
23-
And body with value {"data":{"type":"retention_filters","attributes":{"name":"Test creating retention filter","event_type":"session","query":"custom_query","sample_rate":50,"enabled":true},"meta":{"source":"terraform"}}}
24+
And body with value {"data":{"type":"retention_filters","attributes":{"name":"Test creating retention filter","event_type":"session","query":"custom_query","sample_rate":50,"enabled":true}}}
2425
When the request is sent
2526
Then the response status is 201 Created
2627
And the response "data.type" is equal to "retention_filters"
@@ -29,7 +30,6 @@ Feature: Rum Retention Filters
2930
And the response "data.attributes.enabled" is equal to true
3031
And the response "data.attributes.query" is equal to "custom_query"
3132
And the response "data.attributes.sample_rate" is equal to 50
32-
And the response "data.meta.source" is equal to "terraform"
3333

3434
@replay-only @team:DataDog/rum-backend
3535
Scenario: Delete a RUM retention filter returns "No Content" response
@@ -69,7 +69,6 @@ Feature: Rum Retention Filters
6969
And the response "data.attributes.enabled" is equal to true
7070
And the response "data.attributes.query" is equal to "custom_query"
7171
And the response "data.attributes.sample_rate" is equal to 25
72-
And the response "data.meta.source" is equal to "terraform"
7372

7473
@replay-only @team:DataDog/rum-backend
7574
Scenario: Get all RUM retention filters returns "OK" response
@@ -131,4 +130,3 @@ Feature: Rum Retention Filters
131130
And the response "data.attributes.enabled" is equal to true
132131
And the response "data.attributes.query" is equal to "view_query"
133132
And the response "data.attributes.sample_rate" is equal to 100
134-
And the response "data.meta.source" is equal to "unknown"

lib/datadog_api_client/inflector.rb

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2513,12 +2513,10 @@ def overrides
25132513
"v2.rum_retention_filter_create_request" => "RumRetentionFilterCreateRequest",
25142514
"v2.rum_retention_filter_data" => "RumRetentionFilterData",
25152515
"v2.rum_retention_filter_event_type" => "RumRetentionFilterEventType",
2516-
"v2.rum_retention_filter_meta" => "RumRetentionFilterMeta",
25172516
"v2.rum_retention_filter_response" => "RumRetentionFilterResponse",
25182517
"v2.rum_retention_filters_order_data" => "RumRetentionFiltersOrderData",
25192518
"v2.rum_retention_filters_order_request" => "RumRetentionFiltersOrderRequest",
25202519
"v2.rum_retention_filters_order_response" => "RumRetentionFiltersOrderResponse",
2521-
"v2.rum_retention_filter_source" => "RumRetentionFilterSource",
25222520
"v2.rum_retention_filters_response" => "RumRetentionFiltersResponse",
25232521
"v2.rum_retention_filter_type" => "RumRetentionFilterType",
25242522
"v2.rum_retention_filter_update_attributes" => "RumRetentionFilterUpdateAttributes",

lib/datadog_api_client/v2/api/rum_retention_filters_api.rb

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ def create_retention_filter(app_id, body, opts = {})
3333

3434
# Create a RUM retention filter.
3535
#
36-
# Create a RUM retention filter for an application.
36+
# Create a RUM retention filter for a RUM application.
3737
# Returns RUM retention filter objects from the request body when the request is successful.
3838
#
39-
# @param app_id [String] Application ID.
39+
# @param app_id [String] RUM application ID.
4040
# @param body [RumRetentionFilterCreateRequest] The definition of the new RUM retention filter.
4141
# @param opts [Hash] the optional parameters
4242
# @return [Array<(RumRetentionFilterResponse, Integer, Hash)>] RumRetentionFilterResponse data, response status code and response headers
@@ -106,9 +106,9 @@ def delete_retention_filter(app_id, rf_id, opts = {})
106106

107107
# Delete a RUM retention filter.
108108
#
109-
# Delete a RUM retention filter for an application.
109+
# Delete a RUM retention filter for a RUM application.
110110
#
111-
# @param app_id [String] Application ID.
111+
# @param app_id [String] RUM application ID.
112112
# @param rf_id [String] Retention filter ID.
113113
# @param opts [Hash] the optional parameters
114114
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -176,9 +176,9 @@ def get_retention_filter(app_id, rf_id, opts = {})
176176

177177
# Get a RUM retention filter.
178178
#
179-
# Get a RUM retention filter for an application.
179+
# Get a RUM retention filter for a RUM application.
180180
#
181-
# @param app_id [String] Application ID.
181+
# @param app_id [String] RUM application ID.
182182
# @param rf_id [String] Retention filter ID.
183183
# @param opts [Hash] the optional parameters
184184
# @return [Array<(RumRetentionFilterResponse, Integer, Hash)>] RumRetentionFilterResponse data, response status code and response headers
@@ -246,9 +246,9 @@ def list_retention_filters(app_id, opts = {})
246246

247247
# Get all RUM retention filters.
248248
#
249-
# Get the list of RUM retention filters for an application.
249+
# Get the list of RUM retention filters for a RUM application.
250250
#
251-
# @param app_id [String] Application ID.
251+
# @param app_id [String] RUM application ID.
252252
# @param opts [Hash] the optional parameters
253253
# @return [Array<(RumRetentionFiltersResponse, Integer, Hash)>] RumRetentionFiltersResponse data, response status code and response headers
254254
def list_retention_filters_with_http_info(app_id, opts = {})
@@ -311,10 +311,10 @@ def order_retention_filters(app_id, body, opts = {})
311311

312312
# Order RUM retention filters.
313313
#
314-
# Order RUM retention filters for an application.
315-
# Returns RUM retention filter objects without attributes and meta from the request body when the request is successful.
314+
# Order RUM retention filters for a RUM application.
315+
# Returns RUM retention filter objects without attributes from the request body when the request is successful.
316316
#
317-
# @param app_id [String] Application ID.
317+
# @param app_id [String] RUM application ID.
318318
# @param body [RumRetentionFiltersOrderRequest] New definition of the RUM retention filter.
319319
# @param opts [Hash] the optional parameters
320320
# @return [Array<(RumRetentionFiltersOrderResponse, Integer, Hash)>] RumRetentionFiltersOrderResponse data, response status code and response headers
@@ -384,10 +384,10 @@ def update_retention_filter(app_id, rf_id, body, opts = {})
384384

385385
# Update a RUM retention filter.
386386
#
387-
# Update a RUM retention filter for an application.
387+
# Update a RUM retention filter for a RUM application.
388388
# Returns RUM retention filter objects from the request body when the request is successful.
389389
#
390-
# @param app_id [String] Application ID.
390+
# @param app_id [String] RUM application ID.
391391
# @param rf_id [String] Retention filter ID.
392392
# @param body [RumRetentionFilterUpdateRequest] New definition of the RUM retention filter.
393393
# @param opts [Hash] the optional parameters

0 commit comments

Comments
 (0)