Skip to content
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

Integrate incident types into Incidents API documentation #25606

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": "2024-10-28 18:38:56.326868",
"spec_repo_commit": "b4ad1786"
"regenerated": "2024-10-28 23:09:04.590467",
"spec_repo_commit": "4251a422"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-10-28 18:39:04.239857",
"spec_repo_commit": "b4ad1786"
"regenerated": "2024-10-28 23:09:13.183062",
"spec_repo_commit": "4251a422"
}
}
}
65 changes: 65 additions & 0 deletions config/_default/menus/api.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5791,6 +5791,71 @@ menu:
unstable:
- v2
order: 6
- name: Update an incident type
url: '#update-an-incident-type'
identifier: incidents-update-an-incident-type
parent: incidents
generated: true
params:
versions:
- v2
operationids:
- UpdateIncidentType
unstable:
- v2
order: 22
- name: Get incident type details
url: '#get-incident-type-details'
identifier: incidents-get-incident-type-details
parent: incidents
generated: true
params:
versions:
- v2
operationids:
- GetIncidentType
unstable:
- v2
order: 21
- name: Delete an incident type
url: '#delete-an-incident-type'
identifier: incidents-delete-an-incident-type
parent: incidents
generated: true
params:
versions:
- v2
operationids:
- DeleteIncidentType
unstable:
- v2
order: 23
- name: Create an incident type
url: '#create-an-incident-type'
identifier: incidents-create-an-incident-type
parent: incidents
generated: true
params:
versions:
- v2
operationids:
- CreateIncidentType
unstable:
- v2
order: 19
- name: Get a list of incident types
url: '#get-a-list-of-incident-types'
identifier: incidents-get-a-list-of-incident-types
parent: incidents
generated: true
params:
versions:
- v2
operationids:
- ListIncidentTypes
unstable:
- v2
order: 20
- name: Create an incident
url: '#create-an-incident'
identifier: incidents-create-an-incident
Expand Down
365 changes: 359 additions & 6 deletions content/en/api/v2/incidents/examples.json

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions content/en/api/v2/incidents/request.CreateIncidentType.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"data": {
"attributes": {
"description": "8d4bbb66dccf2456",
"is_default": true,
"name": "8d4bbb66dccf2456"
},
"type": "incident_types"
}
}
9 changes: 9 additions & 0 deletions content/en/api/v2/incidents/request.UpdateIncidentType.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"attributes": {
"name": "Security Incident-updated"
},
"type": "incident_types"
}
}
1 change: 1 addition & 0 deletions data/api/v1/full_spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23508,6 +23508,7 @@ components:
incident_notification_settings_write: Configure Incidents Notification
settings.
incident_read: View incidents in Datadog.
incident_settings_read: View Incident Settings.
incident_settings_write: Configure Incident Settings.
incident_write: Create, view, and manage incidents in Datadog.
metrics_read: View custom metrics.
Expand Down
1 change: 1 addition & 0 deletions data/api/v1/full_spec_deref.json
Original file line number Diff line number Diff line change
Expand Up @@ -666384,6 +666384,7 @@
"hosts_read": "List hosts and their attributes.",
"incident_notification_settings_write": "Configure Incidents Notification settings.",
"incident_read": "View incidents in Datadog.",
"incident_settings_read": "View Incident Settings.",
"incident_settings_write": "Configure Incident Settings.",
"incident_write": "Create, view, and manage incidents in Datadog.",
"metrics_read": "View custom metrics.",
Expand Down
14 changes: 14 additions & 0 deletions data/api/v2/CodeExamples.json
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,13 @@
"description": "Create an incident todo returns \"CREATED\" response"
}
],
"CreateIncidentType": [
{
"group": "incidents",
"suffix": "",
"description": "Create an incident type returns \"CREATED\" response"
}
],
"UpdateIncidentIntegration": [
{
"group": "incidents",
Expand All @@ -471,6 +478,13 @@
"description": "Update an incident todo returns \"OK\" response"
}
],
"UpdateIncidentType": [
{
"group": "incidents",
"suffix": "",
"description": "Update an incident type returns \"OK\" response"
}
],
"CreateAPIKey": [
{
"group": "key_management",
Expand Down
Loading
Loading