Skip to content

Update documentation of v2 endpoints for RUM retention filters. #2094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2025-03-06 21:28:33.227511",
"spec_repo_commit": "d6a6faf6"
"regenerated": "2025-03-10 19:56:03.385578",
"spec_repo_commit": "04a593ef"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-03-06 21:28:33.247005",
"spec_repo_commit": "d6a6faf6"
"regenerated": "2025-03-10 19:56:03.401439",
"spec_repo_commit": "04a593ef"
}
}
}
25 changes: 14 additions & 11 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -684,7 +684,7 @@ components:
schema:
type: string
RumApplicationIDParameter:
description: Application ID.
description: RUM application ID.
in: path
name: app_id
required: true
Expand Down Expand Up @@ -25579,7 +25579,9 @@ components:
minimum: 0
type: integer
RumRetentionFilterSource:
description: The type of RUM events to filter on.
description: The origin source of the retention filter, which may be created
or updated through the Datadog UI, terraform, or other channels such as direct
API calls.
enum:
- ui
- terraform
Expand Down Expand Up @@ -25654,7 +25656,8 @@ components:
description: 'The list of RUM retention filter IDs along with their corresponding
type to reorder.

All retention filter IDs should be included in the list created for an application.'
All retention filter IDs should be included in the list created for a RUM
application.'
properties:
data:
description: A list of RUM retention filter IDs along with type.
Expand All @@ -25672,7 +25675,7 @@ components:
type: array
type: object
RumRetentionFiltersResponse:
description: All RUM retention filters for an application.
description: All RUM retention filters for a RUM application.
properties:
data:
description: A list of RUM retention filters.
Expand Down Expand Up @@ -46225,7 +46228,7 @@ paths:
- rum_apps_write
/api/v2/rum/applications/{app_id}/relationships/retention_filters:
patch:
description: 'Order RUM retention filters for an application.
description: 'Order RUM retention filters for a RUM application.

Returns RUM retention filter objects without attributes and meta from the
request body when the request is successful.'
Expand Down Expand Up @@ -46258,7 +46261,7 @@ paths:
x-codegen-request-body-name: body
/api/v2/rum/applications/{app_id}/retention_filters:
get:
description: Get the list of RUM retention filters for an application.
description: Get the list of RUM retention filters for a RUM application.
operationId: ListRetentionFilters
parameters:
- $ref: '#/components/parameters/RumApplicationIDParameter'
Expand All @@ -46277,7 +46280,7 @@ paths:
tags:
- Rum Retention Filters
post:
description: 'Create a RUM retention filter for an application.
description: 'Create a RUM retention filter for a RUM application.

Returns RUM retention filter objects from the request body when the request
is successful.'
Expand Down Expand Up @@ -46310,7 +46313,7 @@ paths:
x-codegen-request-body-name: body
/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}:
delete:
description: Delete a RUM retention filter for an application.
description: Delete a RUM retention filter for a RUM application.
operationId: DeleteRetentionFilter
parameters:
- $ref: '#/components/parameters/RumApplicationIDParameter'
Expand All @@ -46328,7 +46331,7 @@ paths:
tags:
- Rum Retention Filters
get:
description: Get a RUM retention filter for an application.
description: Get a RUM retention filter for a RUM application.
operationId: GetRetentionFilter
parameters:
- $ref: '#/components/parameters/RumApplicationIDParameter'
Expand All @@ -46350,7 +46353,7 @@ paths:
tags:
- Rum Retention Filters
patch:
description: 'Update a RUM retention filter for an application.
description: 'Update a RUM retention filter for a RUM application.

Returns RUM retention filter objects from the request body when the request
is successful.'
Expand Down Expand Up @@ -53800,7 +53803,7 @@ tags:
url: https://docs.datadoghq.com/real_user_monitoring/platform/generate_metrics/
name: Rum Metrics
- description: Manage retention filters through [Manage Applications](https://app.datadoghq.com/rum/list)
for your organization.
of RUM for your organization.
name: Rum Retention Filters
- description: Create and manage your security rules, signals, filters, and more.
See the [Datadog Security page](https://docs.datadoghq.com/security/) for more
Expand Down
3 changes: 2 additions & 1 deletion features/v2/rum_retention_filters.feature
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
@endpoint(rum-retention-filters) @endpoint(rum-retention-filters-v2)
Feature: Rum Retention Filters
Manage retention filters through [Manage
Applications](https://app.datadoghq.com/rum/list) for your organization.
Applications](https://app.datadoghq.com/rum/list) of RUM for your
organization.

Background:
Given a valid "apiKeyAuth" key in the system
Expand Down
24 changes: 12 additions & 12 deletions packages/datadog-api-client-v2/apis/RumRetentionFiltersApi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -665,7 +665,7 @@ export class RumRetentionFiltersApiResponseProcessor {

export interface RumRetentionFiltersApiCreateRetentionFilterRequest {
/**
* Application ID.
* RUM application ID.
* @type string
*/
appId: string;
Expand All @@ -678,7 +678,7 @@ export interface RumRetentionFiltersApiCreateRetentionFilterRequest {

export interface RumRetentionFiltersApiDeleteRetentionFilterRequest {
/**
* Application ID.
* RUM application ID.
* @type string
*/
appId: string;
Expand All @@ -691,7 +691,7 @@ export interface RumRetentionFiltersApiDeleteRetentionFilterRequest {

export interface RumRetentionFiltersApiGetRetentionFilterRequest {
/**
* Application ID.
* RUM application ID.
* @type string
*/
appId: string;
Expand All @@ -704,15 +704,15 @@ export interface RumRetentionFiltersApiGetRetentionFilterRequest {

export interface RumRetentionFiltersApiListRetentionFiltersRequest {
/**
* Application ID.
* RUM application ID.
* @type string
*/
appId: string;
}

export interface RumRetentionFiltersApiOrderRetentionFiltersRequest {
/**
* Application ID.
* RUM application ID.
* @type string
*/
appId: string;
Expand All @@ -725,7 +725,7 @@ export interface RumRetentionFiltersApiOrderRetentionFiltersRequest {

export interface RumRetentionFiltersApiUpdateRetentionFilterRequest {
/**
* Application ID.
* RUM application ID.
* @type string
*/
appId: string;
Expand Down Expand Up @@ -759,7 +759,7 @@ export class RumRetentionFiltersApi {
}

/**
* Create a RUM retention filter for an application.
* Create a RUM retention filter for a RUM application.
* Returns RUM retention filter objects from the request body when the request is successful.
* @param param The request object
*/
Expand All @@ -782,7 +782,7 @@ export class RumRetentionFiltersApi {
}

/**
* Delete a RUM retention filter for an application.
* Delete a RUM retention filter for a RUM application.
* @param param The request object
*/
public deleteRetentionFilter(
Expand All @@ -804,7 +804,7 @@ export class RumRetentionFiltersApi {
}

/**
* Get a RUM retention filter for an application.
* Get a RUM retention filter for a RUM application.
* @param param The request object
*/
public getRetentionFilter(
Expand All @@ -826,7 +826,7 @@ export class RumRetentionFiltersApi {
}

/**
* Get the list of RUM retention filters for an application.
* Get the list of RUM retention filters for a RUM application.
* @param param The request object
*/
public listRetentionFilters(
Expand All @@ -847,7 +847,7 @@ export class RumRetentionFiltersApi {
}

/**
* Order RUM retention filters for an application.
* Order RUM retention filters for a RUM application.
* Returns RUM retention filter objects without attributes and meta from the request body when the request is successful.
* @param param The request object
*/
Expand All @@ -870,7 +870,7 @@ export class RumRetentionFiltersApi {
}

/**
* Update a RUM retention filter for an application.
* Update a RUM retention filter for a RUM application.
* Returns RUM retention filter objects from the request body when the request is successful.
* @param param The request object
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
*/
export class RumRetentionFilterMeta {
/**
* The type of RUM events to filter on.
* The origin source of the retention filter, which may be created or updated through the Datadog UI, terraform, or other channels such as direct API calls.
*/
"source"?: RumRetentionFilterSource;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import { UnparsedObject } from "../../datadog-api-client-common/util";

/**
* The type of RUM events to filter on.
* The origin source of the retention filter, which may be created or updated through the Datadog UI, terraform, or other channels such as direct API calls.
*/

export type RumRetentionFilterSource =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";

/**
* The list of RUM retention filter IDs along with their corresponding type to reorder.
* All retention filter IDs should be included in the list created for an application.
* All retention filter IDs should be included in the list created for a RUM application.
*/
export class RumRetentionFiltersOrderRequest {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { RumRetentionFilterData } from "./RumRetentionFilterData";
import { AttributeTypeMap } from "../../datadog-api-client-common/util";

/**
* All RUM retention filters for an application.
* All RUM retention filters for a RUM application.
*/
export class RumRetentionFiltersResponse {
/**
Expand Down