Skip to content

Commit 175cc50

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add text field in synthetics search endpoint (#3239)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent e0ef0b7 commit 175cc50

7 files changed

Lines changed: 22 additions & 5 deletions

File tree

.generated-info

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"spec_repo_commit": "bd643af",
3-
"generated": "2025-07-22 16:43:56.388"
2+
"spec_repo_commit": "04d09cb",
3+
"generated": "2025-07-23 09:23:55.056"
44
}

.generator/schemas/v1/openapi.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33827,6 +33827,12 @@ paths:
3382733827
description: Search for Synthetic tests and Test Suites.
3382833828
operationId: SearchTests
3382933829
parameters:
33830+
- description: The search query.
33831+
in: query
33832+
name: text
33833+
required: false
33834+
schema:
33835+
type: string
3383033836
- description: If true, include the full configuration for each test in the
3383133837
response.
3383233838
in: query

api/datadogV1/api_synthetics.go

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2246,6 +2246,7 @@ func (a *SyntheticsApi) PatchTest(ctx _context.Context, publicId string, body Sy
22462246

22472247
// SearchTestsOptionalParameters holds optional parameters for SearchTests.
22482248
type SearchTestsOptionalParameters struct {
2249+
Text *string
22492250
IncludeFullConfig *bool
22502251
SearchSuites *bool
22512252
FacetsOnly *bool
@@ -2260,6 +2261,12 @@ func NewSearchTestsOptionalParameters() *SearchTestsOptionalParameters {
22602261
return &this
22612262
}
22622263

2264+
// WithText sets the corresponding parameter name and returns the struct.
2265+
func (r *SearchTestsOptionalParameters) WithText(text string) *SearchTestsOptionalParameters {
2266+
r.Text = &text
2267+
return r
2268+
}
2269+
22632270
// WithIncludeFullConfig sets the corresponding parameter name and returns the struct.
22642271
func (r *SearchTestsOptionalParameters) WithIncludeFullConfig(includeFullConfig bool) *SearchTestsOptionalParameters {
22652272
r.IncludeFullConfig = &includeFullConfig
@@ -2323,6 +2330,9 @@ func (a *SyntheticsApi) SearchTests(ctx _context.Context, o ...SearchTestsOption
23232330
localVarHeaderParams := make(map[string]string)
23242331
localVarQueryParams := _neturl.Values{}
23252332
localVarFormParams := _neturl.Values{}
2333+
if optionalParams.Text != nil {
2334+
localVarQueryParams.Add("text", datadog.ParameterToString(*optionalParams.Text, ""))
2335+
}
23262336
if optionalParams.IncludeFullConfig != nil {
23272337
localVarQueryParams.Add("include_full_config", datadog.ParameterToString(*optionalParams.IncludeFullConfig, ""))
23282338
}

examples/v1/synthetics/SearchTests_195957771.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ func main() {
1717
configuration := datadog.NewConfiguration()
1818
apiClient := datadog.NewAPIClient(configuration)
1919
api := datadogV1.NewSyntheticsApi(apiClient)
20-
resp, r, err := api.SearchTests(ctx, *datadogV1.NewSearchTestsOptionalParameters().WithIncludeFullConfig(true).WithSearchSuites(true).WithFacetsOnly(true).WithStart(10).WithCount(5).WithSort("name,desc"))
20+
resp, r, err := api.SearchTests(ctx, *datadogV1.NewSearchTestsOptionalParameters().WithText("tag:value").WithIncludeFullConfig(true).WithSearchSuites(true).WithFacetsOnly(true).WithStart(10).WithCount(5).WithSort("name,desc"))
2121

2222
if err != nil {
2323
fmt.Fprintf(os.Stderr, "Error when calling `SyntheticsApi.SearchTests`: %v\n", err)
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
2025-07-01T15:52:56.329Z
1+
2025-07-22T14:56:49.377Z

tests/scenarios/cassettes/TestScenarios/v1/Feature_Synthetics/Scenario_Search_Synthetic_tests_with_boolean_query_parameters.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ interactions:
77
- application/json
88
id: 0
99
method: GET
10-
url: https://api.datadoghq.com/api/v1/synthetics/tests/search?include_full_config=true&search_suites=true&facets_only=true&start=10&count=5&sort=name%2Cdesc
10+
url: https://api.datadoghq.com/api/v1/synthetics/tests/search?text=tag%3Avalue&include_full_config=true&search_suites=true&facets_only=true&start=10&count=5&sort=name%2Cdesc
1111
response:
1212
body: '{"tests":[],"total":0,"facets":[]}'
1313
code: 200

tests/scenarios/features/v1/synthetics.feature

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -806,6 +806,7 @@ Feature: Synthetics
806806
@team:DataDog/synthetics-ct
807807
Scenario: Search Synthetic tests with boolean query parameters
808808
Given new "SearchTests" request
809+
And request contains "text" parameter with value "tag:value"
809810
And request contains "include_full_config" parameter with value true
810811
And request contains "search_suites" parameter with value true
811812
And request contains "facets_only" parameter with value true

0 commit comments

Comments
 (0)