Skip to content

Add OpenAPI spec for RUM insight aggregation endpoints #3359

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.

Sign up for GitHub

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
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add OpenAPI spec for RUM insight aggregation endpoints #3359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1,424 changes: 1,424 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

24 changes: 24 additions & 0 deletions examples/v2/rum/QueryAggregatedLongTasks.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Query aggregated long tasks returns "Successful response" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::RUMAPI.new

body = DatadogAPIClient::V2::AggregatedLongTasksRequest.new({
data: DatadogAPIClient::V2::AggregatedLongTasksRequestData.new({
attributes: DatadogAPIClient::V2::AggregatedLongTasksRequestAttributes.new({
application_id: "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b",
criteria: DatadogAPIClient::V2::AggregatedWaterfallPerformanceCriteria.new({
max: 5.0,
metric: DatadogAPIClient::V2::AggregatedWaterfallPerformanceCriteriaMetric::LARGESTCONTENTFULPAINT,
min: 2.5,
}),
filter: "@session.type:user",
from: 1762437564,
sample_size: 20,
to: 1762523964,
view_name: "/account/login(/:type)",
}),
type: DatadogAPIClient::V2::AggregatedLongTasksRequestType::AGGREGATEDLONGTASKS,
}),
})
p api_instance.query_aggregated_long_tasks(body)
28 changes: 28 additions & 0 deletions examples/v2/rum/QueryAggregatedSignalsProblems.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Query aggregated signals and problems returns "Successful response" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::RUMAPI.new

body = DatadogAPIClient::V2::AggregatedSignalsProblemsRequest.new({
data: DatadogAPIClient::V2::AggregatedSignalsProblemsRequestData.new({
attributes: DatadogAPIClient::V2::AggregatedSignalsProblemsRequestAttributes.new({
application_id: "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b",
criteria: DatadogAPIClient::V2::AggregatedWaterfallPerformanceCriteria.new({
max: 5.0,
metric: DatadogAPIClient::V2::AggregatedWaterfallPerformanceCriteriaMetric::LARGESTCONTENTFULPAINT,
min: 2.5,
}),
detection_types: [
"high_script_evaluations",
"uncompressed_resources",
],
filter: "@session.type:user",
from: 1762437564,
sample_size: 30,
to: 1762523964,
view_name: "/account/login(/:type)",
}),
type: DatadogAPIClient::V2::AggregatedSignalsProblemsRequestType::AGGREGATEDSIGNALSPROBLEMS,
}),
})
p api_instance.query_aggregated_signals_problems(body)
25 changes: 25 additions & 0 deletions examples/v2/rum/QueryAggregatedWaterfall.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Query aggregated waterfall returns "Successful response" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::RUMAPI.new

body = DatadogAPIClient::V2::AggregatedWaterfallRequest.new({
data: DatadogAPIClient::V2::AggregatedWaterfallRequestData.new({
attributes: DatadogAPIClient::V2::AggregatedWaterfallRequestAttributes.new({
application_id: "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b",
criteria: DatadogAPIClient::V2::AggregatedWaterfallPerformanceCriteria.new({
max: 5.0,
metric: DatadogAPIClient::V2::AggregatedWaterfallPerformanceCriteriaMetric::LARGESTCONTENTFULPAINT,
min: 2.5,
}),
filter: "@session.type:user",
from: 1762437564,
include_global_appearance: false,
sample_size: 20,
to: 1762523964,
view_name: "/account/login(/:type)",
}),
type: DatadogAPIClient::V2::AggregatedWaterfallRequestType::AGGREGATEDWATERFALL,
}),
})
p api_instance.query_aggregated_waterfall(body)
9 changes: 9 additions & 0 deletions features/scenarios_model_mapping.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4201,6 +4201,15 @@
"v2.SearchRUMEvents" => {
"body" => "RUMSearchEventsRequest",
},
"v2.QueryAggregatedLongTasks" => {
"body" => "AggregatedLongTasksRequest",
},
"v2.QueryAggregatedSignalsProblems" => {
"body" => "AggregatedSignalsProblemsRequest",
},
"v2.QueryAggregatedWaterfall" => {
"body" => "AggregatedWaterfallRequest",
},
"v2.OrderRetentionFilters" => {
"app_id" => "String",
"body" => "RumRetentionFiltersOrderRequest",
Expand Down
42 changes: 42 additions & 0 deletions features/v2/rum.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,48 @@ Feature: RUM
And the response "data" has item with field "attributes.product_scales.rum_event_processing_scale.state" with value "ALL"
And the response "data" has item with field "attributes.product_scales.product_analytics_retention_scale.state" with value "NONE"

@generated @skip @team:DataDog/rum-backend
Scenario: Query aggregated long tasks returns "Bad Request" response
Given new "QueryAggregatedLongTasks" request
And body with value {"data": {"attributes": {"application_id": "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b", "criteria": {"max": 5.0, "metric": "largest_contentful_paint", "min": 2.5}, "filter": "@session.type:user", "from": 1762437564, "sample_size": 20, "to": 1762523964, "view_name": "/account/login(/:type)"}, "type": "aggregated_long_tasks"}}
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/rum-backend
Scenario: Query aggregated long tasks returns "Successful response" response
Given new "QueryAggregatedLongTasks" request
And body with value {"data": {"attributes": {"application_id": "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b", "criteria": {"max": 5.0, "metric": "largest_contentful_paint", "min": 2.5}, "filter": "@session.type:user", "from": 1762437564, "sample_size": 20, "to": 1762523964, "view_name": "/account/login(/:type)"}, "type": "aggregated_long_tasks"}}
When the request is sent
Then the response status is 201 Successful response

@generated @skip @team:DataDog/rum-backend
Scenario: Query aggregated signals and problems returns "Bad Request" response
Given new "QueryAggregatedSignalsProblems" request
And body with value {"data": {"attributes": {"application_id": "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b", "criteria": {"max": 5.0, "metric": "largest_contentful_paint", "min": 2.5}, "detection_types": ["high_script_evaluations", "uncompressed_resources"], "filter": "@session.type:user", "from": 1762437564, "sample_size": 30, "to": 1762523964, "view_name": "/account/login(/:type)"}, "type": "aggregated_signals_problems"}}
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/rum-backend
Scenario: Query aggregated signals and problems returns "Successful response" response
Given new "QueryAggregatedSignalsProblems" request
And body with value {"data": {"attributes": {"application_id": "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b", "criteria": {"max": 5.0, "metric": "largest_contentful_paint", "min": 2.5}, "detection_types": ["high_script_evaluations", "uncompressed_resources"], "filter": "@session.type:user", "from": 1762437564, "sample_size": 30, "to": 1762523964, "view_name": "/account/login(/:type)"}, "type": "aggregated_signals_problems"}}
When the request is sent
Then the response status is 201 Successful response

@generated @skip @team:DataDog/rum-backend
Scenario: Query aggregated waterfall returns "Bad Request" response
Given new "QueryAggregatedWaterfall" request
And body with value {"data": {"attributes": {"application_id": "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b", "criteria": {"max": 5.0, "metric": "largest_contentful_paint", "min": 2.5}, "filter": "@session.type:user", "from": 1762437564, "include_global_appearance": false, "sample_size": 20, "to": 1762523964, "view_name": "/account/login(/:type)"}, "type": "aggregated_waterfall"}}
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/rum-backend
Scenario: Query aggregated waterfall returns "Successful response" response
Given new "QueryAggregatedWaterfall" request
And body with value {"data": {"attributes": {"application_id": "ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b", "criteria": {"max": 5.0, "metric": "largest_contentful_paint", "min": 2.5}, "filter": "@session.type:user", "from": 1762437564, "include_global_appearance": false, "sample_size": 20, "to": 1762523964, "view_name": "/account/login(/:type)"}, "type": "aggregated_waterfall"}}
When the request is sent
Then the response status is 201 Successful response

@generated @skip @team:DataDog/rum-backend
Scenario: Search RUM events returns "Bad Request" response
Given new "SearchRUMEvents" request
Expand Down
18 changes: 18 additions & 0 deletions features/v2/undo.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5666,6 +5666,24 @@
"type": "safe"
}
},
"QueryAggregatedLongTasks": {
"tag": "RUM",
"undo": {
"type": "safe"
}
},
"QueryAggregatedSignalsProblems": {
"tag": "RUM",
"undo": {
"type": "safe"
}
},
"QueryAggregatedWaterfall": {
"tag": "RUM",
"undo": {
"type": "safe"
}
},
"ListRumReplayPlaylists": {
"tag": "Rum Replay Playlists",
"undo": {
Expand Down
38 changes: 38 additions & 0 deletions lib/datadog_api_client/inflector.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1146,6 +1146,39 @@ def overrides
"v2.active_billing_dimensions_type" => "ActiveBillingDimensionsType",
"v2.add_member_team_request" => "AddMemberTeamRequest",
"v2.advisory" => "Advisory",
"v2.aggregated_high_frozen_frame_rate" => "AggregatedHighFrozenFrameRate",
"v2.aggregated_high_script_eval" => "AggregatedHighScriptEval",
"v2.aggregated_long_tasks_by_invoker_type" => "AggregatedLongTasksByInvokerType",
"v2.aggregated_long_tasks_request" => "AggregatedLongTasksRequest",
"v2.aggregated_long_tasks_request_attributes" => "AggregatedLongTasksRequestAttributes",
"v2.aggregated_long_tasks_request_data" => "AggregatedLongTasksRequestData",
"v2.aggregated_long_tasks_request_type" => "AggregatedLongTasksRequestType",
"v2.aggregated_long_tasks_response" => "AggregatedLongTasksResponse",
"v2.aggregated_long_tasks_response_attributes" => "AggregatedLongTasksResponseAttributes",
"v2.aggregated_long_tasks_response_data" => "AggregatedLongTasksResponseData",
"v2.aggregated_low_cache_hit_rate" => "AggregatedLowCacheHitRate",
"v2.aggregated_mobile_scroll_friction" => "AggregatedMobileScrollFriction",
"v2.aggregated_resource" => "AggregatedResource",
"v2.aggregated_resource_timing_breakdown" => "AggregatedResourceTimingBreakdown",
"v2.aggregated_signals_problems_request" => "AggregatedSignalsProblemsRequest",
"v2.aggregated_signals_problems_request_attributes" => "AggregatedSignalsProblemsRequestAttributes",
"v2.aggregated_signals_problems_request_data" => "AggregatedSignalsProblemsRequestData",
"v2.aggregated_signals_problems_request_type" => "AggregatedSignalsProblemsRequestType",
"v2.aggregated_signals_problems_response" => "AggregatedSignalsProblemsResponse",
"v2.aggregated_signals_problems_response_attributes" => "AggregatedSignalsProblemsResponseAttributes",
"v2.aggregated_signals_problems_response_data" => "AggregatedSignalsProblemsResponseData",
"v2.aggregated_slow_fcp_high_bytes" => "AggregatedSlowFCPHighBytes",
"v2.aggregated_slow_interaction_long_task" => "AggregatedSlowInteractionLongTask",
"v2.aggregated_uncompressed_resource" => "AggregatedUncompressedResource",
"v2.aggregated_waterfall_performance_criteria" => "AggregatedWaterfallPerformanceCriteria",
"v2.aggregated_waterfall_performance_criteria_metric" => "AggregatedWaterfallPerformanceCriteriaMetric",
"v2.aggregated_waterfall_request" => "AggregatedWaterfallRequest",
"v2.aggregated_waterfall_request_attributes" => "AggregatedWaterfallRequestAttributes",
"v2.aggregated_waterfall_request_data" => "AggregatedWaterfallRequestData",
"v2.aggregated_waterfall_request_type" => "AggregatedWaterfallRequestType",
"v2.aggregated_waterfall_response" => "AggregatedWaterfallResponse",
"v2.aggregated_waterfall_response_attributes" => "AggregatedWaterfallResponseAttributes",
"v2.aggregated_waterfall_response_data" => "AggregatedWaterfallResponseData",
"v2.alert_event_attributes" => "AlertEventAttributes",
"v2.alert_event_attributes_links_item" => "AlertEventAttributesLinksItem",
"v2.alert_event_attributes_links_item_category" => "AlertEventAttributesLinksItemCategory",
Expand Down Expand Up @@ -3952,6 +3985,8 @@ def overrides
"v2.logs_storage_tier" => "LogsStorageTier",
"v2.logs_warning" => "LogsWarning",
"v2.log_type" => "LogType",
"v2.long_task_metric_stats" => "LongTaskMetricStats",
"v2.long_task_stats_per_view" => "LongTaskStatsPerView",
"v2.maintenance" => "Maintenance",
"v2.maintenance_array" => "MaintenanceArray",
"v2.maintenance_data" => "MaintenanceData",
Expand Down Expand Up @@ -5796,6 +5831,8 @@ def overrides
"v2.shift_data_relationships_user_data_type" => "ShiftDataRelationshipsUserDataType",
"v2.shift_data_type" => "ShiftDataType",
"v2.shift_included" => "ShiftIncluded",
"v2.signals_problems_detections" => "SignalsProblemsDetections",
"v2.signals_problems_sample_metadata" => "SignalsProblemsSampleMetadata",
"v2.simple_monitor_user_template" => "SimpleMonitorUserTemplate",
"v2.single_aggregated_connection_response_array" => "SingleAggregatedConnectionResponseArray",
"v2.single_aggregated_connection_response_data" => "SingleAggregatedConnectionResponseData",
Expand Down Expand Up @@ -6395,6 +6432,7 @@ def overrides
"v2.timeseries_response_attributes" => "TimeseriesResponseAttributes",
"v2.timeseries_response_series" => "TimeseriesResponseSeries",
"v2.token_type" => "TokenType",
"v2.top_long_task_invoker" => "TopLongTaskInvoker",
"v2.trigger" => "Trigger",
"v2.trigger_attributes" => "TriggerAttributes",
"v2.trigger_investigation_request" => "TriggerInvestigationRequest",
Expand Down
Loading
Loading