Skip to content

Commit 0a683f1

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Share timerestriction object (#2557)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 8835087 commit 0a683f1

18 files changed

+32
-938
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2025-05-09 02:41:27.605914",
8-
"spec_repo_commit": "39adb7c0"
7+
"regenerated": "2025-05-09 14:41:37.186745",
8+
"spec_repo_commit": "f0e5e32f"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-05-09 02:41:27.620499",
13-
"spec_repo_commit": "39adb7c0"
12+
"regenerated": "2025-05-09 14:41:37.315993",
13+
"spec_repo_commit": "f0e5e32f"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 3 additions & 173 deletions
Original file line numberDiff line numberDiff line change
@@ -18663,7 +18663,7 @@ components:
1866318663
description: An optional list of time restrictions for when this layer is
1866418664
in effect.
1866518665
items:
18666-
$ref: '#/components/schemas/LayerAttributesRestrictionsItems'
18666+
$ref: '#/components/schemas/TimeRestriction'
1866718667
type: array
1866818668
rotation_start:
1866918669
description: The date/time when the rotation starts (ISO 8601).
@@ -18687,63 +18687,6 @@ components:
1868718687
maximum: 2592000
1868818688
type: integer
1868918689
type: object
18690-
LayerAttributesRestrictionsItems:
18691-
description: 'Represents a time restriction within a layer, specifying the days
18692-
and times
18693-
18694-
when this layer is active or inactive.'
18695-
properties:
18696-
end_day:
18697-
$ref: '#/components/schemas/LayerAttributesRestrictionsItemsEndDay'
18698-
end_time:
18699-
description: The time of day the restriction ends (hh:mm:ss).
18700-
example: '17:00:00'
18701-
type: string
18702-
start_day:
18703-
$ref: '#/components/schemas/LayerAttributesRestrictionsItemsStartDay'
18704-
start_time:
18705-
description: The time of day the restriction begins (hh:mm:ss).
18706-
example: 09:00:00
18707-
type: string
18708-
type: object
18709-
LayerAttributesRestrictionsItemsEndDay:
18710-
description: Defines the end day of the restriction within a Layer.
18711-
enum:
18712-
- monday
18713-
- tuesday
18714-
- wednesday
18715-
- thursday
18716-
- friday
18717-
- saturday
18718-
- sunday
18719-
type: string
18720-
x-enum-varnames:
18721-
- MONDAY
18722-
- TUESDAY
18723-
- WEDNESDAY
18724-
- THURSDAY
18725-
- FRIDAY
18726-
- SATURDAY
18727-
- SUNDAY
18728-
LayerAttributesRestrictionsItemsStartDay:
18729-
description: Defines the start day of the restriction within a Layer.
18730-
enum:
18731-
- monday
18732-
- tuesday
18733-
- wednesday
18734-
- thursday
18735-
- friday
18736-
- saturday
18737-
- sunday
18738-
type: string
18739-
x-enum-varnames:
18740-
- MONDAY
18741-
- TUESDAY
18742-
- WEDNESDAY
18743-
- THURSDAY
18744-
- FRIDAY
18745-
- SATURDAY
18746-
- SUNDAY
1874718690
LayerRelationships:
1874818691
description: Holds references to objects related to the Layer entity, such as
1874918692
its members.
@@ -31120,7 +31063,7 @@ components:
3112031063
description: Zero or more time-based restrictions (for example, only weekdays,
3112131064
during business hours).
3112231065
items:
31123-
$ref: '#/components/schemas/ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItems'
31066+
$ref: '#/components/schemas/TimeRestriction'
3112431067
type: array
3112531068
rotation_start:
3112631069
description: The date/time when the rotation for this layer starts (in ISO
@@ -31169,62 +31112,6 @@ components:
3116931112
example: 00000000-aba1-0000-0000-000000000000
3117031113
type: string
3117131114
type: object
31172-
ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItems:
31173-
description: 'Defines a time restriction for a schedule layer, including which
31174-
day of the week
31175-
31176-
it starts and ends, along with start/end times.'
31177-
properties:
31178-
end_day:
31179-
$ref: '#/components/schemas/ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsEndDay'
31180-
end_time:
31181-
description: The time of day when the restriction ends (hh:mm:ss).
31182-
type: string
31183-
start_day:
31184-
$ref: '#/components/schemas/ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsStartDay'
31185-
start_time:
31186-
description: The time of day when the restriction begins (hh:mm:ss).
31187-
type: string
31188-
type: object
31189-
ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsEndDay:
31190-
description: The weekday when the restriction period ends (Monday through Sunday).
31191-
enum:
31192-
- monday
31193-
- tuesday
31194-
- wednesday
31195-
- thursday
31196-
- friday
31197-
- saturday
31198-
- sunday
31199-
type: string
31200-
x-enum-varnames:
31201-
- MONDAY
31202-
- TUESDAY
31203-
- WEDNESDAY
31204-
- THURSDAY
31205-
- FRIDAY
31206-
- SATURDAY
31207-
- SUNDAY
31208-
ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsStartDay:
31209-
description: The weekday when the restriction period starts (Monday through
31210-
Sunday).
31211-
enum:
31212-
- monday
31213-
- tuesday
31214-
- wednesday
31215-
- thursday
31216-
- friday
31217-
- saturday
31218-
- sunday
31219-
type: string
31220-
x-enum-varnames:
31221-
- MONDAY
31222-
- TUESDAY
31223-
- WEDNESDAY
31224-
- THURSDAY
31225-
- FRIDAY
31226-
- SATURDAY
31227-
- SUNDAY
3122831115
ScheduleCreateRequestDataRelationships:
3122931116
description: Gathers relationship objects for the schedule creation request,
3123031117
including the teams to associate.
@@ -31628,7 +31515,7 @@ components:
3162831515
restrictions:
3162931516
description: Any time restrictions that define when this layer is active.
3163031517
items:
31631-
$ref: '#/components/schemas/ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItems'
31518+
$ref: '#/components/schemas/TimeRestriction'
3163231519
type: array
3163331520
rotation_start:
3163431521
description: The date/time at which the rotation begins (ISO 8601 format).
@@ -31678,63 +31565,6 @@ components:
3167831565
example: 00000000-aba1-0000-0000-000000000000
3167931566
type: string
3168031567
type: object
31681-
ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItems:
31682-
description: 'Defines a time restriction object for a layer within a schedule
31683-
update, including
31684-
31685-
start and end days, as well as times.'
31686-
properties:
31687-
end_day:
31688-
$ref: '#/components/schemas/ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsEndDay'
31689-
end_time:
31690-
description: The time at which this restriction ends (hh:mm:ss).
31691-
example: '17:00:00'
31692-
type: string
31693-
start_day:
31694-
$ref: '#/components/schemas/ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsStartDay'
31695-
start_time:
31696-
description: The time at which this restriction starts (hh:mm:ss).
31697-
example: 09:00:00
31698-
type: string
31699-
type: object
31700-
ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsEndDay:
31701-
description: Defines the day of the week on which the time restriction ends.
31702-
enum:
31703-
- monday
31704-
- tuesday
31705-
- wednesday
31706-
- thursday
31707-
- friday
31708-
- saturday
31709-
- sunday
31710-
type: string
31711-
x-enum-varnames:
31712-
- MONDAY
31713-
- TUESDAY
31714-
- WEDNESDAY
31715-
- THURSDAY
31716-
- FRIDAY
31717-
- SATURDAY
31718-
- SUNDAY
31719-
ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsStartDay:
31720-
description: Defines the day of the week on which the time restriction starts.
31721-
enum:
31722-
- monday
31723-
- tuesday
31724-
- wednesday
31725-
- thursday
31726-
- friday
31727-
- saturday
31728-
- sunday
31729-
type: string
31730-
x-enum-varnames:
31731-
- MONDAY
31732-
- TUESDAY
31733-
- WEDNESDAY
31734-
- THURSDAY
31735-
- FRIDAY
31736-
- SATURDAY
31737-
- SUNDAY
3173831568
ScheduleUpdateRequestDataRelationships:
3173931569
description: Houses relationships for the schedule update, typically referencing
3174031570
teams.

docs/datadog_api_client.v2.model.rst

Lines changed: 0 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -7788,27 +7788,6 @@ datadog\_api\_client.v2.model.layer\_attributes\_interval module
77887788
:members:
77897789
:show-inheritance:
77907790

7791-
datadog\_api\_client.v2.model.layer\_attributes\_restrictions\_items module
7792-
---------------------------------------------------------------------------
7793-
7794-
.. automodule:: datadog_api_client.v2.model.layer_attributes_restrictions_items
7795-
:members:
7796-
:show-inheritance:
7797-
7798-
datadog\_api\_client.v2.model.layer\_attributes\_restrictions\_items\_end\_day module
7799-
-------------------------------------------------------------------------------------
7800-
7801-
.. automodule:: datadog_api_client.v2.model.layer_attributes_restrictions_items_end_day
7802-
:members:
7803-
:show-inheritance:
7804-
7805-
datadog\_api\_client.v2.model.layer\_attributes\_restrictions\_items\_start\_day module
7806-
---------------------------------------------------------------------------------------
7807-
7808-
.. automodule:: datadog_api_client.v2.model.layer_attributes_restrictions_items_start_day
7809-
:members:
7810-
:show-inheritance:
7811-
78127791
datadog\_api\_client.v2.model.layer\_relationships module
78137792
---------------------------------------------------------
78147793

@@ -13570,27 +13549,6 @@ datadog\_api\_client.v2.model.schedule\_create\_request\_data\_attributes\_layer
1357013549
:members:
1357113550
:show-inheritance:
1357213551

13573-
datadog\_api\_client.v2.model.schedule\_create\_request\_data\_attributes\_layers\_items\_restrictions\_items module
13574-
--------------------------------------------------------------------------------------------------------------------
13575-
13576-
.. automodule:: datadog_api_client.v2.model.schedule_create_request_data_attributes_layers_items_restrictions_items
13577-
:members:
13578-
:show-inheritance:
13579-
13580-
datadog\_api\_client.v2.model.schedule\_create\_request\_data\_attributes\_layers\_items\_restrictions\_items\_end\_day module
13581-
------------------------------------------------------------------------------------------------------------------------------
13582-
13583-
.. automodule:: datadog_api_client.v2.model.schedule_create_request_data_attributes_layers_items_restrictions_items_end_day
13584-
:members:
13585-
:show-inheritance:
13586-
13587-
datadog\_api\_client.v2.model.schedule\_create\_request\_data\_attributes\_layers\_items\_restrictions\_items\_start\_day module
13588-
--------------------------------------------------------------------------------------------------------------------------------
13589-
13590-
.. automodule:: datadog_api_client.v2.model.schedule_create_request_data_attributes_layers_items_restrictions_items_start_day
13591-
:members:
13592-
:show-inheritance:
13593-
1359413552
datadog\_api\_client.v2.model.schedule\_create\_request\_data\_relationships module
1359513553
-----------------------------------------------------------------------------------
1359613554

@@ -13822,27 +13780,6 @@ datadog\_api\_client.v2.model.schedule\_update\_request\_data\_attributes\_layer
1382213780
:members:
1382313781
:show-inheritance:
1382413782

13825-
datadog\_api\_client.v2.model.schedule\_update\_request\_data\_attributes\_layers\_items\_restrictions\_items module
13826-
--------------------------------------------------------------------------------------------------------------------
13827-
13828-
.. automodule:: datadog_api_client.v2.model.schedule_update_request_data_attributes_layers_items_restrictions_items
13829-
:members:
13830-
:show-inheritance:
13831-
13832-
datadog\_api\_client.v2.model.schedule\_update\_request\_data\_attributes\_layers\_items\_restrictions\_items\_end\_day module
13833-
------------------------------------------------------------------------------------------------------------------------------
13834-
13835-
.. automodule:: datadog_api_client.v2.model.schedule_update_request_data_attributes_layers_items_restrictions_items_end_day
13836-
:members:
13837-
:show-inheritance:
13838-
13839-
datadog\_api\_client.v2.model.schedule\_update\_request\_data\_attributes\_layers\_items\_restrictions\_items\_start\_day module
13840-
--------------------------------------------------------------------------------------------------------------------------------
13841-
13842-
.. automodule:: datadog_api_client.v2.model.schedule_update_request_data_attributes_layers_items_restrictions_items_start_day
13843-
:members:
13844-
:show-inheritance:
13845-
1384613783
datadog\_api\_client.v2.model.schedule\_update\_request\_data\_relationships module
1384713784
-----------------------------------------------------------------------------------
1384813785

examples/v2/on-call/CreateOnCallSchedule.py

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,6 @@
2222
from datadog_api_client.v2.model.schedule_create_request_data_attributes_layers_items_members_items_user import (
2323
ScheduleCreateRequestDataAttributesLayersItemsMembersItemsUser,
2424
)
25-
from datadog_api_client.v2.model.schedule_create_request_data_attributes_layers_items_restrictions_items import (
26-
ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItems,
27-
)
28-
from datadog_api_client.v2.model.schedule_create_request_data_attributes_layers_items_restrictions_items_end_day import (
29-
ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsEndDay,
30-
)
31-
from datadog_api_client.v2.model.schedule_create_request_data_attributes_layers_items_restrictions_items_start_day import (
32-
ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsStartDay,
33-
)
3425
from datadog_api_client.v2.model.schedule_create_request_data_relationships import (
3526
ScheduleCreateRequestDataRelationships,
3627
)
@@ -44,6 +35,8 @@
4435
ScheduleCreateRequestDataRelationshipsTeamsDataItemsType,
4536
)
4637
from datadog_api_client.v2.model.schedule_create_request_data_type import ScheduleCreateRequestDataType
38+
from datadog_api_client.v2.model.time_restriction import TimeRestriction
39+
from datadog_api_client.v2.model.weekday import Weekday
4740

4841
# there is a valid "user" in the system
4942
USER_DATA_ID = environ["USER_DATA_ID"]
@@ -70,10 +63,10 @@
7063
],
7164
name="Layer 1",
7265
restrictions=[
73-
ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItems(
74-
end_day=ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsEndDay.FRIDAY,
66+
TimeRestriction(
67+
end_day=Weekday.FRIDAY,
7568
end_time="17:00:00",
76-
start_day=ScheduleCreateRequestDataAttributesLayersItemsRestrictionsItemsStartDay.MONDAY,
69+
start_day=Weekday.MONDAY,
7770
start_time="09:00:00",
7871
),
7972
],

examples/v2/on-call/UpdateOnCallSchedule.py

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,6 @@
2222
from datadog_api_client.v2.model.schedule_update_request_data_attributes_layers_items_members_items_user import (
2323
ScheduleUpdateRequestDataAttributesLayersItemsMembersItemsUser,
2424
)
25-
from datadog_api_client.v2.model.schedule_update_request_data_attributes_layers_items_restrictions_items import (
26-
ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItems,
27-
)
28-
from datadog_api_client.v2.model.schedule_update_request_data_attributes_layers_items_restrictions_items_end_day import (
29-
ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsEndDay,
30-
)
31-
from datadog_api_client.v2.model.schedule_update_request_data_attributes_layers_items_restrictions_items_start_day import (
32-
ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsStartDay,
33-
)
3425
from datadog_api_client.v2.model.schedule_update_request_data_relationships import (
3526
ScheduleUpdateRequestDataRelationships,
3627
)
@@ -44,6 +35,8 @@
4435
ScheduleUpdateRequestDataRelationshipsTeamsDataItemsType,
4536
)
4637
from datadog_api_client.v2.model.schedule_update_request_data_type import ScheduleUpdateRequestDataType
38+
from datadog_api_client.v2.model.time_restriction import TimeRestriction
39+
from datadog_api_client.v2.model.weekday import Weekday
4740

4841
# there is a valid "schedule" in the system
4942
SCHEDULE_DATA_ID = environ["SCHEDULE_DATA_ID"]
@@ -76,10 +69,10 @@
7669
],
7770
name="Layer 1",
7871
restrictions=[
79-
ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItems(
80-
end_day=ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsEndDay.FRIDAY,
72+
TimeRestriction(
73+
end_day=Weekday.FRIDAY,
8174
end_time="17:00:00",
82-
start_day=ScheduleUpdateRequestDataAttributesLayersItemsRestrictionsItemsStartDay.MONDAY,
75+
start_day=Weekday.MONDAY,
8376
start_time="09:00:00",
8477
),
8578
],

0 commit comments

Comments
 (0)