Create OpenAPI for SLO status endpoint (#3093)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -346,6 +346,16 @@ components:
       required: true
       schema:
         type: string
+    DisableCorrections:
+      description: Whether to exclude correction windows from the SLO status calculation.
+        Defaults to false.
+      in: query
+      name: disable_corrections
+      required: false
+      schema:
+        default: false
+        example: false
+        type: boolean
     EntityID:
       description: UUID or Entity Ref.
       in: path
@@ -457,6 +467,15 @@ components:
       required: false
       schema:
         $ref: '#/components/schemas/RelationType'
+    FromTimestamp:
+      description: The starting timestamp for the SLO status query in epoch seconds.
+      in: query
+      name: from_ts
+      required: true
+      schema:
+        example: 1690901870
+        format: int64
+        type: integer
     GCPSTSServiceAccountID:
       description: Your GCP STS enabled service account's unique ID.
       in: path
@@ -1104,6 +1123,14 @@ components:
       required: false
       schema:
         type: boolean
+    SloID:
+      description: The ID of the SLO.
+      in: path
+      name: slo_id
+      required: true
+      schema:
+        example: 00000000-0000-0000-0000-000000000000
+        type: string
     SpansMetricIDParameter:
       description: The name of the span-based metric.
       in: path
@@ -1125,6 +1152,15 @@ components:
       required: true
       schema:
         type: string
+    ToTimestamp:
+      description: The ending timestamp for the SLO status query in epoch seconds.
+      in: query
+      name: to_ts
+      required: true
+      schema:
+        example: 1706803070
+        format: int64
+        type: integer
     UserID:
       description: The ID of the user.
       in: path
@@ -46850,6 +46886,22 @@ components:
             from the other indexes
           type: string
       type: object
+    RawErrorBudgetRemaining:
+      description: The raw error budget remaining for the SLO.
+      properties:
+        unit:
+          description: The unit of the error budget (for example, `seconds`, `requests`).
+          example: seconds
+          type: string
+        value:
+          description: The numeric value of the remaining error budget.
+          example: 86400.5
+          format: double
+          type: number
+      required:
+      - value
+      - unit
+      type: object
     ReadinessGate:
       description: Used to merge multiple branches into a single branch.
       properties:
@@ -57827,6 +57879,70 @@ components:
       required:
       - attributes
       type: object
+    SloStatusData:
+      description: The data portion of the SLO status response.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/SloStatusDataAttributes'
+        id:
+          description: The ID of the SLO.
+          example: 00000000-0000-0000-0000-000000000000
+          type: string
+        type:
+          $ref: '#/components/schemas/SloStatusType'
+      required:
+      - id
+      - type
+      - attributes
+      type: object
+    SloStatusDataAttributes:
+      description: The attributes of the SLO status.
+      properties:
+        error_budget_remaining:
+          description: The percentage of error budget remaining.
+          example: 99.5
+          format: double
+          type: number
+        raw_error_budget_remaining:
+          $ref: '#/components/schemas/RawErrorBudgetRemaining'
+        sli:
+          description: The current Service Level Indicator (SLI) value as a percentage.
+          example: 99.95
+          format: double
+          type: number
+        span_precision:
+          description: The precision of the time span in seconds.
+          example: 2
+          format: int64
+          type: integer
+        state:
+          description: The current state of the SLO (for example, `breached`, `warning`,
+            `ok`).
+          example: ok
+          type: string
+      required:
+      - sli
+      - error_budget_remaining
+      - raw_error_budget_remaining
+      - state
+      - span_precision
+      type: object
+    SloStatusResponse:
+      description: The SLO status response.
+      properties:
+        data:
+          $ref: '#/components/schemas/SloStatusData'
+      required:
+      - data
+      type: object
+    SloStatusType:
+      description: The type of the SLO status resource.
+      enum:
+      - slo_status
+      example: slo_status
+      type: string
+      x-enum-varnames:
+      - SLO_STATUS
     SoftwareCatalogTriggerWrapper:
       description: Schema for a Software Catalog-based trigger.
       properties:
@@ -94439,6 +94555,63 @@ paths:
       x-unstable: '**Note**: This feature is in private beta. To request access, use
         the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
         docs.'
+  /api/v2/slo/{slo_id}/status:
+    get:
+      description: 'Get the status of a Service Level Objective (SLO) for a given
+        time period.
+
+
+        This endpoint returns the current SLI value, error budget remaining, and other
+        status information for the specified SLO.'
+      operationId: GetSloStatus
+      parameters:
+      - $ref: '#/components/parameters/SloID'
+      - $ref: '#/components/parameters/FromTimestamp'
+      - $ref: '#/components/parameters/ToTimestamp'
+      - $ref: '#/components/parameters/DisableCorrections'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SloStatusResponse'
+          description: OK
+        '400':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
+          description: Bad Request
+        '403':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
+          description: Forbidden
+        '404':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
+          description: Not Found
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - slos_read
+      summary: Get SLO status
+      tags:
+      - Service Level Objectives
+      x-permission:
+        operator: OR
+        permissions:
+        - slos_read
+      x-unstable: '**Note**: This endpoint is in public beta and it''s subject to
+        change.
+
+        If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
   /api/v2/spa/recommendations/{service}:
     get:
       description: This endpoint is currently experimental and restricted to Datadog

docs/datadog_api_client.v2.model.rst

@@ -20087,6 +20087,13 @@ datadog\_api\_client.v2.model.query\_users\_request\_data\_type module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.raw\_error\_budget\_remaining module
+------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.raw_error_budget_remaining
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.readiness\_gate module
 ----------------------------------------------------
 
@@ -25316,6 +25323,34 @@ datadog\_api\_client.v2.model.slo\_report\_status\_get\_response\_data module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.slo\_status\_data module
+------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.slo_status_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.slo\_status\_data\_attributes module
+------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.slo_status_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.slo\_status\_response module
+----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.slo_status_response
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.slo\_status\_type module
+------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.slo_status_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.software\_catalog\_trigger\_wrapper module
 ------------------------------------------------------------------------
 

examples/v2/service-level-objectives/GetSloStatus.py

@@ -0,0 +1,18 @@
+"""
+Get SLO status returns "OK" response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.service_level_objectives_api import ServiceLevelObjectivesApi
+
+configuration = Configuration()
+configuration.unstable_operations["get_slo_status"] = True
+with ApiClient(configuration) as api_client:
+    api_instance = ServiceLevelObjectivesApi(api_client)
+    response = api_instance.get_slo_status(
+        slo_id="00000000-0000-0000-0000-000000000000",
+        from_ts=1690901870,
+        to_ts=1706803070,
+    )
+
+    print(response)

src/datadog_api_client/configuration.py

@@ -407,6 +407,7 @@ def __init__(
                 "v2.create_slo_report_job": False,
                 "v2.get_slo_report": False,
                 "v2.get_slo_report_job_status": False,
+                "v2.get_slo_status": False,
                 "v2.get_spa_recommendations": False,
                 "v2.get_spa_recommendations_with_shard": False,
                 "v2.create_custom_rule": False,