Add SLO status and error budget remaining to search API (#1344)

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

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-02-14 19:39:22.891297",
-            "spec_repo_commit": "c0625360"
+            "regenerated": "2023-02-14 22:24:43.220610",
+            "spec_repo_commit": "7a7cb634"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-02-14 19:39:22.905029",
-            "spec_repo_commit": "c0625360"
+            "regenerated": "2023-02-14 22:24:43.240902",
+            "spec_repo_commit": "7a7cb634"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -9697,6 +9697,12 @@ components:
           description: Error message if SLO status or error budget could not be calculated.
           nullable: true
           type: string
+        error_budget_remaining:
+          description: Remaining error budget of the SLO in percentage.
+          example: 100
+          format: double
+          nullable: true
+          type: number
         indexed_at:
           description: 'timestamp (UNIX time in seconds) of when the SLO status and
             error budget
@@ -9711,7 +9717,10 @@ components:
           description: The amount of decimal places the SLI value is accurate to.
           example: 2
           format: int64
+          nullable: true
           type: integer
+        state:
+          $ref: '#/components/schemas/SLOState'
         status:
           description: The status of the SLO.
           example: 100
@@ -9728,6 +9737,7 @@ components:
       type: object
     SLORawErrorBudgetRemaining:
       description: Error budget remaining for an SLO.
+      nullable: true
       properties:
         unit:
           description: Error budget remaining unit.
@@ -9917,6 +9927,59 @@ components:
           format: double
           type: number
       type: object
+    SLOState:
+      description: State of the SLO.
+      enum:
+      - breached
+      - warning
+      - ok
+      - no_data
+      example: ok
+      type: string
+      x-enum-varnames:
+      - BREACHED
+      - WARNING
+      - OK
+      - NO_DATA
+    SLOStatus:
+      description: Status of the SLO's primary timeframe.
+      properties:
+        calculation_error:
+          description: Error message if SLO status or error budget could not be calculated.
+          nullable: true
+          type: string
+        error_budget_remaining:
+          description: Remaining error budget of the SLO in percentage.
+          example: 100
+          format: double
+          nullable: true
+          type: number
+        indexed_at:
+          description: 'timestamp (UNIX time in seconds) of when the SLO status and
+            error budget
+
+            were calculated.'
+          example: 1662496260
+          format: int64
+          type: integer
+        raw_error_budget_remaining:
+          $ref: '#/components/schemas/SLORawErrorBudgetRemaining'
+        sli:
+          description: The current service level indicator (SLI) of the SLO, also
+            known as 'status'. This is a percentage value from 0-100 (inclusive).
+          example: 100
+          format: double
+          nullable: true
+          type: number
+        span_precision:
+          description: The number of decimal places the SLI value is accurate to.
+          example: 2
+          format: int64
+          nullable: true
+          type: integer
+        state:
+          $ref: '#/components/schemas/SLOState'
+      type: object
     SLOThreshold:
       description: SLO thresholds (target and optionally warning) for a single time
         window.
@@ -10549,6 +10612,8 @@ components:
           type: array
         slo_type:
           $ref: '#/components/schemas/SLOType'
+        status:
+          $ref: '#/components/schemas/SLOStatus'
         team_tags:
           description: Tags with the `team` tag key.
           items:
@@ -25874,9 +25939,6 @@ paths:
       summary: Search for SLOs
       tags:
       - Service Level Objectives
-      x-unstable: '**Note**: This endpoint is in public beta.
-
-        If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
   /api/v1/slo/{slo_id}:
     delete:
       description: 'Permanently delete the specified service level objective object.

docs/datadog_api_client.v1.model.rst

@@ -3186,6 +3186,20 @@ slo\_response\_data
    :members:
    :show-inheritance:
 
+slo\_state
+----------
+
+.. automodule:: datadog_api_client.v1.model.slo_state
+   :members:
+   :show-inheritance:
+
+slo\_status
+-----------
+
+.. automodule:: datadog_api_client.v1.model.slo_status
+   :members:
+   :show-inheritance:
+
 slo\_threshold
 --------------
 

examples/v1/service-level-objectives/SearchSLO.py

@@ -10,7 +10,6 @@
 SLO_DATA_0_NAME = environ["SLO_DATA_0_NAME"]
 
 configuration = Configuration()
-configuration.unstable_operations["search_slo"] = True
 with ApiClient(configuration) as api_client:
     api_instance = ServiceLevelObjectivesApi(api_client)
     response = api_instance.search_slo(

src/datadog_api_client/configuration.py

@@ -221,7 +221,6 @@ def __init__(
         # Keep track of unstable operations
         self.unstable_operations = _UnstableOperations(
             {
-                "v1.search_slo": False,
                 "v2.list_events": False,
                 "v2.search_events": False,
                 "v2.create_incident": False,

src/datadog_api_client/v1/model/search_service_level_objective_attributes.py

@@ -19,6 +19,7 @@
     from datadog_api_client.v1.model.slo_overall_statuses import SLOOverallStatuses
     from datadog_api_client.v1.model.search_slo_query import SearchSLOQuery
     from datadog_api_client.v1.model.slo_type import SLOType
+    from datadog_api_client.v1.model.slo_status import SLOStatus
     from datadog_api_client.v1.model.search_slo_threshold import SearchSLOThreshold
 
 
@@ -29,6 +30,7 @@ def openapi_types(_):
         from datadog_api_client.v1.model.slo_overall_statuses import SLOOverallStatuses
         from datadog_api_client.v1.model.search_slo_query import SearchSLOQuery
         from datadog_api_client.v1.model.slo_type import SLOType
+        from datadog_api_client.v1.model.slo_status import SLOStatus
         from datadog_api_client.v1.model.search_slo_threshold import SearchSLOThreshold
 
         return {
@@ -45,6 +47,7 @@ def openapi_types(_):
             "query": (SearchSLOQuery,),
             "service_tags": ([str],),
             "slo_type": (SLOType,),
+            "status": (SLOStatus,),
             "team_tags": ([str],),
             "thresholds": ([SearchSLOThreshold],),
         }
@@ -63,6 +66,7 @@ def openapi_types(_):
         "query": "query",
         "service_tags": "service_tags",
         "slo_type": "slo_type",
+        "status": "status",
         "team_tags": "team_tags",
         "thresholds": "thresholds",
     }
@@ -86,6 +90,7 @@ def __init__(
         query: Union[SearchSLOQuery, none_type, UnsetType] = unset,
         service_tags: Union[List[str], UnsetType] = unset,
         slo_type: Union[SLOType, UnsetType] = unset,
+        status: Union[SLOStatus, UnsetType] = unset,
         team_tags: Union[List[str], UnsetType] = unset,
         thresholds: Union[List[SearchSLOThreshold], UnsetType] = unset,
         **kwargs,
@@ -145,6 +150,9 @@ def __init__(
         :param slo_type: The type of the service level objective.
         :type slo_type: SLOType, optional
 
+        :param status: Status of the SLO's primary timeframe.
+        :type status: SLOStatus, optional
+
         :param team_tags: Tags with the ``team`` tag key.
         :type team_tags: [str], optional
 
@@ -178,6 +186,8 @@ def __init__(
             kwargs["service_tags"] = service_tags
         if slo_type is not unset:
             kwargs["slo_type"] = slo_type
+        if status is not unset:
+            kwargs["status"] = status
         if team_tags is not unset:
             kwargs["team_tags"] = team_tags
         if thresholds is not unset:

src/datadog_api_client/v1/model/slo_overall_statuses.py

@@ -16,30 +16,36 @@
 
 if TYPE_CHECKING:
     from datadog_api_client.v1.model.slo_raw_error_budget_remaining import SLORawErrorBudgetRemaining
+    from datadog_api_client.v1.model.slo_state import SLOState
     from datadog_api_client.v1.model.slo_timeframe import SLOTimeframe
 
 
 class SLOOverallStatuses(ModelNormal):
     @cached_property
     def openapi_types(_):
         from datadog_api_client.v1.model.slo_raw_error_budget_remaining import SLORawErrorBudgetRemaining
+        from datadog_api_client.v1.model.slo_state import SLOState
         from datadog_api_client.v1.model.slo_timeframe import SLOTimeframe
 
         return {
             "error": (str, none_type),
+            "error_budget_remaining": (float, none_type),
             "indexed_at": (int,),
             "raw_error_budget_remaining": (SLORawErrorBudgetRemaining,),
-            "span_precision": (int,),
+            "span_precision": (int, none_type),
+            "state": (SLOState,),
             "status": (float, none_type),
             "target": (float,),
             "timeframe": (SLOTimeframe,),
         }
 
     attribute_map = {
         "error": "error",
+        "error_budget_remaining": "error_budget_remaining",
         "indexed_at": "indexed_at",
         "raw_error_budget_remaining": "raw_error_budget_remaining",
         "span_precision": "span_precision",
+        "state": "state",
         "status": "status",
         "target": "target",
         "timeframe": "timeframe",
@@ -48,9 +54,11 @@ def openapi_types(_):
     def __init__(
         self_,
         error: Union[str, none_type, UnsetType] = unset,
+        error_budget_remaining: Union[float, none_type, UnsetType] = unset,
         indexed_at: Union[int, UnsetType] = unset,
-        raw_error_budget_remaining: Union[SLORawErrorBudgetRemaining, UnsetType] = unset,
-        span_precision: Union[int, UnsetType] = unset,
+        raw_error_budget_remaining: Union[SLORawErrorBudgetRemaining, none_type, UnsetType] = unset,
+        span_precision: Union[int, none_type, UnsetType] = unset,
+        state: Union[SLOState, UnsetType] = unset,
         status: Union[float, none_type, UnsetType] = unset,
         target: Union[float, UnsetType] = unset,
         timeframe: Union[SLOTimeframe, UnsetType] = unset,
@@ -62,15 +70,21 @@ def __init__(
         :param error: Error message if SLO status or error budget could not be calculated.
         :type error: str, none_type, optional
 
+        :param error_budget_remaining: Remaining error budget of the SLO in percentage.
+        :type error_budget_remaining: float, none_type, optional
+
         :param indexed_at: timestamp (UNIX time in seconds) of when the SLO status and error budget
             were calculated.
         :type indexed_at: int, optional
 
         :param raw_error_budget_remaining: Error budget remaining for an SLO.
-        :type raw_error_budget_remaining: SLORawErrorBudgetRemaining, optional
+        :type raw_error_budget_remaining: SLORawErrorBudgetRemaining, none_type, optional
 
         :param span_precision: The amount of decimal places the SLI value is accurate to.
-        :type span_precision: int, optional
+        :type span_precision: int, none_type, optional
+
+        :param state: State of the SLO.
+        :type state: SLOState, optional
 
         :param status: The status of the SLO.
         :type status: float, none_type, optional
@@ -83,12 +97,16 @@ def __init__(
         """
         if error is not unset:
             kwargs["error"] = error
+        if error_budget_remaining is not unset:
+            kwargs["error_budget_remaining"] = error_budget_remaining
         if indexed_at is not unset:
             kwargs["indexed_at"] = indexed_at
         if raw_error_budget_remaining is not unset:
             kwargs["raw_error_budget_remaining"] = raw_error_budget_remaining
         if span_precision is not unset:
             kwargs["span_precision"] = span_precision
+        if state is not unset:
+            kwargs["state"] = state
         if status is not unset:
             kwargs["status"] = status
         if target is not unset:

src/datadog_api_client/v1/model/slo_raw_error_budget_remaining.py

@@ -14,6 +14,8 @@
 
 
 class SLORawErrorBudgetRemaining(ModelNormal):
+    _nullable = True
+
     @cached_property
     def openapi_types(_):
         return {

src/datadog_api_client/v1/model/slo_state.py

@@ -0,0 +1,44 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+
+from datadog_api_client.model_utils import (
+    ModelSimple,
+    cached_property,
+)
+
+from typing import ClassVar
+
+
+class SLOState(ModelSimple):
+    """
+    State of the SLO.
+
+    :param value: Must be one of ["breached", "warning", "ok", "no_data"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "breached",
+        "warning",
+        "ok",
+        "no_data",
+    }
+    BREACHED: ClassVar["SLOState"]
+    WARNING: ClassVar["SLOState"]
+    OK: ClassVar["SLOState"]
+    NO_DATA: ClassVar["SLOState"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+SLOState.BREACHED = SLOState("breached")
+SLOState.WARNING = SLOState("warning")
+SLOState.OK = SLOState("ok")
+SLOState.NO_DATA = SLOState("no_data")