Skip to content

Commit 2fedd1d

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Improve oncall schedule endpoint documentation (#2812)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent c486264 commit 2fedd1d

File tree

6 files changed

+13
-13
lines changed

6 files changed

+13
-13
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41720,7 +41720,7 @@ components:
4172041720
type: string
4172141721
type: object
4172241722
Shift:
41723-
description: The definition of `Shift` object.
41723+
description: An on-call shift with its associated data and relationships.
4172441724
example:
4172541725
data:
4172641726
attributes:
@@ -41751,7 +41751,7 @@ components:
4175141751
type: array
4175241752
type: object
4175341753
ShiftData:
41754-
description: The definition of `ShiftData` object.
41754+
description: Data for an on-call shift.
4175541755
properties:
4175641756
attributes:
4175741757
$ref: '#/components/schemas/ShiftDataAttributes'
@@ -41766,7 +41766,7 @@ components:
4176641766
- type
4176741767
type: object
4176841768
ShiftDataAttributes:
41769-
description: The definition of `ShiftDataAttributes` object.
41769+
description: Attributes for an on-call shift.
4177041770
properties:
4177141771
end:
4177241772
description: The end time of the shift.
@@ -41778,7 +41778,7 @@ components:
4177841778
type: string
4177941779
type: object
4178041780
ShiftDataRelationships:
41781-
description: The definition of `ShiftDataRelationships` object.
41781+
description: Relationships for an on-call shift.
4178241782
properties:
4178341783
user:
4178441784
$ref: '#/components/schemas/ShiftDataRelationshipsUser'
@@ -41825,7 +41825,7 @@ components:
4182541825
x-enum-varnames:
4182641826
- SHIFTS
4182741827
ShiftIncluded:
41828-
description: The definition of `ShiftIncluded` object.
41828+
description: Included data for shift operations.
4182941829
oneOf:
4183041830
- $ref: '#/components/schemas/ScheduleUser'
4183141831
SimpleMonitorUserTemplate:

src/datadog_api_client/v2/model/shift.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ def __init__(
4242
**kwargs,
4343
):
4444
"""
45-
The definition of ``Shift`` object.
45+
An on-call shift with its associated data and relationships.
4646
47-
:param data: The definition of ``ShiftData`` object.
47+
:param data: Data for an on-call shift.
4848
:type data: ShiftData, optional
4949
5050
:param included: The ``Shift`` ``included``.

src/datadog_api_client/v2/model/shift_data.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,15 @@ def __init__(
4949
**kwargs,
5050
):
5151
"""
52-
The definition of ``ShiftData`` object.
52+
Data for an on-call shift.
5353
54-
:param attributes: The definition of ``ShiftDataAttributes`` object.
54+
:param attributes: Attributes for an on-call shift.
5555
:type attributes: ShiftDataAttributes, optional
5656
5757
:param id: The ``ShiftData`` ``id``.
5858
:type id: str, optional
5959
60-
:param relationships: The definition of ``ShiftDataRelationships`` object.
60+
:param relationships: Relationships for an on-call shift.
6161
:type relationships: ShiftDataRelationships, optional
6262
6363
:param type: Indicates that the resource is of type 'shifts'.

src/datadog_api_client/v2/model/shift_data_attributes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ def openapi_types(_):
2929

3030
def __init__(self_, end: Union[datetime, UnsetType] = unset, start: Union[datetime, UnsetType] = unset, **kwargs):
3131
"""
32-
The definition of ``ShiftDataAttributes`` object.
32+
Attributes for an on-call shift.
3333
3434
:param end: The end time of the shift.
3535
:type end: datetime, optional

src/datadog_api_client/v2/model/shift_data_relationships.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ def openapi_types(_):
3232

3333
def __init__(self_, user: Union[ShiftDataRelationshipsUser, UnsetType] = unset, **kwargs):
3434
"""
35-
The definition of ``ShiftDataRelationships`` object.
35+
Relationships for an on-call shift.
3636
3737
:param user: Defines the relationship between a shift and the user who is working that shift.
3838
:type user: ShiftDataRelationshipsUser, optional

src/datadog_api_client/v2/model/shift_included.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
class ShiftIncluded(ModelComposed):
1414
def __init__(self, **kwargs):
1515
"""
16-
The definition of ``ShiftIncluded`` object.
16+
Included data for shift operations.
1717
1818
:param attributes: Provides basic user information for a schedule, including a name and email address.
1919
:type attributes: ScheduleUserAttributes, optional

0 commit comments

Comments
 (0)