Skip to content

Add OpenAPI spec for v2 Synthetics test result endpoints #3242

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 v2 Synthetics test result endpoints #3242

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
2,486 changes: 2,405 additions & 81 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions examples/v2/synthetics/GetSyntheticsBrowserTestResult.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Get a browser test result returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::SyntheticsAPI.new
p api_instance.get_synthetics_browser_test_result("public_id", "result_id")
5 changes: 5 additions & 0 deletions examples/v2/synthetics/GetSyntheticsTestResult.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Get a test result returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::SyntheticsAPI.new
p api_instance.get_synthetics_test_result("public_id", "result_id")
5 changes: 5 additions & 0 deletions examples/v2/synthetics/ListSyntheticsBrowserTestLatestResults.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Get a browser test's latest results returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::SyntheticsAPI.new
p api_instance.list_synthetics_browser_test_latest_results("public_id")
5 changes: 5 additions & 0 deletions examples/v2/synthetics/ListSyntheticsTestLatestResults.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Get a test's latest results returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::SyntheticsAPI.new
p api_instance.list_synthetics_test_latest_results("public_id")
5 changes: 5 additions & 0 deletions examples/v2/synthetics/PollSyntheticsTestResults.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Poll for test results returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::SyntheticsAPI.new
p api_instance.poll_synthetics_test_results("result_ids")
33 changes: 33 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 @@ -4274,6 +4274,21 @@
"public_id" => "String",
"body" => "SuiteJsonPatchRequest",
},
"v2.ListSyntheticsBrowserTestLatestResults" => {
"public_id" => "String",
"from_ts" => "Integer",
"to_ts" => "Integer",
"status" => "SyntheticsTestResultStatus",
"run_type" => "SyntheticsTestResultRunType",
"probe_dc" => "Array<String>",
"device_id" => "Array<String>",
},
"v2.GetSyntheticsBrowserTestResult" => {
"public_id" => "String",
"result_id" => "String",
"event_id" => "String",
"timestamp" => "Integer",
},
"v2.DeleteSyntheticsTests" => {
"body" => "DeletedTestsRequestDeleteRequest",
},
Expand All @@ -4290,6 +4305,9 @@
"public_id" => "String",
"body" => "SyntheticsNetworkTestEditRequest",
},
"v2.PollSyntheticsTestResults" => {
"result_ids" => "String",
},
"v2.GetTestFileDownloadUrl" => {
"public_id" => "String",
"body" => "SyntheticsTestFileDownloadRequest",
Expand All @@ -4309,6 +4327,21 @@
"v2.GetTestParentSuites" => {
"public_id" => "String",
},
"v2.ListSyntheticsTestLatestResults" => {
"public_id" => "String",
"from_ts" => "Integer",
"to_ts" => "Integer",
"status" => "SyntheticsTestResultStatus",
"run_type" => "SyntheticsTestResultRunType",
"probe_dc" => "Array<String>",
"device_id" => "Array<String>",
},
"v2.GetSyntheticsTestResult" => {
"public_id" => "String",
"result_id" => "String",
"event_id" => "String",
"timestamp" => "Integer",
},
"v2.ListSyntheticsTestVersions" => {
"public_id" => "String",
"last_version_number" => "Integer",
Expand Down
74 changes: 74 additions & 0 deletions features/v2/synthetics.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,36 @@ Feature: Synthetics
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/synthetics-orchestrating-managing
Scenario: Get a browser test result returns "API error response." response
Given new "GetSyntheticsBrowserTestResult" request
And request contains "public_id" parameter from "REPLACE.ME"
And request contains "result_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 404 API error response.

@generated @skip @team:DataDog/synthetics-orchestrating-managing
Scenario: Get a browser test result returns "OK" response
Given new "GetSyntheticsBrowserTestResult" request
And request contains "public_id" parameter from "REPLACE.ME"
And request contains "result_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/synthetics-orchestrating-managing
Scenario: Get a browser test's latest results returns "API error response." response
Given new "ListSyntheticsBrowserTestLatestResults" request
And request contains "public_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 404 API error response.

@generated @skip @team:DataDog/synthetics-orchestrating-managing
Scenario: Get a browser test's latest results returns "OK" response
Given new "ListSyntheticsBrowserTestLatestResults" request
And request contains "public_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/synthetics-orchestrating-managing
Scenario: Get a fast test result returns "API error response." response
Given new "GetSyntheticsFastTestResult" request
Expand Down Expand Up @@ -211,6 +241,36 @@ Feature: Synthetics
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/synthetics-orchestrating-managing
Scenario: Get a test result returns "API error response." response
Given new "GetSyntheticsTestResult" request
And request contains "public_id" parameter from "REPLACE.ME"
And request contains "result_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 404 API error response.

@generated @skip @team:DataDog/synthetics-orchestrating-managing
Scenario: Get a test result returns "OK" response
Given new "GetSyntheticsTestResult" request
And request contains "public_id" parameter from "REPLACE.ME"
And request contains "result_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/synthetics-orchestrating-managing
Scenario: Get a test's latest results returns "API error response." response
Given new "ListSyntheticsTestLatestResults" request
And request contains "public_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 404 API error response.

@generated @skip @team:DataDog/synthetics-orchestrating-managing
Scenario: Get a test's latest results returns "OK" response
Given new "ListSyntheticsTestLatestResults" request
And request contains "public_id" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/synthetics-orchestrating-managing
Scenario: Get available subtests for a multistep test returns "OK" response
Given new "GetApiMultistepSubtests" request
Expand Down Expand Up @@ -322,6 +382,20 @@ Feature: Synthetics
When the request is sent
Then the response status is 200 OK

@generated @skip @team:DataDog/synthetics-orchestrating-managing
Scenario: Poll for test results returns "API error response." response
Given new "PollSyntheticsTestResults" request
And request contains "result_ids" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 404 API error response.

@generated @skip @team:DataDog/synthetics-orchestrating-managing
Scenario: Poll for test results returns "OK" response
Given new "PollSyntheticsTestResults" request
And request contains "result_ids" parameter from "REPLACE.ME"
When the request is sent
Then the response status is 200 OK

@team:DataDog/synthetics-orchestrating-managing
Scenario: Save new value for on-demand concurrency cap returns "OK" response
Given new "SetOnDemandConcurrencyCap" request
Expand Down
30 changes: 30 additions & 0 deletions features/v2/undo.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6404,6 +6404,18 @@
"type": "idempotent"
}
},
"ListSyntheticsBrowserTestLatestResults": {
"tag": "Synthetics",
"undo": {
"type": "safe"
}
},
"GetSyntheticsBrowserTestResult": {
"tag": "Synthetics",
"undo": {
"type": "safe"
}
},
"DeleteSyntheticsTests": {
"tag": "Synthetics",
"undo": {
Expand Down Expand Up @@ -6441,6 +6453,12 @@
"type": "idempotent"
}
},
"PollSyntheticsTestResults": {
"tag": "Synthetics",
"undo": {
"type": "safe"
}
},
"GetTestFileDownloadUrl": {
"tag": "Synthetics",
"undo": {
Expand Down Expand Up @@ -6471,6 +6489,18 @@
"type": "safe"
}
},
"ListSyntheticsTestLatestResults": {
"tag": "Synthetics",
"undo": {
"type": "safe"
}
},
"GetSyntheticsTestResult": {
"tag": "Synthetics",
"undo": {
"type": "safe"
}
},
"ListSyntheticsTestVersions": {
"tag": "Synthetics",
"undo": {
Expand Down
82 changes: 78 additions & 4 deletions lib/datadog_api_client/inflector.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5591,10 +5591,6 @@ def overrides
"v2.synthetics_fast_test_result_attributes" => "SyntheticsFastTestResultAttributes",
"v2.synthetics_fast_test_result_data" => "SyntheticsFastTestResultData",
"v2.synthetics_fast_test_result_detail" => "SyntheticsFastTestResultDetail",
"v2.synthetics_fast_test_result_device" => "SyntheticsFastTestResultDevice",
"v2.synthetics_fast_test_result_failure" => "SyntheticsFastTestResultFailure",
"v2.synthetics_fast_test_result_location" => "SyntheticsFastTestResultLocation",
"v2.synthetics_fast_test_result_type" => "SyntheticsFastTestResultType",
"v2.synthetics_fast_test_sub_type" => "SyntheticsFastTestSubType",
"v2.synthetics_global_variable" => "SyntheticsGlobalVariable",
"v2.synthetics_global_variable_attributes" => "SyntheticsGlobalVariableAttributes",
Expand Down Expand Up @@ -5626,6 +5622,7 @@ def overrides
"v2.synthetics_network_test_response_type" => "SyntheticsNetworkTestResponseType",
"v2.synthetics_network_test_sub_type" => "SyntheticsNetworkTestSubType",
"v2.synthetics_network_test_type" => "SyntheticsNetworkTestType",
"v2.synthetics_poll_test_results_response" => "SyntheticsPollTestResultsResponse",
"v2.synthetics_suite" => "SyntheticsSuite",
"v2.synthetics_suite_options" => "SyntheticsSuiteOptions",
"v2.synthetics_suite_response" => "SyntheticsSuiteResponse",
Expand All @@ -5647,6 +5644,7 @@ def overrides
"v2.synthetics_test_file_multipart_presigned_urls_request" => "SyntheticsTestFileMultipartPresignedUrlsRequest",
"v2.synthetics_test_file_multipart_presigned_urls_request_bucket_key_prefix" => "SyntheticsTestFileMultipartPresignedUrlsRequestBucketKeyPrefix",
"v2.synthetics_test_file_multipart_presigned_urls_response" => "SyntheticsTestFileMultipartPresignedUrlsResponse",
"v2.synthetics_test_latest_results_response" => "SyntheticsTestLatestResultsResponse",
"v2.synthetics_test_options" => "SyntheticsTestOptions",
"v2.synthetics_test_options_monitor_options" => "SyntheticsTestOptionsMonitorOptions",
"v2.synthetics_test_options_monitor_options_notification_preset_name" => "SyntheticsTestOptionsMonitorOptionsNotificationPresetName",
Expand All @@ -5658,6 +5656,82 @@ def overrides
"v2.synthetics_test_parent_suites_response" => "SyntheticsTestParentSuitesResponse",
"v2.synthetics_test_parent_suite_type" => "SyntheticsTestParentSuiteType",
"v2.synthetics_test_pause_status" => "SyntheticsTestPauseStatus",
"v2.synthetics_test_result_assertion_result" => "SyntheticsTestResultAssertionResult",
"v2.synthetics_test_result_attributes" => "SyntheticsTestResultAttributes",
"v2.synthetics_test_result_batch" => "SyntheticsTestResultBatch",
"v2.synthetics_test_result_bounds" => "SyntheticsTestResultBounds",
"v2.synthetics_test_result_browser_error" => "SyntheticsTestResultBrowserError",
"v2.synthetics_test_result_bucket_keys" => "SyntheticsTestResultBucketKeys",
"v2.synthetics_test_result_cdn_cache_status" => "SyntheticsTestResultCdnCacheStatus",
"v2.synthetics_test_result_cdn_provider_info" => "SyntheticsTestResultCdnProviderInfo",
"v2.synthetics_test_result_cdn_resource" => "SyntheticsTestResultCdnResource",
"v2.synthetics_test_result_certificate" => "SyntheticsTestResultCertificate",
"v2.synthetics_test_result_certificate_validity" => "SyntheticsTestResultCertificateValidity",
"v2.synthetics_test_result_ci" => "SyntheticsTestResultCI",
"v2.synthetics_test_result_ci_pipeline" => "SyntheticsTestResultCIPipeline",
"v2.synthetics_test_result_ci_provider" => "SyntheticsTestResultCIProvider",
"v2.synthetics_test_result_ci_stage" => "SyntheticsTestResultCIStage",
"v2.synthetics_test_result_data" => "SyntheticsTestResultData",
"v2.synthetics_test_result_detail" => "SyntheticsTestResultDetail",
"v2.synthetics_test_result_device" => "SyntheticsTestResultDevice",
"v2.synthetics_test_result_device_browser" => "SyntheticsTestResultDeviceBrowser",
"v2.synthetics_test_result_device_platform" => "SyntheticsTestResultDevicePlatform",
"v2.synthetics_test_result_device_resolution" => "SyntheticsTestResultDeviceResolution",
"v2.synthetics_test_result_dns_record" => "SyntheticsTestResultDnsRecord",
"v2.synthetics_test_result_dns_resolution" => "SyntheticsTestResultDnsResolution",
"v2.synthetics_test_result_execution_info" => "SyntheticsTestResultExecutionInfo",
"v2.synthetics_test_result_failure" => "SyntheticsTestResultFailure",
"v2.synthetics_test_result_file_ref" => "SyntheticsTestResultFileRef",
"v2.synthetics_test_result_git" => "SyntheticsTestResultGit",
"v2.synthetics_test_result_git_commit" => "SyntheticsTestResultGitCommit",
"v2.synthetics_test_result_git_user" => "SyntheticsTestResultGitUser",
"v2.synthetics_test_result_handshake" => "SyntheticsTestResultHandshake",
"v2.synthetics_test_result_health_check" => "SyntheticsTestResultHealthCheck",
"v2.synthetics_test_result_included_item" => "SyntheticsTestResultIncludedItem",
"v2.synthetics_test_result_location" => "SyntheticsTestResultLocation",
"v2.synthetics_test_result_netpath" => "SyntheticsTestResultNetpath",
"v2.synthetics_test_result_netpath_destination" => "SyntheticsTestResultNetpathDestination",
"v2.synthetics_test_result_netpath_endpoint" => "SyntheticsTestResultNetpathEndpoint",
"v2.synthetics_test_result_netpath_hop" => "SyntheticsTestResultNetpathHop",
"v2.synthetics_test_result_netstats" => "SyntheticsTestResultNetstats",
"v2.synthetics_test_result_netstats_hops" => "SyntheticsTestResultNetstatsHops",
"v2.synthetics_test_result_network_latency" => "SyntheticsTestResultNetworkLatency",
"v2.synthetics_test_result_ocsp_certificate" => "SyntheticsTestResultOCSPCertificate",
"v2.synthetics_test_result_ocsp_response" => "SyntheticsTestResultOCSPResponse",
"v2.synthetics_test_result_ocsp_updates" => "SyntheticsTestResultOCSPUpdates",
"v2.synthetics_test_result_parent_step" => "SyntheticsTestResultParentStep",
"v2.synthetics_test_result_parent_test" => "SyntheticsTestResultParentTest",
"v2.synthetics_test_result_redirect" => "SyntheticsTestResultRedirect",
"v2.synthetics_test_result_relationships" => "SyntheticsTestResultRelationships",
"v2.synthetics_test_result_relationship_test" => "SyntheticsTestResultRelationshipTest",
"v2.synthetics_test_result_relationship_test_data" => "SyntheticsTestResultRelationshipTestData",
"v2.synthetics_test_result_request_info" => "SyntheticsTestResultRequestInfo",
"v2.synthetics_test_result_response" => "SyntheticsTestResultResponse",
"v2.synthetics_test_result_response_info" => "SyntheticsTestResultResponseInfo",
"v2.synthetics_test_result_router" => "SyntheticsTestResultRouter",
"v2.synthetics_test_result_rum_context" => "SyntheticsTestResultRumContext",
"v2.synthetics_test_result_run_type" => "SyntheticsTestResultRunType",
"v2.synthetics_test_result_status" => "SyntheticsTestResultStatus",
"v2.synthetics_test_result_step" => "SyntheticsTestResultStep",
"v2.synthetics_test_result_step_assertion_result" => "SyntheticsTestResultStepAssertionResult",
"v2.synthetics_test_result_step_element_updates" => "SyntheticsTestResultStepElementUpdates",
"v2.synthetics_test_result_steps_info" => "SyntheticsTestResultStepsInfo",
"v2.synthetics_test_result_sub_step" => "SyntheticsTestResultSubStep",
"v2.synthetics_test_result_sub_test" => "SyntheticsTestResultSubTest",
"v2.synthetics_test_result_summary_attributes" => "SyntheticsTestResultSummaryAttributes",
"v2.synthetics_test_result_summary_data" => "SyntheticsTestResultSummaryData",
"v2.synthetics_test_result_summary_type" => "SyntheticsTestResultSummaryType",
"v2.synthetics_test_result_tab" => "SyntheticsTestResultTab",
"v2.synthetics_test_result_trace" => "SyntheticsTestResultTrace",
"v2.synthetics_test_result_traceroute_hop" => "SyntheticsTestResultTracerouteHop",
"v2.synthetics_test_result_turn" => "SyntheticsTestResultTurn",
"v2.synthetics_test_result_turn_step" => "SyntheticsTestResultTurnStep",
"v2.synthetics_test_result_type" => "SyntheticsTestResultType",
"v2.synthetics_test_result_variable" => "SyntheticsTestResultVariable",
"v2.synthetics_test_result_variables" => "SyntheticsTestResultVariables",
"v2.synthetics_test_result_vitals_metrics" => "SyntheticsTestResultVitalsMetrics",
"v2.synthetics_test_result_warning" => "SyntheticsTestResultWarning",
"v2.synthetics_test_result_web_socket_close" => "SyntheticsTestResultWebSocketClose",
"v2.synthetics_test_version_action_metadata" => "SyntheticsTestVersionActionMetadata",
"v2.synthetics_test_version_attributes" => "SyntheticsTestVersionAttributes",
"v2.synthetics_test_version_author" => "SyntheticsTestVersionAuthor",
Expand Down
Loading
Loading