@@ -15837,6 +15837,15 @@ components:
1583715837 type: object
1583815838 DORAListDeploymentsRequest:
1583915839 description: Request to get a list of deployments.
15840+ example:
15841+ data:
15842+ attributes:
15843+ from: '2025-01-01T00:00:00Z'
15844+ limit: 100
15845+ query: service:(shopist OR api-service) env:production team:backend
15846+ sort: -started_at
15847+ to: '2025-01-31T23:59:59Z'
15848+ type: dora_deployments_list_request
1584015849 properties:
1584115850 data:
1584215851 $ref: '#/components/schemas/DORAListDeploymentsRequestData'
@@ -15845,6 +15854,13 @@ components:
1584515854 type: object
1584615855 DORAListDeploymentsRequestAttributes:
1584715856 description: Attributes to get a list of deployments.
15857+ example:
15858+ from: '2025-01-01T00:00:00Z'
15859+ limit: 500
15860+ query: service:(shopist OR api-service OR payment-service) env:(production
15861+ OR staging) team:(backend OR platform)
15862+ sort: -started_at
15863+ to: '2025-01-31T23:59:59Z'
1584815864 properties:
1584915865 from:
1585015866 description: Minimum timestamp for requested events.
@@ -15869,6 +15885,14 @@ components:
1586915885 type: object
1587015886 DORAListDeploymentsRequestData:
1587115887 description: The JSON:API data.
15888+ example:
15889+ attributes:
15890+ from: '2025-01-15T08:00:00Z'
15891+ limit: 200
15892+ query: env:production service:payment-service version:*v2*
15893+ sort: -finished_at
15894+ to: '2025-01-15T18:00:00Z'
15895+ type: dora_deployments_list_request
1587215896 properties:
1587315897 attributes:
1587415898 $ref: '#/components/schemas/DORAListDeploymentsRequestAttributes'
@@ -15886,6 +15910,15 @@ components:
1588615910 - DORA_DEPLOYMENTS_LIST_REQUEST
1588715911 DORAListFailuresRequest:
1588815912 description: Request to get a list of failures.
15913+ example:
15914+ data:
15915+ attributes:
15916+ from: '2025-01-01T00:00:00Z'
15917+ limit: 100
15918+ query: severity:(SEV-1 OR SEV-2) env:production team:backend
15919+ sort: -started_at
15920+ to: '2025-01-31T23:59:59Z'
15921+ type: dora_failures_list_request
1588915922 properties:
1589015923 data:
1589115924 $ref: '#/components/schemas/DORAListFailuresRequestData'
@@ -15894,6 +15927,13 @@ components:
1589415927 type: object
1589515928 DORAListFailuresRequestAttributes:
1589615929 description: Attributes to get a list of failures.
15930+ example:
15931+ from: '2025-01-01T00:00:00Z'
15932+ limit: 500
15933+ query: severity:(SEV-1 OR SEV-2) env:(production OR staging) service:(shopist
15934+ OR api-service OR payment-service) team:(backend OR platform OR payments)
15935+ sort: -started_at
15936+ to: '2025-01-31T23:59:59Z'
1589715937 properties:
1589815938 from:
1589915939 description: Minimum timestamp for requested events.
@@ -15918,6 +15958,14 @@ components:
1591815958 type: object
1591915959 DORAListFailuresRequestData:
1592015960 description: The JSON:API data.
15961+ example:
15962+ attributes:
15963+ from: '2025-01-15T00:00:00Z'
15964+ limit: 200
15965+ query: severity:SEV-1 service:(api-service OR payment-service) env:production
15966+ sort: -finished_at
15967+ to: '2025-01-15T23:59:59Z'
15968+ type: dora_failures_list_request
1592115969 properties:
1592215970 attributes:
1592315971 $ref: '#/components/schemas/DORAListFailuresRequestAttributes'
@@ -15935,6 +15983,39 @@ components:
1593515983 - DORA_FAILURES_LIST_REQUEST
1593615984 DORAListResponse:
1593715985 description: Response for the DORA list endpoints.
15986+ example:
15987+ data:
15988+ - attributes:
15989+ custom_tags:
15990+ - language:java
15991+ - department:engineering
15992+ - region:us-east-1
15993+ env: production
15994+ finished_at: 1693491984000000000
15995+ git:
15996+ commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588
15997+ repository_url: https://github.com/organization/example-repository
15998+ service: shopist
15999+ started_at: 1693491974000000000
16000+ team: backend
16001+ version: v1.12.07
16002+ id: 4242fcdd31586083
16003+ type: dora_deployment
16004+ - attributes:
16005+ custom_tags:
16006+ - language:go
16007+ - department:platform
16008+ env: production
16009+ finished_at: 1693492084000000000
16010+ git:
16011+ commit_sha: 77bdc9350f2cc9b250b69abddab733dd55e1a599
16012+ repository_url: https://github.com/organization/api-service
16013+ service: api-service
16014+ started_at: 1693492074000000000
16015+ team: backend
16016+ version: v2.1.0
16017+ id: 4242fcdd31586084
16018+ type: dora_deployment
1593816019 properties:
1593916020 data:
1594016021 description: The list of DORA events.
@@ -66790,6 +66871,24 @@ paths:
6679066871 '200':
6679166872 content:
6679266873 application/json:
66874+ example:
66875+ data:
66876+ attributes:
66877+ custom_tags:
66878+ - language:java
66879+ - department:engineering
66880+ - region:us-east-1
66881+ env: staging
66882+ finished_at: 1693491984000000000
66883+ git:
66884+ commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588
66885+ repository_url: https://github.com/organization/example-repository
66886+ service: shopist
66887+ started_at: 1693491974000000000
66888+ team: backend
66889+ version: v1.12.07
66890+ id: 4242fcdd31586083
66891+ type: dora_deployment
6679366892 schema:
6679466893 $ref: '#/components/schemas/DORAFetchResponse'
6679566894 description: OK
@@ -66908,6 +67007,64 @@ paths:
6690867007 '200':
6690967008 content:
6691067009 application/json:
67010+ example:
67011+ data:
67012+ - attributes:
67013+ custom_tags:
67014+ - language:java
67015+ - department:engineering
67016+ - region:us-east-1
67017+ env: production
67018+ finished_at: 1693491984000000000
67019+ git:
67020+ commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588
67021+ repository_url: https://github.com/organization/example-repository
67022+ name: Web server is down; all requests are failing.
67023+ services:
67024+ - shopist
67025+ severity: SEV-1
67026+ started_at: 1693491974000000000
67027+ team: backend
67028+ id: 4242fcdd31586085
67029+ type: dora_failure
67030+ - attributes:
67031+ custom_tags:
67032+ - language:go
67033+ - department:platform
67034+ env: production
67035+ finished_at: 1693492084000000000
67036+ git:
67037+ commit_sha: 77bdc9350f2cc9b250b69abddab733dd55e1a599
67038+ repository_url: https://github.com/organization/api-service
67039+ name: Database connection timeout
67040+ services:
67041+ - api-service
67042+ - payment-service
67043+ severity: SEV-1
67044+ started_at: 1693492074000000000
67045+ team: platform
67046+ version: v2.1.0
67047+ id: 4242fcdd31586086
67048+ type: dora_failure
67049+ - attributes:
67050+ custom_tags:
67051+ - language:python
67052+ - department:payments
67053+ - region:eu-west-1
67054+ env: staging
67055+ finished_at: 1693492204000000000
67056+ git:
67057+ commit_sha: 99edc9350f2cc9b250b69abddab733dd55e1a601
67058+ repository_url: https://github.com/organization/payment-service
67059+ name: Payment gateway API rate limit exceeded
67060+ services:
67061+ - payment-service
67062+ severity: SEV-2
67063+ started_at: 1693492174000000000
67064+ team: payments
67065+ version: v1.8.3
67066+ id: 4242fcdd31586087
67067+ type: dora_failure
6691167068 schema:
6691267069 $ref: '#/components/schemas/DORAListResponse'
6691367070 description: OK
@@ -66947,6 +67104,26 @@ paths:
6694767104 '200':
6694867105 content:
6694967106 application/json:
67107+ example:
67108+ data:
67109+ attributes:
67110+ custom_tags:
67111+ - language:java
67112+ - department:engineering
67113+ - region:us-east-1
67114+ env: staging
67115+ finished_at: 1693491984000000000
67116+ git:
67117+ commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588
67118+ repository_url: https://github.com/organization/example-repository
67119+ name: Web server is down; all requests are failing.
67120+ services:
67121+ - shopist
67122+ severity: High
67123+ started_at: 1693491974000000000
67124+ team: backend
67125+ id: 4242fcdd31586085
67126+ type: dora_failure
6695067127 schema:
6695167128 $ref: '#/components/schemas/DORAFetchResponse'
6695267129 description: OK
0 commit comments