Skip to content

Commit 9be4135

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit aef4fd0 of spec repo
1 parent 4cbb808 commit 9be4135

127 files changed

Lines changed: 1047 additions & 846 deletions

File tree

Some content is hidden

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

.generator/schemas/v2/openapi.yaml

Lines changed: 49 additions & 96 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,14 @@ components:
178178
required: true
179179
schema:
180180
type: string
181+
AttachmentIDPathParameter:
182+
description: The ID of the attachment.
183+
in: path
184+
name: attachment_id
185+
required: true
186+
schema:
187+
example: 00000000-0000-0000-0000-000000000001
188+
type: string
181189
AttachmentIncludeQueryParameter:
182190
description: 'Resource to include in the response. Supported value: `last_modified_by_user`.'
183191
explode: false
@@ -5340,6 +5348,8 @@ components:
53405348
- project
53415349
type: object
53425350
Attachment:
5351+
description: An attachment response containing the attachment data and related
5352+
objects.
53435353
properties:
53445354
data:
53455355
$ref: '#/components/schemas/AttachmentData'
@@ -5349,22 +5359,9 @@ components:
53495359
type: array
53505360
type: object
53515361
AttachmentArray:
5362+
description: A list of incident attachments.
53525363
properties:
53535364
data:
5354-
example:
5355-
- attributes:
5356-
attachment:
5357-
documentUrl: https://app.datadoghq.com/notebook/123/Postmortem-IR-123
5358-
title: Postmortem IR-123
5359-
attachment_type: postmortem
5360-
modified: '2025-01-01T01:01:01.000000001Z'
5361-
id: 00000000-abcd-0002-0000-000000000000
5362-
relationships:
5363-
last_modified_by_user:
5364-
data:
5365-
id: 00000000-0000-0000-cccc-000000000000
5366-
type: users
5367-
type: incident_attachments
53685365
items:
53695366
$ref: '#/components/schemas/AttachmentData'
53705367
type: array
@@ -5376,24 +5373,12 @@ components:
53765373
- data
53775374
type: object
53785375
AttachmentData:
5379-
example:
5380-
attributes:
5381-
attachment:
5382-
documentUrl: https://app.datadoghq.com/notebook/123/Postmortem-IR-123
5383-
title: Postmortem IR-123
5384-
attachment_type: postmortem
5385-
modified: '2025-01-01T01:01:01.000000001Z'
5386-
id: 00000000-abcd-0002-0000-000000000000
5387-
relationships:
5388-
last_modified_by_user:
5389-
data:
5390-
id: 00000000-0000-0000-cccc-000000000000
5391-
type: users
5392-
type: incident_attachments
5376+
description: Attachment data from a response.
53935377
properties:
53945378
attributes:
53955379
$ref: '#/components/schemas/AttachmentDataAttributes'
53965380
id:
5381+
description: The unique identifier of the attachment.
53975382
example: 00000000-abcd-0002-0000-000000000000
53985383
type: string
53995384
relationships:
@@ -5407,56 +5392,52 @@ components:
54075392
- id
54085393
type: object
54095394
AttachmentDataAttributes:
5395+
description: The attachment's attributes.
54105396
properties:
54115397
attachment:
54125398
$ref: '#/components/schemas/AttachmentDataAttributesAttachment'
54135399
attachment_type:
54145400
$ref: '#/components/schemas/AttachmentDataAttributesAttachmentType'
54155401
modified:
5402+
description: Timestamp when the attachment was last modified.
5403+
example: '2025-01-01T01:01:01.000000001Z'
54165404
format: date-time
54175405
type: string
54185406
type: object
54195407
AttachmentDataAttributesAttachment:
5408+
description: The attachment object.
54205409
properties:
54215410
documentUrl:
5411+
description: The URL of the attachment.
5412+
example: https://app.datadoghq.com/notebook/123/Postmortem-IR-123
54225413
type: string
54235414
title:
5415+
description: The title of the attachment.
5416+
example: Postmortem IR-123
54245417
type: string
54255418
type: object
54265419
AttachmentDataAttributesAttachmentType:
5420+
description: The type of the attachment.
54275421
enum:
54285422
- postmortem
54295423
- link
5424+
example: postmortem
54305425
type: string
54315426
x-enum-varnames:
54325427
- POSTMORTEM
54335428
- LINK
54345429
AttachmentDataRelationships:
5430+
description: The attachment's resource relationships.
54355431
properties:
5432+
incident:
5433+
$ref: '#/components/schemas/RelationshipToIncident'
54365434
last_modified_by_user:
5437-
$ref: '#/components/schemas/AttachmentDataRelationshipsLastModifiedByUser'
5438-
type: object
5439-
AttachmentDataRelationshipsLastModifiedByUser:
5440-
properties:
5441-
data:
5442-
$ref: '#/components/schemas/AttachmentDataRelationshipsLastModifiedByUserData'
5443-
required:
5444-
- data
5445-
type: object
5446-
AttachmentDataRelationshipsLastModifiedByUserData:
5447-
properties:
5448-
id:
5449-
example: ''
5450-
type: string
5451-
type:
5452-
$ref: '#/components/schemas/UserType'
5453-
required:
5454-
- type
5455-
- id
5435+
$ref: '#/components/schemas/RelationshipToUser'
54565436
type: object
54575437
AttachmentIncluded:
5438+
description: Objects related to an attachment.
54585439
oneOf:
5459-
- $ref: '#/components/schemas/User140420082644000'
5440+
- $ref: '#/components/schemas/IncidentUserData'
54605441
AuditLogsEvent:
54615442
description: Object description of an Audit Logs event after it is processed
54625443
and stored by Datadog.
@@ -13012,20 +12993,13 @@ components:
1301212993
- type
1301312994
type: object
1301412995
CreateAttachmentRequest:
13015-
example:
13016-
data:
13017-
attributes:
13018-
attachment:
13019-
documentUrl: https://app.datadoghq.com/notebook/123/Postmortem-IR-123
13020-
title: Postmortem-IR-123
13021-
attachment_type: postmortem
13022-
id: 00000000-0000-0000-0000-000000000000
13023-
type: incident_attachments
12996+
description: Create request for an attachment.
1302412997
properties:
1302512998
data:
1302612999
$ref: '#/components/schemas/CreateAttachmentRequestData'
1302713000
type: object
1302813001
CreateAttachmentRequestData:
13002+
description: Attachment data for a create request.
1302913003
properties:
1303013004
attributes:
1303113005
$ref: '#/components/schemas/CreateAttachmentRequestDataAttributes'
@@ -13037,17 +13011,23 @@ components:
1303713011
- type
1303813012
type: object
1303913013
CreateAttachmentRequestDataAttributes:
13014+
description: The attributes for creating an attachment.
1304013015
properties:
1304113016
attachment:
1304213017
$ref: '#/components/schemas/CreateAttachmentRequestDataAttributesAttachment'
1304313018
attachment_type:
1304413019
$ref: '#/components/schemas/AttachmentDataAttributesAttachmentType'
1304513020
type: object
1304613021
CreateAttachmentRequestDataAttributesAttachment:
13022+
description: The attachment object for creating an attachment.
1304713023
properties:
1304813024
documentUrl:
13025+
description: The URL of the attachment.
13026+
example: https://app.datadoghq.com/notebook/123/Postmortem-IR-123
1304913027
type: string
1305013028
title:
13029+
description: The title of the attachment.
13030+
example: Postmortem-IR-123
1305113031
type: string
1305213032
type: object
1305313033
CreateCaseRequestArray:
@@ -42644,38 +42624,41 @@ components:
4264442624
type: array
4264542625
type: object
4264642626
PatchAttachmentRequest:
42647-
example:
42648-
data:
42649-
attributes:
42650-
attachment:
42651-
documentUrl: https://app.datadoghq.com/notebook/124/Postmortem-IR-124
42652-
title: Postmortem-IR-124
42653-
type: incident_attachments
42627+
description: Request to update an attachment.
4265442628
properties:
4265542629
data:
4265642630
$ref: '#/components/schemas/PatchAttachmentRequestData'
4265742631
type: object
4265842632
PatchAttachmentRequestData:
42633+
description: Attachment data for an update request.
4265942634
properties:
4266042635
attributes:
4266142636
$ref: '#/components/schemas/PatchAttachmentRequestDataAttributes'
4266242637
id:
42638+
description: The unique identifier of the attachment.
42639+
example: 00000000-abcd-0002-0000-000000000000
4266342640
type: string
4266442641
type:
4266542642
$ref: '#/components/schemas/IncidentAttachmentType'
4266642643
required:
4266742644
- type
4266842645
type: object
4266942646
PatchAttachmentRequestDataAttributes:
42647+
description: The attributes for updating an attachment.
4267042648
properties:
4267142649
attachment:
4267242650
$ref: '#/components/schemas/PatchAttachmentRequestDataAttributesAttachment'
4267342651
type: object
4267442652
PatchAttachmentRequestDataAttributesAttachment:
42653+
description: The updated attachment object.
4267542654
properties:
4267642655
documentUrl:
42656+
description: The updated URL for the attachment.
42657+
example: https://app.datadoghq.com/notebook/124/Postmortem-IR-124
4267742658
type: string
4267842659
title:
42660+
description: The updated title for the attachment.
42661+
example: Postmortem-IR-124
4267942662
type: string
4268042663
type: object
4268142664
PatchComponentRequest:
@@ -61980,17 +61963,6 @@ components:
6198061963
type:
6198161964
$ref: '#/components/schemas/UsersType'
6198261965
type: object
61983-
User140420082644000:
61984-
properties:
61985-
attributes:
61986-
$ref: '#/components/schemas/UserAttributes'
61987-
id:
61988-
type: string
61989-
type:
61990-
$ref: '#/components/schemas/UserType'
61991-
required:
61992-
- type
61993-
type: object
6199461966
UserAttributes:
6199561967
description: Attributes of user object returned by the API.
6199661968
properties:
@@ -62441,15 +62413,6 @@ components:
6244162413
meta:
6244262414
$ref: '#/components/schemas/TeamsResponseMeta'
6244362415
type: object
62444-
UserType:
62445-
default: users
62446-
description: Users resource type.
62447-
enum:
62448-
- users
62449-
example: users
62450-
type: string
62451-
x-enum-varnames:
62452-
- USERS
6245362416
UserUpdateAttributes:
6245462417
description: Attributes of the edited user.
6245562418
properties:
@@ -74628,12 +74591,7 @@ paths:
7462874591
operationId: DeleteIncidentAttachment
7462974592
parameters:
7463074593
- $ref: '#/components/parameters/IncidentIDPathParameter'
74631-
- description: The ID of the attachment.
74632-
in: path
74633-
name: attachment_id
74634-
required: true
74635-
schema:
74636-
example: 00000000-0000-0000-0000-000000000002
74594+
- $ref: '#/components/parameters/AttachmentIDPathParameter'
7463774595
responses:
7463874596
'204':
7463974597
description: No Content
@@ -74664,12 +74622,7 @@ paths:
7466474622
operationId: UpdateIncidentAttachment
7466574623
parameters:
7466674624
- $ref: '#/components/parameters/IncidentIDPathParameter'
74667-
- description: The ID of the attachment.
74668-
in: path
74669-
name: attachment_id
74670-
required: true
74671-
schema:
74672-
example: 00000000-0000-0000-0000-000000000002
74625+
- $ref: '#/components/parameters/AttachmentIDPathParameter'
7467374626
- $ref: '#/components/parameters/AttachmentIncludeQueryParameter'
7467474627
requestBody:
7467574628
content:

docs/datadog_api_client.v2.model.rst

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1320,20 +1320,6 @@ datadog\_api\_client.v2.model.attachment\_data\_relationships module
13201320
:members:
13211321
:show-inheritance:
13221322

1323-
datadog\_api\_client.v2.model.attachment\_data\_relationships\_last\_modified\_by\_user module
1324-
----------------------------------------------------------------------------------------------
1325-
1326-
.. automodule:: datadog_api_client.v2.model.attachment_data_relationships_last_modified_by_user
1327-
:members:
1328-
:show-inheritance:
1329-
1330-
datadog\_api\_client.v2.model.attachment\_data\_relationships\_last\_modified\_by\_user\_data module
1331-
----------------------------------------------------------------------------------------------------
1332-
1333-
.. automodule:: datadog_api_client.v2.model.attachment_data_relationships_last_modified_by_user_data
1334-
:members:
1335-
:show-inheritance:
1336-
13371323
datadog\_api\_client.v2.model.attachment\_included module
13381324
---------------------------------------------------------
13391325

@@ -27304,13 +27290,6 @@ datadog\_api\_client.v2.model.user module
2730427290
:members:
2730527291
:show-inheritance:
2730627292

27307-
datadog\_api\_client.v2.model.user140420082644000 module
27308-
--------------------------------------------------------
27309-
27310-
.. automodule:: datadog_api_client.v2.model.user140420082644000
27311-
:members:
27312-
:show-inheritance:
27313-
2731427293
datadog\_api\_client.v2.model.user\_attributes module
2731527294
-----------------------------------------------------
2731627295

@@ -27577,13 +27556,6 @@ datadog\_api\_client.v2.model.user\_teams\_response module
2757727556
:members:
2757827557
:show-inheritance:
2757927558

27580-
datadog\_api\_client.v2.model.user\_type module
27581-
-----------------------------------------------
27582-
27583-
.. automodule:: datadog_api_client.v2.model.user_type
27584-
:members:
27585-
:show-inheritance:
27586-
2758727559
datadog\_api\_client.v2.model.user\_update\_attributes module
2758827560
-------------------------------------------------------------
2758927561

examples/v2/incidents/CreateIncidentAttachment.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
Create incident attachment returns "Created" response
33
"""
44

5+
from os import environ
56
from datadog_api_client import ApiClient, Configuration
67
from datadog_api_client.v2.api.incidents_api import IncidentsApi
78
from datadog_api_client.v2.model.attachment_data_attributes_attachment_type import (
@@ -15,16 +16,18 @@
1516
)
1617
from datadog_api_client.v2.model.incident_attachment_type import IncidentAttachmentType
1718

19+
# there is a valid "incident" in the system
20+
INCIDENT_DATA_ID = environ["INCIDENT_DATA_ID"]
21+
1822
body = CreateAttachmentRequest(
1923
data=CreateAttachmentRequestData(
2024
attributes=CreateAttachmentRequestDataAttributes(
2125
attachment=CreateAttachmentRequestDataAttributesAttachment(
22-
document_url="https://app.datadoghq.com/notebook/123/Postmortem-IR-123",
23-
title="Postmortem-IR-123",
26+
document_url="https://app.datadoghq.com/notebook/ExampleIncident/Example-Incident",
27+
title="Example-Incident",
2428
),
2529
attachment_type=AttachmentDataAttributesAttachmentType.POSTMORTEM,
2630
),
27-
id="00000000-0000-0000-0000-000000000000",
2831
type=IncidentAttachmentType.INCIDENT_ATTACHMENTS,
2932
),
3033
)
@@ -33,6 +36,6 @@
3336
configuration.unstable_operations["create_incident_attachment"] = True
3437
with ApiClient(configuration) as api_client:
3538
api_instance = IncidentsApi(api_client)
36-
response = api_instance.create_incident_attachment(incident_id="incident_id", body=body)
39+
response = api_instance.create_incident_attachment(incident_id=INCIDENT_DATA_ID, body=body)
3740

3841
print(response)

0 commit comments

Comments
 (0)