Skip to content

Commit 082dc9f

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add spec for team on-call endpoint (#2598)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent fdb54da commit 082dc9f

File tree

48 files changed

+1787
-154
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+1787
-154
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-06-04 10:48:01.593462",
8-
"spec_repo_commit": "1f58e760"
7+
"regenerated": "2025-06-04 12:51:42.024933",
8+
"spec_repo_commit": "35a63137"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-06-04 10:48:01.609723",
13-
"spec_repo_commit": "1f58e760"
12+
"regenerated": "2025-06-04 12:51:42.039930",
13+
"spec_repo_commit": "35a63137"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 249 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13844,6 +13844,19 @@ components:
1384413844
- retryStrategy
1384513845
- fallbackStepName
1384613846
type: object
13847+
Escalation:
13848+
description: Represents an escalation policy step.
13849+
properties:
13850+
id:
13851+
description: Unique identifier of the escalation step.
13852+
type: string
13853+
relationships:
13854+
$ref: '#/components/schemas/EscalationRelationships'
13855+
type:
13856+
$ref: '#/components/schemas/EscalationType'
13857+
required:
13858+
- type
13859+
type: object
1384713860
EscalationPolicy:
1384813861
description: Represents a complete escalation policy response, including policy
1384913862
data and optionally included related resources.
@@ -14353,6 +14366,46 @@ components:
1435314366
type: string
1435414367
x-enum-varnames:
1435514368
- USERS
14369+
EscalationRelationships:
14370+
description: Contains the relationships of an escalation object, including its
14371+
responders.
14372+
properties:
14373+
responders:
14374+
$ref: '#/components/schemas/EscalationRelationshipsResponders'
14375+
type: object
14376+
EscalationRelationshipsResponders:
14377+
description: Lists the users involved in a specific step of the escalation policy.
14378+
properties:
14379+
data:
14380+
description: Array of user references assigned as responders for this escalation
14381+
step.
14382+
items:
14383+
$ref: '#/components/schemas/EscalationRelationshipsRespondersDataItems'
14384+
type: array
14385+
type: object
14386+
EscalationRelationshipsRespondersDataItems:
14387+
description: Represents a user assigned to an escalation step.
14388+
properties:
14389+
id:
14390+
description: Unique identifier of the user assigned to the escalation step.
14391+
example: ''
14392+
type: string
14393+
type:
14394+
$ref: '#/components/schemas/EscalationRelationshipsRespondersDataItemsType'
14395+
required:
14396+
- type
14397+
- id
14398+
type: object
14399+
EscalationRelationshipsRespondersDataItemsType:
14400+
default: users
14401+
description: Represents the resource type for users assigned as responders in
14402+
an escalation step.
14403+
enum:
14404+
- users
14405+
example: users
14406+
type: string
14407+
x-enum-varnames:
14408+
- USERS
1435614409
EscalationTarget:
1435714410
description: Represents an escalation target, which can be a team, user, or
1435814411
schedule.
@@ -14369,6 +14422,16 @@ components:
1436914422
$ref: '#/components/schemas/EscalationTarget'
1437014423
type: array
1437114424
type: object
14425+
EscalationType:
14426+
default: escalation_policy_steps
14427+
description: Represents the resource type for individual steps in an escalation
14428+
policy used during incident response.
14429+
enum:
14430+
- escalation_policy_steps
14431+
example: escalation_policy_steps
14432+
type: string
14433+
x-enum-varnames:
14434+
- ESCALATION_POLICY_STEPS
1437214435
Event:
1437314436
description: The metadata associated with a request.
1437414437
properties:
@@ -37980,6 +38043,150 @@ components:
3798038043
$ref: '#/components/schemas/TeamLink'
3798138044
type: array
3798238045
type: object
38046+
TeamOnCallResponders:
38047+
description: Root object representing a team's on-call responder configuration.
38048+
example:
38049+
data:
38050+
id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
38051+
relationships:
38052+
escalations:
38053+
data:
38054+
- id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
38055+
type: escalation_policy_steps
38056+
responders:
38057+
data:
38058+
- id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
38059+
type: users
38060+
type: team_oncall_responders
38061+
included:
38062+
- attributes:
38063+
38064+
name: Test User
38065+
status: active
38066+
id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
38067+
type: users
38068+
- id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
38069+
relationships:
38070+
responders:
38071+
data:
38072+
- id: 111ee23r-aaaaa-aaaa-aaww-1234wertsd23
38073+
type: users
38074+
type: escalation_policy_steps
38075+
properties:
38076+
data:
38077+
$ref: '#/components/schemas/TeamOnCallRespondersData'
38078+
included:
38079+
description: The `TeamOnCallResponders` `included`.
38080+
items:
38081+
$ref: '#/components/schemas/TeamOnCallRespondersIncluded'
38082+
type: array
38083+
type: object
38084+
TeamOnCallRespondersData:
38085+
description: Defines the main on-call responder object for a team, including
38086+
relationships and metadata.
38087+
properties:
38088+
id:
38089+
description: Unique identifier of the on-call responder configuration.
38090+
type: string
38091+
relationships:
38092+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationships'
38093+
type:
38094+
$ref: '#/components/schemas/TeamOnCallRespondersDataType'
38095+
required:
38096+
- type
38097+
type: object
38098+
TeamOnCallRespondersDataRelationships:
38099+
description: Relationship objects linked to a team's on-call responder configuration,
38100+
including escalations and responders.
38101+
properties:
38102+
escalations:
38103+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalations'
38104+
responders:
38105+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsResponders'
38106+
type: object
38107+
TeamOnCallRespondersDataRelationshipsEscalations:
38108+
description: Defines the escalation policy steps linked to the team's on-call
38109+
configuration.
38110+
properties:
38111+
data:
38112+
description: Array of escalation step references.
38113+
items:
38114+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalationsDataItems'
38115+
type: array
38116+
type: object
38117+
TeamOnCallRespondersDataRelationshipsEscalationsDataItems:
38118+
description: Represents a link to a specific escalation policy step associated
38119+
with the on-call team.
38120+
properties:
38121+
id:
38122+
description: Unique identifier of the escalation step.
38123+
example: ''
38124+
type: string
38125+
type:
38126+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType'
38127+
required:
38128+
- type
38129+
- id
38130+
type: object
38131+
TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType:
38132+
default: escalation_policy_steps
38133+
description: Identifies the resource type for escalation policy steps linked
38134+
to a team's on-call configuration.
38135+
enum:
38136+
- escalation_policy_steps
38137+
example: escalation_policy_steps
38138+
type: string
38139+
x-enum-varnames:
38140+
- ESCALATION_POLICY_STEPS
38141+
TeamOnCallRespondersDataRelationshipsResponders:
38142+
description: Defines the list of users assigned as on-call responders for the
38143+
team.
38144+
properties:
38145+
data:
38146+
description: Array of user references associated as responders.
38147+
items:
38148+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsRespondersDataItems'
38149+
type: array
38150+
type: object
38151+
TeamOnCallRespondersDataRelationshipsRespondersDataItems:
38152+
description: Represents a user responder associated with the on-call team.
38153+
properties:
38154+
id:
38155+
description: Unique identifier of the responder.
38156+
example: ''
38157+
type: string
38158+
type:
38159+
$ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsRespondersDataItemsType'
38160+
required:
38161+
- type
38162+
- id
38163+
type: object
38164+
TeamOnCallRespondersDataRelationshipsRespondersDataItemsType:
38165+
default: users
38166+
description: Identifies the resource type for individual user entities associated
38167+
with on-call response.
38168+
enum:
38169+
- users
38170+
example: users
38171+
type: string
38172+
x-enum-varnames:
38173+
- USERS
38174+
TeamOnCallRespondersDataType:
38175+
default: team_oncall_responders
38176+
description: Represents the resource type for a group of users assigned to handle
38177+
on-call duties within a team.
38178+
enum:
38179+
- team_oncall_responders
38180+
example: team_oncall_responders
38181+
type: string
38182+
x-enum-varnames:
38183+
- TEAM_ONCALL_RESPONDERS
38184+
TeamOnCallRespondersIncluded:
38185+
description: Represents an union of related resources included in the response,
38186+
such as users and escalation steps.
38187+
oneOf:
38188+
- $ref: '#/components/schemas/User'
38189+
- $ref: '#/components/schemas/Escalation'
3798338190
TeamPermissionSetting:
3798438191
description: Team permission setting
3798538192
properties:
@@ -52562,6 +52769,48 @@ paths:
5256252769
summary: Get the schedule on-call user
5256352770
tags:
5256452771
- On-Call
52772+
/api/v2/on-call/teams/{team_id}/on-call:
52773+
get:
52774+
description: Get a team's on-call users at a given time
52775+
operationId: GetTeamOnCallUsers
52776+
parameters:
52777+
- description: 'Comma-separated list of included relationships to be returned.
52778+
Allowed values: `responders`, `escalations`, `escalations.responders`.'
52779+
in: query
52780+
name: include
52781+
schema:
52782+
type: string
52783+
- description: The team ID
52784+
in: path
52785+
name: team_id
52786+
required: true
52787+
schema:
52788+
example: 27590dae-47be-4a7d-9abf-8f4e45124020
52789+
type: string
52790+
responses:
52791+
'200':
52792+
content:
52793+
application/json:
52794+
schema:
52795+
$ref: '#/components/schemas/TeamOnCallResponders'
52796+
description: OK
52797+
'400':
52798+
$ref: '#/components/responses/BadRequestResponse'
52799+
'401':
52800+
$ref: '#/components/responses/UnauthorizedResponse'
52801+
'403':
52802+
$ref: '#/components/responses/ForbiddenResponse'
52803+
'404':
52804+
$ref: '#/components/responses/NotFoundResponse'
52805+
'429':
52806+
$ref: '#/components/responses/TooManyRequestsResponse'
52807+
security:
52808+
- apiKeyAuth: []
52809+
appKeyAuth: []
52810+
- AuthZ: []
52811+
summary: Get team on-call users
52812+
tags:
52813+
- On-Call
5256552814
/api/v2/on-call/teams/{team_id}/routing-rules:
5256652815
get:
5256752816
description: Get a team's On-Call routing rules

0 commit comments

Comments
 (0)