Add GetScheduleOnCallUser specs (#2556)

Co-authored-by: ci.datadog-api-spec <[email protected]>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-05-12 09:40:13.024429",
-            "spec_repo_commit": "c4d0aeef"
+            "regenerated": "2025-05-13 01:19:26.571134",
+            "spec_repo_commit": "dc3b522f"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-05-12 09:40:13.041082",
-            "spec_repo_commit": "c4d0aeef"
+            "regenerated": "2025-05-13 01:19:26.586009",
+            "spec_repo_commit": "dc3b522f"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -36060,6 +36060,115 @@ components:
           description: Link to the Incident created on ServiceNow
           type: string
       type: object
+    Shift:
+      description: The definition of `Shift` object.
+      example:
+        data:
+          attributes:
+            end: '2025-05-07T03:53:01.206662873Z'
+            start: '2025-05-07T02:53:01.206662814Z'
+          id: 00000000-0000-0000-0000-000000000000
+          relationships:
+            user:
+              data:
+                id: 00000000-aba1-0000-0000-000000000000
+                type: users
+          type: shifts
+        included:
+        - attributes:
+            email: [email protected]
+            name: User 1
+            status: ''
+          id: 00000000-aba1-0000-0000-000000000000
+          type: users
+      properties:
+        data:
+          $ref: '#/components/schemas/ShiftData'
+          nullable: true
+        included:
+          description: The `Shift` `included`.
+          items:
+            $ref: '#/components/schemas/ShiftIncluded'
+          type: array
+      type: object
+    ShiftData:
+      description: The definition of `ShiftData` object.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/ShiftDataAttributes'
+        id:
+          description: The `ShiftData` `id`.
+          type: string
+        relationships:
+          $ref: '#/components/schemas/ShiftDataRelationships'
+        type:
+          $ref: '#/components/schemas/ShiftDataType'
+      required:
+      - type
+      type: object
+    ShiftDataAttributes:
+      description: The definition of `ShiftDataAttributes` object.
+      properties:
+        end:
+          description: The end time of the shift.
+          format: date-time
+          type: string
+        start:
+          description: The start time of the shift.
+          format: date-time
+          type: string
+      type: object
+    ShiftDataRelationships:
+      description: The definition of `ShiftDataRelationships` object.
+      properties:
+        user:
+          $ref: '#/components/schemas/ShiftDataRelationshipsUser'
+      type: object
+    ShiftDataRelationshipsUser:
+      description: Defines the relationship between a shift and the user who is working
+        that shift.
+      properties:
+        data:
+          $ref: '#/components/schemas/ShiftDataRelationshipsUserData'
+      required:
+      - data
+      type: object
+    ShiftDataRelationshipsUserData:
+      description: Represents a reference to the user assigned to this shift, containing
+        the user's ID and resource type.
+      properties:
+        id:
+          description: Specifies the unique identifier of the user.
+          example: 00000000-0000-0000-0000-000000000000
+          type: string
+        type:
+          $ref: '#/components/schemas/ShiftDataRelationshipsUserDataType'
+      required:
+      - type
+      - id
+      type: object
+    ShiftDataRelationshipsUserDataType:
+      default: users
+      description: Indicates that the related resource is of type 'users'.
+      enum:
+      - users
+      example: users
+      type: string
+      x-enum-varnames:
+      - USERS
+    ShiftDataType:
+      default: shifts
+      description: Indicates that the resource is of type 'shifts'.
+      enum:
+      - shifts
+      example: shifts
+      type: string
+      x-enum-varnames:
+      - SHIFTS
+    ShiftIncluded:
+      description: The definition of `ShiftIncluded` object.
+      oneOf:
+      - $ref: '#/components/schemas/ScheduleUser'
     SingleAggregatedConnectionResponseArray:
       description: List of aggregated connections.
       example:
@@ -51922,6 +52031,56 @@ paths:
         operator: AND
         permissions:
         - on_call_write
+  /api/v2/on-call/schedules/{schedule_id}/on-call:
+    get:
+      description: Retrieves the user who is on-call for the specified schedule at
+        a given time.
+      operationId: GetScheduleOnCallUser
+      parameters:
+      - description: 'Specifies related resources to include in the response as a
+          comma-separated list. Allowed value: `user`.'
+        in: query
+        name: include
+        schema:
+          type: string
+      - description: The ID of the schedule.
+        in: path
+        name: schedule_id
+        required: true
+        schema:
+          example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
+          type: string
+      - description: Retrieves the on-call user at the given timestamp (ISO-8601).
+          Defaults to the current time if omitted."
+        in: query
+        name: filter[at_ts]
+        schema:
+          example: '2025-05-07T02:53:01Z'
+          type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Shift'
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '401':
+          $ref: '#/components/responses/UnauthorizedResponse'
+        '403':
+          $ref: '#/components/responses/ForbiddenResponse'
+        '404':
+          $ref: '#/components/responses/NotFoundResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ: []
+      summary: Get the schedule of an on-call user
+      tags:
+      - On-Call
   /api/v2/on-call/teams/{team_id}/routing-rules:
     get:
       description: Get a team's on-call routing rules

docs/datadog_api_client.v2.model.rst

@@ -15593,6 +15593,69 @@ datadog\_api\_client.v2.model.service\_now\_ticket\_result module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.shift module
+------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shift
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shift\_data module
+------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shift_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shift\_data\_attributes module
+------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shift_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shift\_data\_relationships module
+---------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shift_data_relationships
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shift\_data\_relationships\_user module
+---------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shift_data_relationships_user
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shift\_data\_relationships\_user\_data module
+---------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shift_data_relationships_user_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shift\_data\_relationships\_user\_data\_type module
+---------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shift_data_relationships_user_data_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shift\_data\_type module
+------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shift_data_type
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.shift\_included module
+----------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.shift_included
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.single\_aggregated\_connection\_response\_array module
 ------------------------------------------------------------------------------------
 

examples/v2/on-call/GetScheduleOnCallUser.py

@@ -0,0 +1,19 @@
+"""
+Get the schedule of an on-call user returns "OK" response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.on_call_api import OnCallApi
+
+# there is a valid "schedule" in the system
+SCHEDULE_DATA_ID = environ["SCHEDULE_DATA_ID"]
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = OnCallApi(api_client)
+    response = api_instance.get_schedule_on_call_user(
+        schedule_id=SCHEDULE_DATA_ID,
+    )
+
+    print(response)

src/datadog_api_client/v2/api/on_call_api.py

@@ -17,6 +17,7 @@
 from datadog_api_client.v2.model.schedule import Schedule
 from datadog_api_client.v2.model.schedule_create_request import ScheduleCreateRequest
 from datadog_api_client.v2.model.schedule_update_request import ScheduleUpdateRequest
+from datadog_api_client.v2.model.shift import Shift
 from datadog_api_client.v2.model.team_routing_rules import TeamRoutingRules
 from datadog_api_client.v2.model.team_routing_rules_request import TeamRoutingRulesRequest
 
@@ -212,6 +213,39 @@ def __init__(self, api_client=None):
             api_client=api_client,
         )
 
+        self._get_schedule_on_call_user_endpoint = _Endpoint(
+            settings={
+                "response_type": (Shift,),
+                "auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
+                "endpoint_path": "/api/v2/on-call/schedules/{schedule_id}/on-call",
+                "operation_id": "get_schedule_on_call_user",
+                "http_method": "GET",
+                "version": "v2",
+            },
+            params_map={
+                "include": {
+                    "openapi_types": (str,),
+                    "attribute": "include",
+                    "location": "query",
+                },
+                "schedule_id": {
+                    "required": True,
+                    "openapi_types": (str,),
+                    "attribute": "schedule_id",
+                    "location": "path",
+                },
+                "filter_at_ts": {
+                    "openapi_types": (str,),
+                    "attribute": "filter[at_ts]",
+                    "location": "query",
+                },
+            },
+            headers_map={
+                "accept": ["application/json"],
+            },
+            api_client=api_client,
+        )
+
         self._set_on_call_team_routing_rules_endpoint = _Endpoint(
             settings={
                 "response_type": (TeamRoutingRules,),
@@ -457,6 +491,36 @@ def get_on_call_team_routing_rules(
 
         return self._get_on_call_team_routing_rules_endpoint.call_with_http_info(**kwargs)
 
+    def get_schedule_on_call_user(
+        self,
+        schedule_id: str,
+        *,
+        include: Union[str, UnsetType] = unset,
+        filter_at_ts: Union[str, UnsetType] = unset,
+    ) -> Shift:
+        """Get the schedule of an on-call user.
+
+        Retrieves the user who is on-call for the specified schedule at a given time.
+
+        :param schedule_id: The ID of the schedule.
+        :type schedule_id: str
+        :param include: Specifies related resources to include in the response as a comma-separated list. Allowed value: ``user``.
+        :type include: str, optional
+        :param filter_at_ts: Retrieves the on-call user at the given timestamp (ISO-8601). Defaults to the current time if omitted."
+        :type filter_at_ts: str, optional
+        :rtype: Shift
+        """
+        kwargs: Dict[str, Any] = {}
+        if include is not unset:
+            kwargs["include"] = include
+
+        kwargs["schedule_id"] = schedule_id
+
+        if filter_at_ts is not unset:
+            kwargs["filter_at_ts"] = filter_at_ts
+
+        return self._get_schedule_on_call_user_endpoint.call_with_http_info(**kwargs)
+
     def set_on_call_team_routing_rules(
         self,
         team_id: str,