@@ -17457,10 +17457,12 @@ components:
1745717457 - finished_at
1745817458 type: object
1745917459 DORADeploymentPatchRemediation:
17460- description: Remediation details for the deployment.
17460+ description: Remediation details for the deployment. Optional, but required
17461+ to calculate failed deployment recovery time.
1746117462 properties:
1746217463 id:
17463- description: The ID of the remediation action.
17464+ description: The ID of the remediation deployment. Required when the type
17465+ field is provided.
1746417466 example: eG42zNIkVjM
1746517467 type: string
1746617468 type:
@@ -17470,7 +17472,8 @@ components:
1747017472 - type
1747117473 type: object
1747217474 DORADeploymentPatchRemediationType:
17473- description: The type of remediation action taken.
17475+ description: The type of remediation action taken. Required when the id field
17476+ is provided.
1747417477 enum:
1747517478 - rollback
1747617479 - rollforward
@@ -17674,47 +17677,47 @@ components:
1767417677 type: array
1767517678 type: object
1767617679 DORAFailureFetchResponse:
17677- description: Response for fetching a single failure event.
17680+ description: Response for fetching a single incident event.
1767817681 properties:
1767917682 data:
1768017683 $ref: '#/components/schemas/DORAIncidentObject'
1768117684 type: object
1768217685 DORAFailureRequest:
17683- description: Request to create a DORA failure event.
17686+ description: Request to create a DORA incident event.
1768417687 properties:
1768517688 data:
1768617689 $ref: '#/components/schemas/DORAFailureRequestData'
1768717690 required:
1768817691 - data
1768917692 type: object
1769017693 DORAFailureRequestAttributes:
17691- description: Attributes to create a DORA failure event.
17694+ description: Attributes to create a DORA incident event.
1769217695 properties:
1769317696 custom_tags:
1769417697 $ref: '#/components/schemas/DORACustomTags'
1769517698 env:
17696- description: Environment name that was impacted by the failure .
17699+ description: Environment name that was impacted by the incident .
1769717700 example: staging
1769817701 type: string
1769917702 finished_at:
17700- description: Unix timestamp when the failure finished. It must be in nanoseconds,
17703+ description: Unix timestamp when the incident finished. It must be in nanoseconds,
1770117704 milliseconds, or seconds.
1770217705 example: 1693491984000000000
1770317706 format: int64
1770417707 type: integer
1770517708 git:
1770617709 $ref: '#/components/schemas/DORAGitInfo'
1770717710 id:
17708- description: Failure ID. Must be 16-128 characters and contain only alphanumeric
17711+ description: Incident ID. Must be 16-128 characters and contain only alphanumeric
1770917712 characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9,
1771017713 -, _, ., :).
1771117714 type: string
1771217715 name:
17713- description: Failure name.
17716+ description: Incident name.
1771417717 example: Webserver is down failing all requests.
1771517718 type: string
1771617719 services:
17717- description: Service names impacted by the failure . If possible, use names
17720+ description: Service names impacted by the incident . If possible, use names
1771817721 registered in the Service Catalog. Required when the team field is not
1771917722 provided.
1772017723 example:
@@ -17723,11 +17726,11 @@ components:
1772317726 type: string
1772417727 type: array
1772517728 severity:
17726- description: Failure severity.
17729+ description: Incident severity.
1772717730 example: High
1772817731 type: string
1772917732 started_at:
17730- description: Unix timestamp when the failure started. It must be in nanoseconds,
17733+ description: Unix timestamp when the incident started. It must be in nanoseconds,
1773117734 milliseconds, or seconds.
1773217735 example: 1693491974000000000
1773317736 format: int64
@@ -17754,18 +17757,18 @@ components:
1775417757 - attributes
1775517758 type: object
1775617759 DORAFailureResponse:
17757- description: Response after receiving a DORA failure event.
17760+ description: Response after receiving a DORA incident event.
1775817761 properties:
1775917762 data:
1776017763 $ref: '#/components/schemas/DORAFailureResponseData'
1776117764 required:
1776217765 - data
1776317766 type: object
1776417767 DORAFailureResponseData:
17765- description: Response after receiving a DORA failure event.
17768+ description: Response after receiving a DORA incident event.
1776617769 properties:
1776717770 id:
17768- description: The ID of the received DORA failure event.
17771+ description: The ID of the received DORA incident event.
1776917772 example: 4242fcdd31586083
1777017773 type: string
1777117774 type:
@@ -17775,15 +17778,15 @@ components:
1777517778 type: object
1777617779 DORAFailureType:
1777717780 default: dora_failure
17778- description: JSON:API type for DORA failure events.
17781+ description: JSON:API type for DORA incident events.
1777917782 enum:
1778017783 - dora_failure
1778117784 example: dora_failure
1778217785 type: string
1778317786 x-enum-varnames:
1778417787 - DORA_FAILURE
1778517788 DORAFailuresListResponse:
17786- description: Response for the list failures endpoint.
17789+ description: Response for the list incidents endpoint.
1778717790 example:
1778817791 data:
1778917792 - attributes:
@@ -17917,7 +17920,7 @@ components:
1791717920 from: '2025-01-01T00:00:00Z'
1791817921 limit: 100
1791917922 query: service:(shopist OR api-service) env:production team:backend
17920- sort: -started_at
17923+ sort: -finished_at
1792117924 to: '2025-01-31T23:59:59Z'
1792217925 type: dora_deployments_list_request
1792317926 properties:
@@ -17984,7 +17987,7 @@ components:
1798417987 x-enum-varnames:
1798517988 - DORA_DEPLOYMENTS_LIST_REQUEST
1798617989 DORAListFailuresRequest:
17987- description: Request to get a list of failures .
17990+ description: Request to get a list of incidents .
1798817991 example:
1798917992 data:
1799017993 attributes:
@@ -18001,7 +18004,7 @@ components:
1800118004 - data
1800218005 type: object
1800318006 DORAListFailuresRequestAttributes:
18004- description: Attributes to get a list of failures .
18007+ description: Attributes to get a list of incidents .
1800518008 properties:
1800618009 from:
1800718010 description: Minimum timestamp for requested events.
@@ -76477,7 +76480,9 @@ paths:
7647776480
7647876481 - Change Lead Time
7647976482
76480- - Change Failure Rate'
76483+ - Change Failure Rate
76484+
76485+ - Failed Deployment Recovery Time'
7648176486 operationId: CreateDORADeployment
7648276487 requestBody:
7648376488 content:
@@ -76626,7 +76631,13 @@ paths:
7662676631 permissions:
7662776632 - dora_metrics_read
7662876633 patch:
76629- description: Use this API endpoint to patch a deployment event.
76634+ description: 'Update a deployment''s change failure status. Use this to mark
76635+ a deployment as a change
76636+
76637+ failure or back to stable. You can optionally include remediation details
76638+ to enable
76639+
76640+ failed deployment recovery time calculation.'
7663076641 operationId: PatchDORADeployment
7663176642 parameters:
7663276643 - description: The ID of the deployment event.
@@ -76667,14 +76678,18 @@ paths:
7666776678 - dora_metrics_write
7666876679 /api/v2/dora/failure:
7666976680 post:
76670- description: 'Use this API endpoint to provide failure data.
76681+ description: 'Use this API endpoint to provide incident data for DORA Metrics .
7667176682
76683+ Note that change failure rate and failed deployment recovery time are computed
76684+ from
7667276685
76673- This is necessary for:
76686+ change failures detected on deployments,
7667476687
76675- - Change Failure Rate
76688+ not from incident events sent through this endpoint.
76689+
76690+ Tracking incidents gives a side-by-side view of how failed deployments translate
7667676691
76677- - Time to Restore '
76692+ into real-world incidents, including their severity and frequency. '
7667876693 operationId: CreateDORAFailure
7667976694 requestBody:
7668076695 content:
@@ -76707,16 +76722,16 @@ paths:
7670776722 $ref: '#/components/responses/TooManyRequestsResponse'
7670876723 security:
7670976724 - apiKeyAuth: []
76710- summary: Send a failure event
76725+ summary: Send an incident event
7671176726 tags:
7671276727 - DORA Metrics
7671376728 x-codegen-request-body-name: body
7671476729 /api/v2/dora/failure/{failure_id}:
7671576730 delete:
76716- description: Use this API endpoint to delete a failure event.
76731+ description: Use this API endpoint to delete an incident event.
7671776732 operationId: DeleteDORAFailure
7671876733 parameters:
76719- - description: The ID of the failure event to delete.
76734+ - description: The ID of the incident event to delete.
7672076735 in: path
7672176736 name: failure_id
7672276737 required: true
@@ -76738,7 +76753,7 @@ paths:
7673876753 security:
7673976754 - apiKeyAuth: []
7674076755 appKeyAuth: []
76741- summary: Delete a failure event
76756+ summary: Delete an incident event
7674276757 tags:
7674376758 - DORA Metrics
7674476759 x-permission:
@@ -76747,7 +76762,7 @@ paths:
7674776762 - dora_metrics_write
7674876763 /api/v2/dora/failures:
7674976764 post:
76750- description: Use this API endpoint to get a list of failure events.
76765+ description: Use this API endpoint to get a list of incident events.
7675176766 operationId: ListDORAFailures
7675276767 requestBody:
7675376768 content:
@@ -76775,7 +76790,7 @@ paths:
7677576790 security:
7677676791 - apiKeyAuth: []
7677776792 appKeyAuth: []
76778- summary: Get a list of failure events
76793+ summary: Get a list of incident events
7677976794 tags:
7678076795 - DORA Metrics
7678176796 x-codegen-request-body-name: body
@@ -76785,10 +76800,10 @@ paths:
7678576800 - dora_metrics_read
7678676801 /api/v2/dora/failures/{failure_id}:
7678776802 get:
76788- description: Use this API endpoint to get a failure event.
76803+ description: Use this API endpoint to get an incident event.
7678976804 operationId: GetDORAFailure
7679076805 parameters:
76791- - description: The ID of the failure event.
76806+ - description: The ID of the incident event.
7679276807 in: path
7679376808 name: failure_id
7679476809 required: true
@@ -76814,7 +76829,7 @@ paths:
7681476829 security:
7681576830 - apiKeyAuth: []
7681676831 appKeyAuth: []
76817- summary: Get a failure event
76832+ summary: Get an incident event
7681876833 tags:
7681976834 - DORA Metrics
7682076835 x-codegen-request-body-name: body
@@ -76829,14 +76844,10 @@ paths:
7682976844 instead.
7683076845
7683176846
76832- Use this API endpoint to provide failure data.
76847+ Use this API endpoint to provide incident data.
7683376848
76834-
76835- This is necessary for:
76836-
76837- - Change Failure Rate
76838-
76839- - Time to Restore'
76849+ Tracking incidents gives a side-by-side view of how failed deployments translate
76850+ into real-world incidents.'
7684076851 operationId: CreateDORAIncident
7684176852 requestBody:
7684276853 content:
@@ -76869,7 +76880,7 @@ paths:
7686976880 $ref: '#/components/responses/TooManyRequestsResponse'
7687076881 security:
7687176882 - apiKeyAuth: []
76872- summary: Send an incident event
76883+ summary: Send an incident event (deprecated)
7687376884 tags:
7687476885 - DORA Metrics
7687576886 x-codegen-request-body-name: body
0 commit comments