Skip to content

Commit 3178f16

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Remove meta from RUM retention filters APIs (#2098)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 0642c49 commit 3178f16

File tree

18 files changed

+41
-178
lines changed

18 files changed

+41
-178
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.796374",
8-
"spec_repo_commit": "d7618fa5"
7+
"regenerated": "2025-03-11 16:30:30.511689",
8+
"spec_repo_commit": "baf04a80"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-03-11 13:16:50.814243",
13-
"spec_repo_commit": "d7618fa5"
12+
"regenerated": "2025-03-11 16:30:30.529573",
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/v2/Rum-Retention-Filters_3894269930/Create-a-RUM-retention-filter-returns-Created-response_4252932192/recording.har‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
},
99
"entries": [
1010
{
11-
"_id": "beca70c0e9f5eed607cd8cb8d30eccf7",
11+
"_id": "ef418ca45321441edf712149a37ace0e",
1212
"_order": 0,
1313
"cache": {},
1414
"request": {
@@ -32,7 +32,7 @@
3232
"postData": {
3333
"mimeType": "application/json",
3434
"params": [],
35-
"text": "{\"data\":{\"attributes\":{\"enabled\":true,\"event_type\":\"session\",\"name\":\"Test creating retention filter\",\"query\":\"custom_query\",\"sample_rate\":50},\"meta\":{\"source\":\"terraform\"},\"type\":\"retention_filters\"}}"
35+
"text": "{\"data\":{\"attributes\":{\"enabled\":true,\"event_type\":\"session\",\"name\":\"Test creating retention filter\",\"query\":\"custom_query\",\"sample_rate\":50},\"type\":\"retention_filters\"}}"
3636
},
3737
"queryString": [],
3838
"url": "https://api.datadoghq.com/api/v2/rum/applications/a33671aa-24fd-4dcd-ba4b-5bbdbafe7690/retention_filters"
@@ -42,7 +42,7 @@
4242
"content": {
4343
"mimeType": "application/vnd.api+json",
4444
"size": 244,
45-
"text": "{\"data\":{\"id\":\"4b95d361-f65d-4515-9824-c9aaeba5ac2a\",\"type\":\"retention_filters\",\"attributes\":{\"enabled\":true,\"event_type\":\"session\",\"name\":\"Test creating retention filter\",\"query\":\"custom_query\",\"sample_rate\":50},\"meta\":{\"source\":\"terraform\"}}}"
45+
"text": "{\"data\":{\"id\":\"4b95d361-f65d-4515-9824-c9aaeba5ac2a\",\"type\":\"retention_filters\",\"attributes\":{\"enabled\":true,\"event_type\":\"session\",\"name\":\"Test creating retention filter\",\"query\":\"custom_query\",\"sample_rate\":50}}}"
4646
},
4747
"cookies": [],
4848
"headers": [

‎cassettes/v2/Rum-Retention-Filters_3894269930/Get-a-RUM-retention-filter-returns-OK-response_440060318/recording.har‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"content": {
3333
"mimeType": "application/vnd.api+json",
3434
"size": 244,
35-
"text": "{\"data\":{\"id\":\"4b95d361-f65d-4515-9824-c9aaeba5ac2a\",\"type\":\"retention_filters\",\"attributes\":{\"enabled\":true,\"event_type\":\"session\",\"name\":\"Test retention filter for session\",\"query\":\"custom_query\",\"sample_rate\":25},\"meta\":{\"source\":\"terraform\"}}}"
35+
"text": "{\"data\":{\"id\":\"4b95d361-f65d-4515-9824-c9aaeba5ac2a\",\"type\":\"retention_filters\",\"attributes\":{\"enabled\":true,\"event_type\":\"session\",\"name\":\"Test retention filter for session\",\"query\":\"custom_query\",\"sample_rate\":25}}}"
3636
},
3737
"cookies": [],
3838
"headers": [

‎cassettes/v2/Rum-Retention-Filters_3894269930/Get-all-RUM-retention-filters-returns-OK-response_2823626903/recording.har‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"content": {
3333
"mimeType": "application/vnd.api+json",
3434
"size": 664,
35-
"text": "{\"data\":[{\"id\":\"325631eb-94c9-49c0-93f9-ab7e4fd24529\",\"type\":\"retention_filters\",\"attributes\":{\"enabled\":true,\"event_type\":\"session\",\"name\":\"Default session with replay\",\"query\":\"@session.has_replay:true\",\"sample_rate\":100},\"meta\":{\"source\":\"default\"}},{\"id\":\"42d89430-5b80-426e-a44b-ba3b417ece25\",\"type\":\"retention_filters\",\"attributes\":{\"enabled\":true,\"event_type\":\"session\",\"name\":\"Session filter\",\"query\":\"\",\"sample_rate\":25},\"meta\":{\"source\":\"unknown\"}},{\"id\":\"bff0bc34-99e9-4c16-adce-f47e71948c23\",\"type\":\"retention_filters\",\"attributes\":{\"enabled\":true,\"event_type\":\"view\",\"name\":\"Custom filter\",\"query\":\"noquery\",\"sample_rate\":50},\"meta\":{\"source\":\"ui\"}}]}"
35+
"text": "{\"data\":[{\"id\":\"325631eb-94c9-49c0-93f9-ab7e4fd24529\",\"type\":\"retention_filters\",\"attributes\":{\"enabled\":true,\"event_type\":\"session\",\"name\":\"Default session with replay\",\"query\":\"@session.has_replay:true\",\"sample_rate\":100}},{\"id\":\"42d89430-5b80-426e-a44b-ba3b417ece25\",\"type\":\"retention_filters\",\"attributes\":{\"enabled\":true,\"event_type\":\"session\",\"name\":\"Session filter\",\"query\":\"\",\"sample_rate\":25}},{\"id\":\"bff0bc34-99e9-4c16-adce-f47e71948c23\",\"type\":\"retention_filters\",\"attributes\":{\"enabled\":true,\"event_type\":\"view\",\"name\":\"Custom filter\",\"query\":\"noquery\",\"sample_rate\":50}}]}"
3636
},
3737
"cookies": [],
3838
"headers": [

‎cassettes/v2/Rum-Retention-Filters_3894269930/Update-a-RUM-retention-filter-returns-Updated-response_599806346/recording.har‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
"content": {
4343
"mimeType": "application/vnd.api+json",
4444
"size": 238,
45-
"text": "{\"data\":{\"id\":\"4b95d361-f65d-4515-9824-c9aaeba5ac2a\",\"type\":\"retention_filters\",\"attributes\":{\"enabled\":true,\"event_type\":\"view\",\"name\":\"Test updating retention filter\",\"query\":\"view_query\",\"sample_rate\":100},\"meta\":{\"source\":\"unknown\"}}}"
45+
"text": "{\"data\":{\"id\":\"4b95d361-f65d-4515-9824-c9aaeba5ac2a\",\"type\":\"retention_filters\",\"attributes\":{\"enabled\":true,\"event_type\":\"view\",\"name\":\"Test updating retention filter\",\"query\":\"view_query\",\"sample_rate\":100}}}"
4646
},
4747
"cookies": [],
4848
"headers": [

‎examples/v2/rum-retention-filters/CreateRetentionFilter.ts‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,6 @@ const params: v2.RumRetentionFiltersApiCreateRetentionFilterRequest = {
1818
sampleRate: 50,
1919
enabled: true,
2020
},
21-
meta: {
22-
source: "terraform",
23-
},
2421
},
2522
},
2623
appId: "a33671aa-24fd-4dcd-ba4b-5bbdbafe7690",

‎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"

‎packages/datadog-api-client-v2/apis/RumRetentionFiltersApi.ts‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -665,7 +665,7 @@ export class RumRetentionFiltersApiResponseProcessor {
665665

666666
export interface RumRetentionFiltersApiCreateRetentionFilterRequest {
667667
/**
668-
* Application ID.
668+
* RUM application ID.
669669
* @type string
670670
*/
671671
appId: string;
@@ -678,7 +678,7 @@ export interface RumRetentionFiltersApiCreateRetentionFilterRequest {
678678

679679
export interface RumRetentionFiltersApiDeleteRetentionFilterRequest {
680680
/**
681-
* Application ID.
681+
* RUM application ID.
682682
* @type string
683683
*/
684684
appId: string;
@@ -691,7 +691,7 @@ export interface RumRetentionFiltersApiDeleteRetentionFilterRequest {
691691

692692
export interface RumRetentionFiltersApiGetRetentionFilterRequest {
693693
/**
694-
* Application ID.
694+
* RUM application ID.
695695
* @type string
696696
*/
697697
appId: string;
@@ -704,15 +704,15 @@ export interface RumRetentionFiltersApiGetRetentionFilterRequest {
704704

705705
export interface RumRetentionFiltersApiListRetentionFiltersRequest {
706706
/**
707-
* Application ID.
707+
* RUM application ID.
708708
* @type string
709709
*/
710710
appId: string;
711711
}
712712

713713
export interface RumRetentionFiltersApiOrderRetentionFiltersRequest {
714714
/**
715-
* Application ID.
715+
* RUM application ID.
716716
* @type string
717717
*/
718718
appId: string;
@@ -725,7 +725,7 @@ export interface RumRetentionFiltersApiOrderRetentionFiltersRequest {
725725

726726
export interface RumRetentionFiltersApiUpdateRetentionFilterRequest {
727727
/**
728-
* Application ID.
728+
* RUM application ID.
729729
* @type string
730730
*/
731731
appId: string;
@@ -759,7 +759,7 @@ export class RumRetentionFiltersApi {
759759
}
760760

761761
/**
762-
* Create a RUM retention filter for an application.
762+
* Create a RUM retention filter for a RUM application.
763763
* Returns RUM retention filter objects from the request body when the request is successful.
764764
* @param param The request object
765765
*/
@@ -782,7 +782,7 @@ export class RumRetentionFiltersApi {
782782
}
783783

784784
/**
785-
* Delete a RUM retention filter for an application.
785+
* Delete a RUM retention filter for a RUM application.
786786
* @param param The request object
787787
*/
788788
public deleteRetentionFilter(
@@ -804,7 +804,7 @@ export class RumRetentionFiltersApi {
804804
}
805805

806806
/**
807-
* Get a RUM retention filter for an application.
807+
* Get a RUM retention filter for a RUM application.
808808
* @param param The request object
809809
*/
810810
public getRetentionFilter(
@@ -826,7 +826,7 @@ export class RumRetentionFiltersApi {
826826
}
827827

828828
/**
829-
* Get the list of RUM retention filters for an application.
829+
* Get the list of RUM retention filters for a RUM application.
830830
* @param param The request object
831831
*/
832832
public listRetentionFilters(
@@ -847,8 +847,8 @@ export class RumRetentionFiltersApi {
847847
}
848848

849849
/**
850-
* Order RUM retention filters for an application.
851-
* Returns RUM retention filter objects without attributes and meta from the request body when the request is successful.
850+
* Order RUM retention filters for a RUM application.
851+
* Returns RUM retention filter objects without attributes from the request body when the request is successful.
852852
* @param param The request object
853853
*/
854854
public orderRetentionFilters(
@@ -870,7 +870,7 @@ export class RumRetentionFiltersApi {
870870
}
871871

872872
/**
873-
* Update a RUM retention filter for an application.
873+
* Update a RUM retention filter for a RUM application.
874874
* Returns RUM retention filter objects from the request body when the request is successful.
875875
* @param param The request object
876876
*/

0 commit comments

Comments
 (0)