@@ -17458,20 +17458,20 @@ components:
1745817458 - finished_at
1745917459 type: object
1746017460 DORADeploymentPatchRemediation:
17461- description: Remediation details for the deployment.
17461+ description: Remediation details for the deployment. Optional, but required
17462+ to calculate failed deployment recovery time.
1746217463 properties:
1746317464 id:
17464- description: The ID of the remediation action.
17465+ description: The ID of the remediation deployment. Required when the failed
17466+ deployment must be linked to a remediation deployment.
1746517467 example: eG42zNIkVjM
1746617468 type: string
1746717469 type:
1746817470 $ref: '#/components/schemas/DORADeploymentPatchRemediationType'
17469- required:
17470- - id
17471- - type
1747217471 type: object
1747317472 DORADeploymentPatchRemediationType:
17474- description: The type of remediation action taken.
17473+ description: The type of remediation action taken. Required when the failed
17474+ deployment must be linked to a remediation deployment.
1747517475 enum:
1747617476 - rollback
1747717477 - rollforward
@@ -17675,47 +17675,47 @@ components:
1767517675 type: array
1767617676 type: object
1767717677 DORAFailureFetchResponse:
17678- description: Response for fetching a single failure event.
17678+ description: Response for fetching a single incident event.
1767917679 properties:
1768017680 data:
1768117681 $ref: '#/components/schemas/DORAIncidentObject'
1768217682 type: object
1768317683 DORAFailureRequest:
17684- description: Request to create a DORA failure event.
17684+ description: Request to create a DORA incident event.
1768517685 properties:
1768617686 data:
1768717687 $ref: '#/components/schemas/DORAFailureRequestData'
1768817688 required:
1768917689 - data
1769017690 type: object
1769117691 DORAFailureRequestAttributes:
17692- description: Attributes to create a DORA failure event.
17692+ description: Attributes to create a DORA incident event.
1769317693 properties:
1769417694 custom_tags:
1769517695 $ref: '#/components/schemas/DORACustomTags'
1769617696 env:
17697- description: Environment name that was impacted by the failure .
17697+ description: Environment name that was impacted by the incident .
1769817698 example: staging
1769917699 type: string
1770017700 finished_at:
17701- description: Unix timestamp when the failure finished. It must be in nanoseconds,
17701+ description: Unix timestamp when the incident finished. It must be in nanoseconds,
1770217702 milliseconds, or seconds.
1770317703 example: 1693491984000000000
1770417704 format: int64
1770517705 type: integer
1770617706 git:
1770717707 $ref: '#/components/schemas/DORAGitInfo'
1770817708 id:
17709- description: Failure ID. Must be 16-128 characters and contain only alphanumeric
17709+ description: Incident ID. Must be 16-128 characters and contain only alphanumeric
1771017710 characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9,
1771117711 -, _, ., :).
1771217712 type: string
1771317713 name:
17714- description: Failure name.
17714+ description: Incident name.
1771517715 example: Webserver is down failing all requests.
1771617716 type: string
1771717717 services:
17718- description: Service names impacted by the failure . If possible, use names
17718+ description: Service names impacted by the incident . If possible, use names
1771917719 registered in the Service Catalog. Required when the team field is not
1772017720 provided.
1772117721 example:
@@ -17724,11 +17724,11 @@ components:
1772417724 type: string
1772517725 type: array
1772617726 severity:
17727- description: Failure severity.
17727+ description: Incident severity.
1772817728 example: High
1772917729 type: string
1773017730 started_at:
17731- description: Unix timestamp when the failure started. It must be in nanoseconds,
17731+ description: Unix timestamp when the incident started. It must be in nanoseconds,
1773217732 milliseconds, or seconds.
1773317733 example: 1693491974000000000
1773417734 format: int64
@@ -17755,18 +17755,18 @@ components:
1775517755 - attributes
1775617756 type: object
1775717757 DORAFailureResponse:
17758- description: Response after receiving a DORA failure event.
17758+ description: Response after receiving a DORA incident event.
1775917759 properties:
1776017760 data:
1776117761 $ref: '#/components/schemas/DORAFailureResponseData'
1776217762 required:
1776317763 - data
1776417764 type: object
1776517765 DORAFailureResponseData:
17766- description: Response after receiving a DORA failure event.
17766+ description: Response after receiving a DORA incident event.
1776717767 properties:
1776817768 id:
17769- description: The ID of the received DORA failure event.
17769+ description: The ID of the received DORA incident event.
1777017770 example: 4242fcdd31586083
1777117771 type: string
1777217772 type:
@@ -17776,15 +17776,15 @@ components:
1777617776 type: object
1777717777 DORAFailureType:
1777817778 default: dora_failure
17779- description: JSON:API type for DORA failure events.
17779+ description: JSON:API type for DORA incident events.
1778017780 enum:
1778117781 - dora_failure
1778217782 example: dora_failure
1778317783 type: string
1778417784 x-enum-varnames:
1778517785 - DORA_FAILURE
1778617786 DORAFailuresListResponse:
17787- description: Response for the list failures endpoint.
17787+ description: Response for the list incidents endpoint.
1778817788 example:
1778917789 data:
1779017790 - attributes:
@@ -17918,7 +17918,7 @@ components:
1791817918 from: '2025-01-01T00:00:00Z'
1791917919 limit: 100
1792017920 query: service:(shopist OR api-service) env:production team:backend
17921- sort: -started_at
17921+ sort: -finished_at
1792217922 to: '2025-01-31T23:59:59Z'
1792317923 type: dora_deployments_list_request
1792417924 properties:
@@ -17949,7 +17949,7 @@ components:
1794917949 type: string
1795017950 sort:
1795117951 description: Sort order (prefixed with `-` for descending).
17952- example: -started_at
17952+ example: -finished_at
1795317953 type: string
1795417954 to:
1795517955 description: Maximum timestamp for requested events.
@@ -17985,7 +17985,7 @@ components:
1798517985 x-enum-varnames:
1798617986 - DORA_DEPLOYMENTS_LIST_REQUEST
1798717987 DORAListFailuresRequest:
17988- description: Request to get a list of failures .
17988+ description: Request to get a list of incidents .
1798917989 example:
1799017990 data:
1799117991 attributes:
@@ -18002,7 +18002,7 @@ components:
1800218002 - data
1800318003 type: object
1800418004 DORAListFailuresRequestAttributes:
18005- description: Attributes to get a list of failures .
18005+ description: Attributes to get a list of incidents .
1800618006 properties:
1800718007 from:
1800818008 description: Minimum timestamp for requested events.
@@ -39639,8 +39639,6 @@ components:
3963939639 $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsDiskType'
3964039640 when_full:
3964139641 $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsWhenFull'
39642- required:
39643- - max_size
3964439642 type: object
3964539643 ObservabilityPipelineElasticsearchDestination:
3964639644 description: 'The `elasticsearch` destination writes logs to an Elasticsearch
@@ -40894,8 +40892,6 @@ components:
4089440892 $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsMemoryType'
4089540893 when_full:
4089640894 $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsWhenFull'
40897- required:
40898- - max_size
4089940895 type: object
4090040896 ObservabilityPipelineMemoryBufferSizeOptions:
4090140897 description: Options for configuring a memory buffer by queue length.
@@ -40909,8 +40905,6 @@ components:
4090940905 $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsMemoryType'
4091040906 when_full:
4091140907 $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsWhenFull'
40912- required:
40913- - max_events
4091440908 type: object
4091540909 ObservabilityPipelineMetadataEntry:
4091640910 description: A custom metadata entry.
@@ -77057,7 +77051,9 @@ paths:
7705777051
7705877052 - Change Lead Time
7705977053
77060- - Change Failure Rate'
77054+ - Change Failure Rate
77055+
77056+ - Failed Deployment Recovery Time'
7706177057 operationId: CreateDORADeployment
7706277058 requestBody:
7706377059 content:
@@ -77206,7 +77202,9 @@ paths:
7720677202 permissions:
7720777203 - dora_metrics_read
7720877204 patch:
77209- description: Use this API endpoint to patch a deployment event.
77205+ description: Update a deployment's change failure status. Use this to mark a
77206+ deployment as a change failure or back to stable. You can optionally include
77207+ remediation details to enable failed deployment recovery time calculation.
7721077208 operationId: PatchDORADeployment
7721177209 parameters:
7721277210 - description: The ID of the deployment event.
@@ -77247,14 +77245,14 @@ paths:
7724777245 - dora_metrics_write
7724877246 /api/v2/dora/failure:
7724977247 post:
77250- description: 'Use this API endpoint to provide failure data.
77251-
77252-
77253- This is necessary for:
77248+ description: 'Use this API endpoint to provide incident data for DORA Metrics.
7725477249
77255- - Change Failure Rate
77250+ Note that change failure rate and failed deployment recovery time are computed
77251+ from change failures detected on deployments, not from incident events sent
77252+ through this endpoint.
7725677253
77257- - Time to Restore'
77254+ Tracking incidents gives a side-by-side view of how failed deployments translate
77255+ into real-world incidents, including their severity and frequency.'
7725877256 operationId: CreateDORAFailure
7725977257 requestBody:
7726077258 content:
@@ -77287,16 +77285,16 @@ paths:
7728777285 $ref: '#/components/responses/TooManyRequestsResponse'
7728877286 security:
7728977287 - apiKeyAuth: []
77290- summary: Send a failure event
77288+ summary: Send an incident event
7729177289 tags:
7729277290 - DORA Metrics
7729377291 x-codegen-request-body-name: body
7729477292 /api/v2/dora/failure/{failure_id}:
7729577293 delete:
77296- description: Use this API endpoint to delete a failure event.
77294+ description: Use this API endpoint to delete an incident event.
7729777295 operationId: DeleteDORAFailure
7729877296 parameters:
77299- - description: The ID of the failure event to delete.
77297+ - description: The ID of the incident event to delete.
7730077298 in: path
7730177299 name: failure_id
7730277300 required: true
@@ -77318,7 +77316,7 @@ paths:
7731877316 security:
7731977317 - apiKeyAuth: []
7732077318 appKeyAuth: []
77321- summary: Delete a failure event
77319+ summary: Delete an incident event
7732277320 tags:
7732377321 - DORA Metrics
7732477322 x-permission:
@@ -77327,7 +77325,7 @@ paths:
7732777325 - dora_metrics_write
7732877326 /api/v2/dora/failures:
7732977327 post:
77330- description: Use this API endpoint to get a list of failure events.
77328+ description: Use this API endpoint to get a list of incident events.
7733177329 operationId: ListDORAFailures
7733277330 requestBody:
7733377331 content:
@@ -77355,7 +77353,7 @@ paths:
7735577353 security:
7735677354 - apiKeyAuth: []
7735777355 appKeyAuth: []
77358- summary: Get a list of failure events
77356+ summary: Get a list of incident events
7735977357 tags:
7736077358 - DORA Metrics
7736177359 x-codegen-request-body-name: body
@@ -77365,10 +77363,10 @@ paths:
7736577363 - dora_metrics_read
7736677364 /api/v2/dora/failures/{failure_id}:
7736777365 get:
77368- description: Use this API endpoint to get a failure event.
77366+ description: Use this API endpoint to get an incident event.
7736977367 operationId: GetDORAFailure
7737077368 parameters:
77371- - description: The ID of the failure event.
77369+ - description: The ID of the incident event.
7737277370 in: path
7737377371 name: failure_id
7737477372 required: true
@@ -77394,7 +77392,7 @@ paths:
7739477392 security:
7739577393 - apiKeyAuth: []
7739677394 appKeyAuth: []
77397- summary: Get a failure event
77395+ summary: Get an incident event
7739877396 tags:
7739977397 - DORA Metrics
7740077398 x-codegen-request-body-name: body
@@ -77409,14 +77407,10 @@ paths:
7740977407 instead.
7741077408
7741177409
77412- Use this API endpoint to provide failure data.
77410+ Use this API endpoint to provide incident data.
7741377411
77414-
77415- This is necessary for:
77416-
77417- - Change Failure Rate
77418-
77419- - Time to Restore'
77412+ Tracking incidents gives a side-by-side view of how failed deployments translate
77413+ into real-world incidents.'
7742077414 operationId: CreateDORAIncident
7742177415 requestBody:
7742277416 content:
@@ -77449,7 +77443,7 @@ paths:
7744977443 $ref: '#/components/responses/TooManyRequestsResponse'
7745077444 security:
7745177445 - apiKeyAuth: []
77452- summary: Send an incident event
77446+ summary: Send an incident event (legacy)
7745377447 tags:
7745477448 - DORA Metrics
7745577449 x-codegen-request-body-name: body
0 commit comments