Skip to content

Document missing incident fields #1406

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2023-11-16 09:44:59.257940",
"spec_repo_commit": "974acd6e"
"regenerated": "2023-11-16 15:25:27.705910",
"spec_repo_commit": "c536b702"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2023-11-16 09:44:59.277406",
"spec_repo_commit": "974acd6e"
"regenerated": "2023-11-16 15:25:27.720958",
"spec_repo_commit": "c536b702"
}
}
}
200 changes: 200 additions & 0 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6566,6 +6566,11 @@ components:
$ref: '#/components/schemas/IncidentAttachmentLinkAttributesAttachmentObject'
attachment_type:
$ref: '#/components/schemas/IncidentAttachmentLinkAttachmentType'
modified:
description: Timestamp when the incident attachment link was last modified.
format: date-time
readOnly: true
type: string
required:
- attachment_type
- attachment
Expand Down Expand Up @@ -6871,9 +6876,22 @@ components:
- TEXTARRAY
- METRICTAG
- AUTOCOMPLETE
IncidentImpactsType:
description: The incident impacts type.
enum:
- incident_impacts
example: incident_impacts
type: string
x-enum-varnames:
- INCIDENT_IMPACTS
IncidentIntegrationMetadataAttributes:
description: Incident integration metadata's attributes for a create request.
properties:
created:
description: Timestamp when the incident todo was created.
format: date-time
readOnly: true
type: string
incident_id:
description: UUID of the incident this integration metadata is connected
to.
Expand All @@ -6890,6 +6908,11 @@ components:
type: integer
metadata:
$ref: '#/components/schemas/IncidentIntegrationMetadataMetadata'
modified:
description: Timestamp when the incident todo was last modified.
format: date-time
readOnly: true
type: string
status:
description: 'A number indicating the status of this integration metadata.
0 indicates unknown;
Expand Down Expand Up @@ -6989,6 +7012,8 @@ components:
description: The incident integration metadata's ID.
example: 00000000-0000-0000-1234-000000000000
type: string
relationships:
$ref: '#/components/schemas/IncidentIntegrationRelationships'
type:
$ref: '#/components/schemas/IncidentIntegrationMetadataType'
required:
Expand All @@ -7009,6 +7034,25 @@ components:
type: string
x-enum-varnames:
- INCIDENT_INTEGRATIONS
IncidentIntegrationRelationships:
description: The incident's integration relationships from a response.
properties:
created_by_user:
$ref: '#/components/schemas/RelationshipToUser'
last_modified_by_user:
$ref: '#/components/schemas/RelationshipToUser'
type: object
IncidentNonDatadogCreator:
description: Incident's non Datadog creator.
nullable: true
properties:
image_48_px:
description: Non Datadog creator `48px` image.
type: string
name:
description: Non Datadog creator name.
type: string
type: object
IncidentNotificationHandle:
description: A notification handle that will be notified at incident creation.
properties:
Expand Down Expand Up @@ -7039,6 +7083,14 @@ components:
x-enum-varnames:
- USERS
- ATTACHMENTS
IncidentRespondersType:
description: The incident responders type.
enum:
- incident_responders
example: incident_responders
type: string
x-enum-varnames:
- INCIDENT_RESPONDERS
IncidentResponse:
description: Response with an incident.
properties:
Expand All @@ -7056,6 +7108,17 @@ components:
IncidentResponseAttributes:
description: The incident's attributes from a response.
properties:
archived:
description: Timestamp of when the incident was archived.
format: date-time
nullable: true
readOnly: true
type: string
case_id:
description: The incident case id.
format: int64
nullable: true
type: integer
created:
description: Timestamp when the incident was created.
format: date-time
Expand Down Expand Up @@ -7106,6 +7169,8 @@ components:
format: date-time
readOnly: true
type: string
non_datadog_creator:
$ref: '#/components/schemas/IncidentNonDatadogCreator'
notification_handles:
description: Notification handles that will be notified of the incident
during update.
Expand All @@ -7124,6 +7189,12 @@ components:
format: date-time
nullable: true
type: string
severity:
$ref: '#/components/schemas/IncidentSeverity'
state:
description: The state incident.
nullable: true
type: string
time_to_detect:
description: 'The amount of time in seconds to detect the incident.

Expand Down Expand Up @@ -7154,6 +7225,10 @@ components:
description: The title of the incident, which summarizes what happened.
example: A test incident title
type: string
visibility:
description: The incident visibility status.
nullable: true
type: string
required:
- title
type: object
Expand Down Expand Up @@ -7215,10 +7290,16 @@ components:
$ref: '#/components/schemas/NullableRelationshipToUser'
created_by_user:
$ref: '#/components/schemas/RelationshipToUser'
impacts:
$ref: '#/components/schemas/RelationshipToIncidentImpacts'
integrations:
$ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas'
last_modified_by_user:
$ref: '#/components/schemas/RelationshipToUser'
responders:
$ref: '#/components/schemas/RelationshipToIncidentResponders'
user_defined_fields:
$ref: '#/components/schemas/RelationshipToIncidentUserDefinedFields'
type: object
IncidentSearchResponse:
description: Response with incidents and facets.
Expand Down Expand Up @@ -7601,6 +7682,24 @@ components:
required:
- data
type: object
IncidentSeverity:
description: The incident severity.
enum:
- UNKNOWN
- SEV-1
- SEV-2
- SEV-3
- SEV-4
- SEV-5
example: UNKNOWN
type: string
x-enum-varnames:
- UNKNOWN
- SEV_1
- SEV_2
- SEV_3
- SEV_4
- SEV_5
IncidentTeamCreateAttributes:
description: The incident team's attributes for a create request.
properties:
Expand Down Expand Up @@ -7860,6 +7959,11 @@ components:
description: The follow-up task's content.
example: Restore lost data.
type: string
created:
description: Timestamp when the incident todo was created.
format: date-time
readOnly: true
type: string
due_date:
description: Timestamp when the todo should be completed by.
example: '2023-07-10T05:00:00.000000+00:00'
Expand All @@ -7869,6 +7973,11 @@ components:
description: UUID of the incident this todo is connected to.
example: 00000000-aaaa-0000-0000-000000000000
type: string
modified:
description: Timestamp when the incident todo was last modified.
format: date-time
readOnly: true
type: string
required:
- content
- assignees
Expand Down Expand Up @@ -7930,6 +8039,14 @@ components:
required:
- data
type: object
IncidentTodoRelationships:
description: The incident's relationships from a response.
properties:
created_by_user:
$ref: '#/components/schemas/RelationshipToUser'
last_modified_by_user:
$ref: '#/components/schemas/RelationshipToUser'
type: object
IncidentTodoResponse:
description: Response with an incident todo.
properties:
Expand All @@ -7953,6 +8070,8 @@ components:
description: The incident todo's ID.
example: 00000000-0000-0000-1234-000000000000
type: string
relationships:
$ref: '#/components/schemas/IncidentTodoRelationships'
type:
$ref: '#/components/schemas/IncidentTodoType'
required:
Expand Down Expand Up @@ -8063,6 +8182,14 @@ components:
required:
- data
type: object
IncidentUserDefinedFieldType:
description: The incident user defined fields type.
enum:
- user_defined_field
example: user_defined_field
type: string
x-enum-varnames:
- USER_DEFINED_FIELD
IncidentsResponse:
description: Response with a list of incidents.
properties:
Expand Down Expand Up @@ -10755,6 +10882,7 @@ components:
type: object
NullableRelationshipToUser:
description: Relationship to user.
nullable: true
properties:
data:
$ref: '#/components/schemas/NullableRelationshipToUserData'
Expand Down Expand Up @@ -12615,6 +12743,30 @@ components:
- id
- type
type: object
RelationshipToIncidentImpactData:
description: Relationship to impact object.
properties:
id:
description: A unique identifier that represents the impact.
example: 00000000-0000-0000-2345-000000000000
type: string
type:
$ref: '#/components/schemas/IncidentImpactsType'
required:
- id
- type
type: object
RelationshipToIncidentImpacts:
description: Relationship to impacts.
properties:
data:
description: An array of incident impacts.
items:
$ref: '#/components/schemas/RelationshipToIncidentImpactData'
type: array
required:
- data
type: object
RelationshipToIncidentIntegrationMetadataData:
description: A relationship reference for an integration metadata object.
example:
Expand Down Expand Up @@ -12681,6 +12833,54 @@ components:
- id
- type
type: object
RelationshipToIncidentResponderData:
description: Relationship to impact object.
properties:
id:
description: A unique identifier that represents the responder.
example: 00000000-0000-0000-2345-000000000000
type: string
type:
$ref: '#/components/schemas/IncidentRespondersType'
required:
- id
- type
type: object
RelationshipToIncidentResponders:
description: Relationship to incident responders.
properties:
data:
description: An array of incident responders.
items:
$ref: '#/components/schemas/RelationshipToIncidentResponderData'
type: array
required:
- data
type: object
RelationshipToIncidentUserDefinedFieldData:
description: Relationship to impact object.
properties:
id:
description: A unique identifier that represents the responder.
example: 00000000-0000-0000-2345-000000000000
type: string
type:
$ref: '#/components/schemas/IncidentUserDefinedFieldType'
required:
- id
- type
type: object
RelationshipToIncidentUserDefinedFields:
description: Relationship to incident user defined fields.
properties:
data:
description: An array of user defined fields.
items:
$ref: '#/components/schemas/RelationshipToIncidentUserDefinedFieldData'
type: array
required:
- data
type: object
RelationshipToOrganization:
description: Relationship to an organization.
properties:
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
"2022-05-12T09:51:36.632Z"
"2023-11-06T21:59:33.507Z"
Loading