Skip to content

Commit 521bc59

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 39d48ca of spec repo
1 parent 0ce0d8c commit 521bc59

17 files changed

Lines changed: 1143 additions & 0 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 256 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64486,6 +64486,218 @@ components:
6448664486
description: The direction and type of synchronization for this property.
6448764487
type: string
6448864488
type: object
64489+
SyntheticsFastTestAssertionResult:
64490+
additionalProperties: {}
64491+
description: Result of a single assertion evaluated during a fast test run.
64492+
type: object
64493+
SyntheticsFastTestResult:
64494+
description: |-
64495+
Fast test result response. Returns `null` if the result is not yet available
64496+
(the test is still running or timed out before completing).
64497+
nullable: true
64498+
properties:
64499+
data:
64500+
$ref: "#/components/schemas/SyntheticsFastTestResultData"
64501+
type: object
64502+
SyntheticsFastTestResultAttributes:
64503+
description: Attributes of the fast test result.
64504+
properties:
64505+
device:
64506+
$ref: "#/components/schemas/SyntheticsFastTestResultDevice"
64507+
location:
64508+
$ref: "#/components/schemas/SyntheticsFastTestResultLocation"
64509+
result:
64510+
$ref: "#/components/schemas/SyntheticsFastTestResultDetail"
64511+
test_sub_type:
64512+
$ref: "#/components/schemas/SyntheticsFastTestSubType"
64513+
test_type:
64514+
description: The type of the Synthetic test that produced this result (for example, `api` or `browser`).
64515+
example: api
64516+
type: string
64517+
test_version:
64518+
description: Version of the test at the time the fast test was triggered.
64519+
format: int64
64520+
type: integer
64521+
v:
64522+
description: Schema version of the result payload.
64523+
format: int64
64524+
type: integer
64525+
type: object
64526+
SyntheticsFastTestResultData:
64527+
description: Fast test result data object (JSON:API format).
64528+
properties:
64529+
attributes:
64530+
$ref: "#/components/schemas/SyntheticsFastTestResultAttributes"
64531+
id:
64532+
description: The UUID of the fast test, used as the result identifier.
64533+
example: abc12345-1234-1234-1234-abc123456789
64534+
type: string
64535+
type:
64536+
$ref: "#/components/schemas/SyntheticsFastTestResultType"
64537+
type: object
64538+
SyntheticsFastTestResultDetail:
64539+
description: |-
64540+
Detailed result data for the fast test run. The exact shape of nested fields
64541+
(`request`, `response`, `assertions`, etc.) depends on the test subtype.
64542+
properties:
64543+
assertions:
64544+
description: Results of each assertion evaluated during the test.
64545+
items:
64546+
$ref: "#/components/schemas/SyntheticsFastTestAssertionResult"
64547+
type: array
64548+
call_type:
64549+
description: gRPC call type (for example, `unary`, `healthCheck`, or `reflection`).
64550+
type: string
64551+
cert:
64552+
additionalProperties: {}
64553+
description: TLS certificate details, present for SSL tests.
64554+
type: object
64555+
duration:
64556+
description: Total duration of the test in milliseconds.
64557+
format: double
64558+
type: number
64559+
failure:
64560+
$ref: "#/components/schemas/SyntheticsFastTestResultFailure"
64561+
finished_at:
64562+
description: Unix timestamp (ms) of when the test finished.
64563+
format: int64
64564+
type: integer
64565+
id:
64566+
description: The result ID. Set to the fast test UUID because no persistent result ID exists for fast tests.
64567+
type: string
64568+
is_fast_retry:
64569+
description: Whether this result is from an automatic fast retry.
64570+
type: boolean
64571+
request:
64572+
additionalProperties: {}
64573+
description: Details of the outgoing request made during the test.
64574+
type: object
64575+
resolved_ip:
64576+
description: IP address resolved for the target host.
64577+
example: "1.2.3.4"
64578+
type: string
64579+
response:
64580+
additionalProperties: {}
64581+
description: Details of the response received during the test.
64582+
type: object
64583+
run_type:
64584+
description: Run type indicating how this test was triggered (for example, `fast`).
64585+
type: string
64586+
started_at:
64587+
description: Unix timestamp (ms) of when the test started.
64588+
format: int64
64589+
type: integer
64590+
status:
64591+
description: Status of the test result (`passed` or `failed`).
64592+
example: passed
64593+
type: string
64594+
steps:
64595+
description: Step results for multistep API tests.
64596+
items:
64597+
$ref: "#/components/schemas/SyntheticsFastTestStepResult"
64598+
type: array
64599+
timings:
64600+
additionalProperties: {}
64601+
description: Timing breakdown of the test request phases (for example, DNS, TCP, TLS, first byte).
64602+
type: object
64603+
traceroute:
64604+
description: Traceroute hop results, present for ICMP and TCP tests.
64605+
items:
64606+
$ref: "#/components/schemas/SyntheticsFastTestTracerouteHop"
64607+
type: array
64608+
triggered_at:
64609+
description: Unix timestamp (ms) of when the test was triggered.
64610+
format: int64
64611+
type: integer
64612+
tunnel:
64613+
description: Whether the test was run through a Synthetics tunnel.
64614+
type: boolean
64615+
type: object
64616+
SyntheticsFastTestResultDevice:
64617+
description: Device information for browser-based fast tests.
64618+
properties:
64619+
id:
64620+
description: Device identifier.
64621+
example: chrome.laptop_large
64622+
type: string
64623+
name:
64624+
description: Display name of the device.
64625+
example: Laptop Large
64626+
type: string
64627+
type: object
64628+
SyntheticsFastTestResultFailure:
64629+
description: Failure details if the fast test did not pass.
64630+
properties:
64631+
code:
64632+
description: Error code identifying the failure type.
64633+
example: TIMEOUT
64634+
type: string
64635+
message:
64636+
description: Human-readable description of the failure.
64637+
example: Connection timed out
64638+
type: string
64639+
type: object
64640+
SyntheticsFastTestResultLocation:
64641+
description: Location from which the fast test was executed.
64642+
properties:
64643+
id:
64644+
description: ID of the location.
64645+
example: aws:us-east-1
64646+
type: string
64647+
name:
64648+
description: Display name of the location.
64649+
example: N. Virginia (AWS)
64650+
type: string
64651+
version:
64652+
description: Agent version running at this location.
64653+
type: string
64654+
worker_id:
64655+
description: Identifier of the specific worker that ran the test.
64656+
type: string
64657+
type: object
64658+
SyntheticsFastTestResultType:
64659+
default: result
64660+
description: JSON:API type for a fast test result.
64661+
enum:
64662+
- result
64663+
example: result
64664+
type: string
64665+
x-enum-varnames:
64666+
- RESULT
64667+
SyntheticsFastTestStepResult:
64668+
additionalProperties: {}
64669+
description: Result of a single step in a multistep fast test run.
64670+
type: object
64671+
SyntheticsFastTestSubType:
64672+
description: Subtype of the Synthetic test that produced this result.
64673+
enum:
64674+
- dns
64675+
- grpc
64676+
- http
64677+
- icmp
64678+
- mcp
64679+
- multi
64680+
- ssl
64681+
- tcp
64682+
- udp
64683+
- websocket
64684+
example: http
64685+
type: string
64686+
x-enum-varnames:
64687+
- DNS
64688+
- GRPC
64689+
- HTTP
64690+
- ICMP
64691+
- MCP
64692+
- MULTI
64693+
- SSL
64694+
- TCP
64695+
- UDP
64696+
- WEBSOCKET
64697+
SyntheticsFastTestTracerouteHop:
64698+
additionalProperties: {}
64699+
description: A single traceroute hop result from a fast test run.
64700+
type: object
6448964701
SyntheticsGlobalVariable:
6449064702
description: Synthetic global variable.
6449164703
properties:
@@ -106234,6 +106446,50 @@ paths:
106234106446
operator: OR
106235106447
permissions:
106236106448
- synthetics_write
106449+
/api/v2/synthetics/tests/fast/{id}:
106450+
get:
106451+
operationId: GetSyntheticsFastTestResult
106452+
parameters:
106453+
- description: The UUID of the fast test to retrieve the result for.
106454+
in: path
106455+
name: id
106456+
required: true
106457+
schema:
106458+
example: abc12345-1234-1234-1234-abc123456789
106459+
type: string
106460+
responses:
106461+
"200":
106462+
content:
106463+
application/json:
106464+
schema:
106465+
$ref: "#/components/schemas/SyntheticsFastTestResult"
106466+
description: OK
106467+
"400":
106468+
content:
106469+
application/json:
106470+
schema:
106471+
$ref: "#/components/schemas/APIErrorResponse"
106472+
description: API error response.
106473+
"404":
106474+
content:
106475+
application/json:
106476+
schema:
106477+
$ref: "#/components/schemas/APIErrorResponse"
106478+
description: API error response.
106479+
"429":
106480+
$ref: "#/components/responses/TooManyRequestsResponse"
106481+
security:
106482+
- apiKeyAuth: []
106483+
appKeyAuth: []
106484+
- AuthZ:
106485+
- synthetics_read
106486+
summary: Get a fast test result
106487+
tags:
106488+
- Synthetics
106489+
x-permission:
106490+
operator: OR
106491+
permissions:
106492+
- synthetics_read
106237106493
/api/v2/synthetics/tests/network:
106238106494
post:
106239106495
operationId: CreateSyntheticsNetworkTest
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
/**
2+
* Get a fast test result returns "OK" response
3+
*/
4+
5+
import { client, v2 } from "@datadog/datadog-api-client";
6+
7+
const configuration = client.createConfiguration();
8+
const apiInstance = new v2.SyntheticsApi(configuration);
9+
10+
const params: v2.SyntheticsApiGetSyntheticsFastTestResultRequest = {
11+
id: "abc12345-1234-1234-1234-abc123456789",
12+
};
13+
14+
apiInstance
15+
.getSyntheticsFastTestResult(params)
16+
.then((data: v2.SyntheticsFastTestResult) => {
17+
console.log(
18+
"API called successfully. Returned data: " + JSON.stringify(data)
19+
);
20+
})
21+
.catch((error: any) => console.error(error));

features/support/scenarios_model_mapping.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11168,6 +11168,13 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
1116811168
},
1116911169
"operationResponseType": "DeletedTestsResponse",
1117011170
},
11171+
"v2.GetSyntheticsFastTestResult": {
11172+
"id": {
11173+
"type": "string",
11174+
"format": "",
11175+
},
11176+
"operationResponseType": "SyntheticsFastTestResult",
11177+
},
1117111178
"v2.CreateSyntheticsNetworkTest": {
1117211179
"body": {
1117311180
"type": "SyntheticsNetworkTestEditRequest",

features/v2/synthetics.feature

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,20 @@ Feature: Synthetics
119119
When the request is sent
120120
Then the response status is 200 OK
121121

122+
@generated @skip @team:DataDog/synthetics-managing
123+
Scenario: Get a fast test result returns "API error response." response
124+
Given new "GetSyntheticsFastTestResult" request
125+
And request contains "id" parameter from "REPLACE.ME"
126+
When the request is sent
127+
Then the response status is 404 API error response.
128+
129+
@generated @skip @team:DataDog/synthetics-managing
130+
Scenario: Get a fast test result returns "OK" response
131+
Given new "GetSyntheticsFastTestResult" request
132+
And request contains "id" parameter from "REPLACE.ME"
133+
When the request is sent
134+
Then the response status is 200 OK
135+
122136
@generated @skip @team:DataDog/synthetics-managing
123137
Scenario: Get a suite returns "API error response." response
124138
Given new "GetSyntheticsSuite" request

features/v2/undo.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5864,6 +5864,12 @@
58645864
"type": "idempotent"
58655865
}
58665866
},
5867+
"GetSyntheticsFastTestResult": {
5868+
"tag": "Synthetics",
5869+
"undo": {
5870+
"type": "safe"
5871+
}
5872+
},
58675873
"CreateSyntheticsNetworkTest": {
58685874
"tag": "Synthetics",
58695875
"undo": {

0 commit comments

Comments
 (0)