Add Synthetics endpoint to fetch uptimes in API spec (#1984)

* add support for top level indexing

* Regenerate client from commit 3b4747f4 of spec repo

---------

Co-authored-by: Sherzod Karimov <sherzod.karimov@datadoghq.com>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: 3 people

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-10-02 13:39:18.542573",
-            "spec_repo_commit": "e02e4f4c"
+            "regenerated": "2024-10-02 14:33:47.262024",
+            "spec_repo_commit": "3b4747f4"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-10-02 13:39:18.559270",
-            "spec_repo_commit": "e02e4f4c"
+            "regenerated": "2024-10-02 14:33:47.276476",
+            "spec_repo_commit": "3b4747f4"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -15194,6 +15194,32 @@ components:
       - EDGE_LAPTOP_LARGE
       - EDGE_TABLET
       - EDGE_MOBILE_SMALL
+    SyntheticsFetchUptimesPayload:
+      description: Object containing IDs of Synthetic tests and a timeframe.
+      properties:
+        from_ts:
+          description: Timestamp in seconds (Unix epoch) for the start of uptime.
+          example: 0
+          format: int64
+          type: integer
+        public_ids:
+          description: An array of Synthetic test IDs you want to delete.
+          example: []
+          items:
+            description: A Synthetic test ID.
+            example: abc-def-123
+            type: string
+          type: array
+        to_ts:
+          description: Timestamp in seconds (Unix epoch) for the end of uptime.
+          example: 0
+          format: int64
+          type: integer
+      required:
+      - from_ts
+      - to_ts
+      - public_ids
+      type: object
     SyntheticsGetAPITestLatestResultsResponse:
       description: Object with the latest Synthetic API test run.
       properties:
@@ -17283,6 +17309,24 @@ components:
       description: String Port number to use when performing the test. Supports templated
         variables.
       type: string
+    SyntheticsTestUptime:
+      description: Object containing the uptime for a Synthetic test ID.
+      properties:
+        from_ts:
+          description: Timestamp in seconds for the start of uptime.
+          format: int64
+          type: integer
+        overall:
+          $ref: '#/components/schemas/SyntheticsUptime'
+        public_id:
+          description: A Synthetic test ID.
+          example: abc-def-123
+          type: string
+        to_ts:
+          description: Timestamp in seconds for the end of uptime.
+          format: int64
+          type: integer
+      type: object
     SyntheticsTiming:
       description: 'Object containing all metrics and their values collected for a
         Synthetic API test.
@@ -17406,6 +17450,62 @@ components:
         new_status:
           $ref: '#/components/schemas/SyntheticsTestPauseStatus'
       type: object
+    SyntheticsUptime:
+      description: Object containing the uptime information.
+      properties:
+        errors:
+          description: An array of error objects returned while querying the history
+            data for the service level objective.
+          items:
+            $ref: '#/components/schemas/SLOHistoryResponseErrorWithType'
+          nullable: true
+          type: array
+        group:
+          description: The location name
+          example: name
+          type: string
+        history:
+          description: 'The state transition history for the monitor, represented
+            as an array of
+
+            pairs. Each pair is an array where the first element is the transition
+            timestamp
+
+            in Unix epoch format (integer) and the second element is the state (integer).
+
+            For the state, an integer value of `0` indicates uptime, `1` indicates
+            downtime,
+
+            and `2` indicates no data.'
+          example:
+          - - 1579212382
+            - 0
+          items:
+            description: An array of transitions
+            example:
+            - 1579212382
+            - 0
+            items:
+              description: A timeseries data point which is a tuple of (timestamp,
+                value).
+              format: double
+              type: number
+            maxItems: 2
+            minItems: 2
+            type: array
+          type: array
+        span_precision:
+          description: The number of decimal places to which the SLI value is accurate
+            for the given from-to timestamps.
+          example: 2.0
+          format: double
+          type: number
+        uptime:
+          description: The overall uptime.
+          example: 99.99
+          format: double
+          type: number
+      type: object
     SyntheticsVariableParser:
       description: Details of the parser to use for the global variable.
       example:
@@ -32934,6 +33034,49 @@ paths:
         operator: OR
         permissions:
         - synthetics_write
+  /api/v1/synthetics/tests/uptimes:
+    post:
+      description: Fetch uptime for multiple Synthetic tests by ID.
+      operationId: FetchUptimes
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/SyntheticsFetchUptimesPayload'
+        description: Public ID list of the Synthetic tests and timeframe.
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                items:
+                  $ref: '#/components/schemas/SyntheticsTestUptime'
+                type: array
+          description: OK.
+        '400':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: '- JSON format is wrong'
+        '403':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: Forbidden
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - synthetics_read
+      summary: Fetch uptime for multiple tests
+      tags:
+      - Synthetics
+      x-codegen-request-body-name: body
   /api/v1/synthetics/tests/{public_id}:
     get:
       description: Get the detailed configuration associated with a Synthetic test.

cassettes/features/v1/synthetics/Fetch-uptime-for-multiple-tests-returns-JSON-format-is-wrong-response.frozen

@@ -0,0 +1 @@
+2024-10-02T14:22:00.562Z

cassettes/features/v1/synthetics/Fetch-uptime-for-multiple-tests-returns-JSON-format-is-wrong-response.yml

@@ -0,0 +1 @@
+2024-09-11T13:09:28.349Z

cassettes/features/v1/synthetics/Fetch-uptime-for-multiple-tests-returns-OK-response.frozen

@@ -0,0 +1,13 @@
+# Fetch uptime for multiple tests returns "OK." response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V1::SyntheticsAPI.new
+
+body = DatadogAPIClient::V1::SyntheticsFetchUptimesPayload.new({
+  from_ts: 1726041488,
+  public_ids: [
+    "p8m-9gw-nte",
+  ],
+  to_ts: 1726055954,
+})
+p api_instance.fetch_uptimes(body)

cassettes/features/v1/synthetics/Fetch-uptime-for-multiple-tests-returns-OK-response.yml

@@ -756,6 +756,9 @@
     "v1.TriggerCITests" => {
             "body" => "SyntheticsCITestBody",
     },
+    "v1.FetchUptimes" => {
+            "body" => "SyntheticsFetchUptimesPayload",
+    },
     "v1.GetTest" => {
             "public_id" => "String",
     },

examples/v1/synthetics/FetchUptimes.rb

@@ -8,6 +8,10 @@ def lookup(dotted_path)
     result = self
     dotted_path.split('.').each do |dot_part|
       dot_part.split('[').each do |part|
+        if part == ''
+          next
+        end
+
         if part.include?(']')
           index = part.to_i
           result = result[index]

features/scenarios_model_mapping.rb

@@ -469,6 +469,23 @@ Feature: Synthetics
     Then the response status is 200 OK
     And the response "name" is equal to "{{ synthetics_api_test.name }}-updated"
 
+  @team:DataDog/synthetics-ct
+  Scenario: Fetch uptime for multiple tests returns "- JSON format is wrong" response
+    Given new "FetchUptimes" request
+    And body with value {"from_ts": 0, "public_ids": [], "to_ts": 0}
+    When the request is sent
+    Then the response status is 400 - JSON format is wrong
+
+  @replay-only @team:DataDog/synthetics-ct
+  Scenario: Fetch uptime for multiple tests returns "OK." response
+    Given new "FetchUptimes" request
+    And body with value {"from_ts": 1726041488, "public_ids": ["p8m-9gw-nte"], "to_ts": 1726055954}
+    When the request is sent
+    Then the response status is 200 OK
+    And the response "[0].public_id" is equal to "p8m-9gw-nte"
+    And the response "[0].overall.uptime" is equal to 83.05682373046875
+    And the response "[0].overall.history" has length 2
+
   @generated @skip @team:DataDog/synthetics-ct
   Scenario: Get a Mobile test returns "- Synthetic Monitoring is not activated for the user" response
     Given new "GetMobileTest" request