@@ -17794,20 +17794,20 @@ components:
1779417794 - finished_at
1779517795 type: object
1779617796 DORADeploymentPatchRemediation:
17797- description: Remediation details for the deployment.
17797+ description: Remediation details for the deployment. Optional, but required
17798+ to calculate failed deployment recovery time.
1779817799 properties:
1779917800 id:
17800- description: The ID of the remediation action.
17801+ description: The ID of the remediation deployment. Required when the failed
17802+ deployment must be linked to a remediation deployment.
1780117803 example: eG42zNIkVjM
1780217804 type: string
1780317805 type:
1780417806 $ref: '#/components/schemas/DORADeploymentPatchRemediationType'
17805- required:
17806- - id
17807- - type
1780817807 type: object
1780917808 DORADeploymentPatchRemediationType:
17810- description: The type of remediation action taken.
17809+ description: The type of remediation action taken. Required when the failed
17810+ deployment must be linked to a remediation deployment.
1781117811 enum:
1781217812 - rollback
1781317813 - rollforward
@@ -18011,47 +18011,47 @@ components:
1801118011 type: array
1801218012 type: object
1801318013 DORAFailureFetchResponse:
18014- description: Response for fetching a single failure event.
18014+ description: Response for fetching a single incident event.
1801518015 properties:
1801618016 data:
1801718017 $ref: '#/components/schemas/DORAIncidentObject'
1801818018 type: object
1801918019 DORAFailureRequest:
18020- description: Request to create a DORA failure event.
18020+ description: Request to create a DORA incident event.
1802118021 properties:
1802218022 data:
1802318023 $ref: '#/components/schemas/DORAFailureRequestData'
1802418024 required:
1802518025 - data
1802618026 type: object
1802718027 DORAFailureRequestAttributes:
18028- description: Attributes to create a DORA failure event.
18028+ description: Attributes to create a DORA incident event.
1802918029 properties:
1803018030 custom_tags:
1803118031 $ref: '#/components/schemas/DORACustomTags'
1803218032 env:
18033- description: Environment name that was impacted by the failure .
18033+ description: Environment name that was impacted by the incident .
1803418034 example: staging
1803518035 type: string
1803618036 finished_at:
18037- description: Unix timestamp when the failure finished. It must be in nanoseconds,
18037+ description: Unix timestamp when the incident finished. It must be in nanoseconds,
1803818038 milliseconds, or seconds.
1803918039 example: 1693491984000000000
1804018040 format: int64
1804118041 type: integer
1804218042 git:
1804318043 $ref: '#/components/schemas/DORAGitInfo'
1804418044 id:
18045- description: Failure ID. Must be 16-128 characters and contain only alphanumeric
18045+ description: Incident ID. Must be 16-128 characters and contain only alphanumeric
1804618046 characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9,
1804718047 -, _, ., :).
1804818048 type: string
1804918049 name:
18050- description: Failure name.
18050+ description: Incident name.
1805118051 example: Webserver is down failing all requests.
1805218052 type: string
1805318053 services:
18054- description: Service names impacted by the failure . If possible, use names
18054+ description: Service names impacted by the incident . If possible, use names
1805518055 registered in the Service Catalog. Required when the team field is not
1805618056 provided.
1805718057 example:
@@ -18060,11 +18060,11 @@ components:
1806018060 type: string
1806118061 type: array
1806218062 severity:
18063- description: Failure severity.
18063+ description: Incident severity.
1806418064 example: High
1806518065 type: string
1806618066 started_at:
18067- description: Unix timestamp when the failure started. It must be in nanoseconds,
18067+ description: Unix timestamp when the incident started. It must be in nanoseconds,
1806818068 milliseconds, or seconds.
1806918069 example: 1693491974000000000
1807018070 format: int64
@@ -18091,18 +18091,18 @@ components:
1809118091 - attributes
1809218092 type: object
1809318093 DORAFailureResponse:
18094- description: Response after receiving a DORA failure event.
18094+ description: Response after receiving a DORA incident event.
1809518095 properties:
1809618096 data:
1809718097 $ref: '#/components/schemas/DORAFailureResponseData'
1809818098 required:
1809918099 - data
1810018100 type: object
1810118101 DORAFailureResponseData:
18102- description: Response after receiving a DORA failure event.
18102+ description: Response after receiving a DORA incident event.
1810318103 properties:
1810418104 id:
18105- description: The ID of the received DORA failure event.
18105+ description: The ID of the received DORA incident event.
1810618106 example: 4242fcdd31586083
1810718107 type: string
1810818108 type:
@@ -18112,15 +18112,15 @@ components:
1811218112 type: object
1811318113 DORAFailureType:
1811418114 default: dora_failure
18115- description: JSON:API type for DORA failure events.
18115+ description: JSON:API type for DORA incident events.
1811618116 enum:
1811718117 - dora_failure
1811818118 example: dora_failure
1811918119 type: string
1812018120 x-enum-varnames:
1812118121 - DORA_FAILURE
1812218122 DORAFailuresListResponse:
18123- description: Response for the list failures endpoint.
18123+ description: Response for the list incidents endpoint.
1812418124 example:
1812518125 data:
1812618126 - attributes:
@@ -18254,7 +18254,7 @@ components:
1825418254 from: '2025-01-01T00:00:00Z'
1825518255 limit: 100
1825618256 query: service:(shopist OR api-service) env:production team:backend
18257- sort: -started_at
18257+ sort: -finished_at
1825818258 to: '2025-01-31T23:59:59Z'
1825918259 type: dora_deployments_list_request
1826018260 properties:
@@ -18285,7 +18285,7 @@ components:
1828518285 type: string
1828618286 sort:
1828718287 description: Sort order (prefixed with `-` for descending).
18288- example: -started_at
18288+ example: -finished_at
1828918289 type: string
1829018290 to:
1829118291 description: Maximum timestamp for requested events.
@@ -18321,7 +18321,7 @@ components:
1832118321 x-enum-varnames:
1832218322 - DORA_DEPLOYMENTS_LIST_REQUEST
1832318323 DORAListFailuresRequest:
18324- description: Request to get a list of failures .
18324+ description: Request to get a list of incidents .
1832518325 example:
1832618326 data:
1832718327 attributes:
@@ -18338,7 +18338,7 @@ components:
1833818338 - data
1833918339 type: object
1834018340 DORAListFailuresRequestAttributes:
18341- description: Attributes to get a list of failures .
18341+ description: Attributes to get a list of incidents .
1834218342 properties:
1834318343 from:
1834418344 description: Minimum timestamp for requested events.
@@ -77825,7 +77825,9 @@ paths:
7782577825
7782677826 - Change Lead Time
7782777827
77828- - Change Failure Rate'
77828+ - Change Failure Rate
77829+
77830+ - Failed Deployment Recovery Time'
7782977831 operationId: CreateDORADeployment
7783077832 requestBody:
7783177833 content:
@@ -77974,7 +77976,9 @@ paths:
7797477976 permissions:
7797577977 - dora_metrics_read
7797677978 patch:
77977- description: Use this API endpoint to patch a deployment event.
77979+ description: Update a deployment's change failure status. Use this to mark a
77980+ deployment as a change failure or back to stable. You can optionally include
77981+ remediation details to enable failed deployment recovery time calculation.
7797877982 operationId: PatchDORADeployment
7797977983 parameters:
7798077984 - description: The ID of the deployment event.
@@ -78015,14 +78019,14 @@ paths:
7801578019 - dora_metrics_write
7801678020 /api/v2/dora/failure:
7801778021 post:
78018- description: 'Use this API endpoint to provide failure data.
78022+ description: 'Use this API endpoint to provide incident data for DORA Metrics .
7801978023
78024+ Note that change failure rate and failed deployment recovery time are computed
78025+ from change failures detected on deployments, not from incident events sent
78026+ through this endpoint.
7802078027
78021- This is necessary for:
78022-
78023- - Change Failure Rate
78024-
78025- - Time to Restore'
78028+ Tracking incidents gives a side-by-side view of how failed deployments translate
78029+ into real-world incidents, including their severity and frequency.'
7802678030 operationId: CreateDORAFailure
7802778031 requestBody:
7802878032 content:
@@ -78055,16 +78059,16 @@ paths:
7805578059 $ref: '#/components/responses/TooManyRequestsResponse'
7805678060 security:
7805778061 - apiKeyAuth: []
78058- summary: Send a failure event
78062+ summary: Send an incident event
7805978063 tags:
7806078064 - DORA Metrics
7806178065 x-codegen-request-body-name: body
7806278066 /api/v2/dora/failure/{failure_id}:
7806378067 delete:
78064- description: Use this API endpoint to delete a failure event.
78068+ description: Use this API endpoint to delete an incident event.
7806578069 operationId: DeleteDORAFailure
7806678070 parameters:
78067- - description: The ID of the failure event to delete.
78071+ - description: The ID of the incident event to delete.
7806878072 in: path
7806978073 name: failure_id
7807078074 required: true
@@ -78086,7 +78090,7 @@ paths:
7808678090 security:
7808778091 - apiKeyAuth: []
7808878092 appKeyAuth: []
78089- summary: Delete a failure event
78093+ summary: Delete an incident event
7809078094 tags:
7809178095 - DORA Metrics
7809278096 x-permission:
@@ -78095,7 +78099,7 @@ paths:
7809578099 - dora_metrics_write
7809678100 /api/v2/dora/failures:
7809778101 post:
78098- description: Use this API endpoint to get a list of failure events.
78102+ description: Use this API endpoint to get a list of incident events.
7809978103 operationId: ListDORAFailures
7810078104 requestBody:
7810178105 content:
@@ -78123,7 +78127,7 @@ paths:
7812378127 security:
7812478128 - apiKeyAuth: []
7812578129 appKeyAuth: []
78126- summary: Get a list of failure events
78130+ summary: Get a list of incident events
7812778131 tags:
7812878132 - DORA Metrics
7812978133 x-codegen-request-body-name: body
@@ -78133,10 +78137,10 @@ paths:
7813378137 - dora_metrics_read
7813478138 /api/v2/dora/failures/{failure_id}:
7813578139 get:
78136- description: Use this API endpoint to get a failure event.
78140+ description: Use this API endpoint to get an incident event.
7813778141 operationId: GetDORAFailure
7813878142 parameters:
78139- - description: The ID of the failure event.
78143+ - description: The ID of the incident event.
7814078144 in: path
7814178145 name: failure_id
7814278146 required: true
@@ -78162,7 +78166,7 @@ paths:
7816278166 security:
7816378167 - apiKeyAuth: []
7816478168 appKeyAuth: []
78165- summary: Get a failure event
78169+ summary: Get an incident event
7816678170 tags:
7816778171 - DORA Metrics
7816878172 x-codegen-request-body-name: body
@@ -78177,14 +78181,10 @@ paths:
7817778181 instead.
7817878182
7817978183
78180- Use this API endpoint to provide failure data.
78181-
78184+ Use this API endpoint to provide incident data.
7818278185
78183- This is necessary for:
78184-
78185- - Change Failure Rate
78186-
78187- - Time to Restore'
78186+ Tracking incidents gives a side-by-side view of how failed deployments translate
78187+ into real-world incidents.'
7818878188 operationId: CreateDORAIncident
7818978189 requestBody:
7819078190 content:
@@ -78217,7 +78217,7 @@ paths:
7821778217 $ref: '#/components/responses/TooManyRequestsResponse'
7821878218 security:
7821978219 - apiKeyAuth: []
78220- summary: Send an incident event
78220+ summary: Send an incident event (legacy)
7822178221 tags:
7822278222 - DORA Metrics
7822378223 x-codegen-request-body-name: body
0 commit comments