diff --git a/content/en/api/v2/dora-metrics/examples.json b/content/en/api/v2/dora-metrics/examples.json index e01719a20be..44c3105b218 100644 --- a/content/en/api/v2/dora-metrics/examples.json +++ b/content/en/api/v2/dora-metrics/examples.json @@ -183,7 +183,7 @@ } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

The list of DORA events.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the event.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the event.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of the event.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

The list of DORA deployment events.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the deployment event.

\n
\n
\n
\n
\n
\n

custom_tags

\n
\n

[string]

\n

A list of user-defined tags. The tags must follow the key:value pattern. Up to 100 may be added per event.

\n
\n \n
\n
\n
\n
\n
\n

env

\n
\n

string

\n

Environment name to where the service was deployed.

\n
\n \n
\n
\n
\n
\n
\n

finished_at [required]

\n
\n

int64

\n

Unix timestamp when the deployment finished.

\n
\n \n
\n
\n
\n
\n
\n

git

\n
\n

object

\n

Git info for DORA Metrics events.

\n
\n
\n
\n
\n
\n

commit_sha [required]

\n
\n

string

\n

Git Commit SHA.

\n
\n \n
\n
\n
\n
\n
\n

repository_url [required]

\n
\n

string

\n

Git Repository URL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

service [required]

\n
\n

string

\n

Service name.

\n
\n \n
\n
\n
\n
\n
\n

started_at [required]

\n
\n

int64

\n

Unix timestamp when the deployment started.

\n
\n \n
\n
\n
\n
\n
\n

team

\n
\n

string

\n

Name of the team owning the deployed service.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

string

\n

Version to correlate with APM Deployment Tracking.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the deployment event.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

JSON:API type for DORA deployment events. \nAllowed enum values: dora_deployment

default: dora_deployment

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -229,16 +229,16 @@ "json": { "data": { "attributes": { - "from": "2019-09-19T10:00:00.000Z", - "limit": "integer", - "query": "string", - "sort": "string", - "to": "2019-09-19T10:00:00.000Z" + "from": "2025-01-01T00:00:00Z", + "limit": 500, + "query": "service:(shopist OR api-service OR payment-service) env:(production OR staging) team:(backend OR platform)", + "sort": "-started_at", + "to": "2025-01-31T23:59:59Z" }, - "type": "string" + "type": "dora_deployments_list_request" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The JSON:API data.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes to get a list of deployments.

\n
\n
\n
\n
\n
\n

from

\n
\n

date-time

\n

Minimum timestamp for requested events.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int32

\n

Maximum number of events in the response.

default: 10

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Search query with event platform syntax.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

string

\n

Sort order (prefixed with - for descending).

\n
\n \n
\n
\n
\n
\n
\n

to

\n
\n

date-time

\n

Maximum timestamp for requested events.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The definition of DORAListDeploymentsRequestDataType object. \nAllowed enum values: dora_deployments_list_request

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The JSON:API data.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes to get a list of deployments.

\n
\n
\n
\n
\n
\n

from

\n
\n

date-time

\n

Minimum timestamp for requested events.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int32

\n

Maximum number of events in the response.

default: 10

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Search query with event platform syntax.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

string

\n

Sort order (prefixed with - for descending).

\n
\n \n
\n
\n
\n
\n
\n

to

\n
\n

date-time

\n

Maximum timestamp for requested events.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The definition of DORAListDeploymentsRequestDataType object. \nAllowed enum values: dora_deployments_list_request

default: dora_deployments_list_request

\n
\n \n
\n
\n
\n
" } }, "GetDORADeployment": { @@ -246,12 +246,27 @@ "200": { "json": { "data": { - "attributes": {}, + "attributes": { + "custom_tags": [ + "language:java", + "department:engineering" + ], + "env": "production", + "finished_at": 1693491984000000000, + "git": { + "commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588", + "repository_url": "https://github.com/organization/example-repository" + }, + "service": "shopist", + "started_at": 1693491974000000000, + "team": "backend", + "version": "v1.12.07" + }, "id": "string", - "type": "string" + "type": "dora_deployment" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A DORA event.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the event.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the event.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of the event.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A DORA deployment event.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the deployment event.

\n
\n
\n
\n
\n
\n

custom_tags

\n
\n

[string]

\n

A list of user-defined tags. The tags must follow the key:value pattern. Up to 100 may be added per event.

\n
\n \n
\n
\n
\n
\n
\n

env

\n
\n

string

\n

Environment name to where the service was deployed.

\n
\n \n
\n
\n
\n
\n
\n

finished_at [required]

\n
\n

int64

\n

Unix timestamp when the deployment finished.

\n
\n \n
\n
\n
\n
\n
\n

git

\n
\n

object

\n

Git info for DORA Metrics events.

\n
\n
\n
\n
\n
\n

commit_sha [required]

\n
\n

string

\n

Git Commit SHA.

\n
\n \n
\n
\n
\n
\n
\n

repository_url [required]

\n
\n

string

\n

Git Repository URL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

service [required]

\n
\n

string

\n

Service name.

\n
\n \n
\n
\n
\n
\n
\n

started_at [required]

\n
\n

int64

\n

Unix timestamp when the deployment started.

\n
\n \n
\n
\n
\n
\n
\n

team

\n
\n

string

\n

Name of the team owning the deployed service.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

string

\n

Version to correlate with APM Deployment Tracking.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the deployment event.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

JSON:API type for DORA deployment events. \nAllowed enum values: dora_deployment

default: dora_deployment

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -440,47 +455,45 @@ { "attributes": { "custom_tags": [ - "language:java", - "department:engineering", - "region:us-east-1" + "incident_type:database", + "department:engineering" ], "env": "production", - "finished_at": 1693491984000000000, - "git": { - "commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588", - "repository_url": "https://github.com/organization/example-repository" - }, - "service": "shopist", - "started_at": 1693491974000000000, - "team": "backend", - "version": "v1.12.07" + "finished_at": 1693492274000000000, + "name": "Database outage", + "services": [ + "shopist" + ], + "severity": "SEV-1", + "started_at": 1693492174000000000, + "team": "backend" }, - "id": "4242fcdd31586083", - "type": "dora_deployment" + "id": "4242fcdd31586085", + "type": "dora_incident" }, { "attributes": { "custom_tags": [ - "language:go", + "incident_type:service_down", "department:platform" ], "env": "production", - "finished_at": 1693492084000000000, - "git": { - "commit_sha": "77bdc9350f2cc9b250b69abddab733dd55e1a599", - "repository_url": "https://github.com/organization/api-service" - }, - "service": "api-service", - "started_at": 1693492074000000000, - "team": "backend", - "version": "v2.1.0" + "finished_at": 1693492474000000000, + "name": "API service outage", + "services": [ + "api-service", + "payment-service" + ], + "severity": "SEV-2", + "started_at": 1693492374000000000, + "team": "backend" }, - "id": "4242fcdd31586084", - "type": "dora_deployment" + "id": "4242fcdd31586086", + "type": "dora_incident" } ] }, - "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

The list of DORA events.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the event.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the event.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of the event.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

[object]

\n

The list of DORA incident events.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the incident event.

\n
\n
\n
\n
\n
\n

custom_tags

\n
\n

[string]

\n

A list of user-defined tags. The tags must follow the key:value pattern. Up to 100 may be added per event.

\n
\n \n
\n
\n
\n
\n
\n

env

\n
\n

string

\n

Environment name that was impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

finished_at

\n
\n

int64

\n

Unix timestamp when the incident finished.

\n
\n \n
\n
\n
\n
\n
\n

git

\n
\n

object

\n

Git info for DORA Metrics events.

\n
\n
\n
\n
\n
\n

commit_sha [required]

\n
\n

string

\n

Git Commit SHA.

\n
\n \n
\n
\n
\n
\n
\n

repository_url [required]

\n
\n

string

\n

Git Repository URL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Incident name.

\n
\n \n
\n
\n
\n
\n
\n

services

\n
\n

[string]

\n

Service names impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

severity

\n
\n

string

\n

Incident severity.

\n
\n \n
\n
\n
\n
\n
\n

started_at [required]

\n
\n

int64

\n

Unix timestamp when the incident started.

\n
\n \n
\n
\n
\n
\n
\n

team

\n
\n

string

\n

Name of the team owning the services impacted.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

string

\n

Version to correlate with APM Deployment Tracking.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the incident event.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

JSON:API type for DORA failure events. \nAllowed enum values: dora_failure

default: dora_failure

\n
\n \n
\n
\n
\n
" }, "400": { "json": { @@ -526,16 +539,16 @@ "json": { "data": { "attributes": { - "from": "2019-09-19T10:00:00.000Z", - "limit": "integer", - "query": "string", - "sort": "string", - "to": "2019-09-19T10:00:00.000Z" + "from": "2025-01-01T00:00:00Z", + "limit": 500, + "query": "severity:(SEV-1 OR SEV-2) env:(production OR staging) service:(shopist OR api-service OR payment-service) team:(backend OR platform OR payments)", + "sort": "-started_at", + "to": "2025-01-31T23:59:59Z" }, - "type": "string" + "type": "dora_failures_list_request" } }, - "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The JSON:API data.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes to get a list of failures.

\n
\n
\n
\n
\n
\n

from

\n
\n

date-time

\n

Minimum timestamp for requested events.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int32

\n

Maximum number of events in the response.

default: 10

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Search query with event platform syntax.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

string

\n

Sort order (prefixed with - for descending).

\n
\n \n
\n
\n
\n
\n
\n

to

\n
\n

date-time

\n

Maximum timestamp for requested events.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The definition of DORAListFailuresRequestDataType object. \nAllowed enum values: dora_failures_list_request

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data [required]

\n
\n

object

\n

The JSON:API data.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

Attributes to get a list of failures.

\n
\n
\n
\n
\n
\n

from

\n
\n

date-time

\n

Minimum timestamp for requested events.

\n
\n \n
\n
\n
\n
\n
\n

limit

\n
\n

int32

\n

Maximum number of events in the response.

default: 10

\n
\n \n
\n
\n
\n
\n
\n

query

\n
\n

string

\n

Search query with event platform syntax.

\n
\n \n
\n
\n
\n
\n
\n

sort

\n
\n

string

\n

Sort order (prefixed with - for descending).

\n
\n \n
\n
\n
\n
\n
\n

to

\n
\n

date-time

\n

Maximum timestamp for requested events.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

The definition of DORAListFailuresRequestDataType object. \nAllowed enum values: dora_failures_list_request

default: dora_failures_list_request

\n
\n \n
\n
\n
\n
" } }, "GetDORAFailure": { @@ -543,12 +556,31 @@ "200": { "json": { "data": { - "attributes": {}, + "attributes": { + "custom_tags": [ + "language:java", + "department:engineering" + ], + "env": "production", + "finished_at": 1693491984000000000, + "git": { + "commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588", + "repository_url": "https://github.com/organization/example-repository" + }, + "name": "Database outage", + "services": [ + "shopist" + ], + "severity": "SEV-1", + "started_at": 1693491974000000000, + "team": "backend", + "version": "v1.12.07" + }, "id": "string", - "type": "string" + "type": "dora_failure" } }, - "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A DORA event.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the event.

\n
\n \n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the event.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

string

\n

The type of the event.

\n
\n \n
\n
\n
\n
" + "html": "
\n
\n
\n
\n

data

\n
\n

object

\n

A DORA incident event.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

object

\n

The attributes of the incident event.

\n
\n
\n
\n
\n
\n

custom_tags

\n
\n

[string]

\n

A list of user-defined tags. The tags must follow the key:value pattern. Up to 100 may be added per event.

\n
\n \n
\n
\n
\n
\n
\n

env

\n
\n

string

\n

Environment name that was impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

finished_at

\n
\n

int64

\n

Unix timestamp when the incident finished.

\n
\n \n
\n
\n
\n
\n
\n

git

\n
\n

object

\n

Git info for DORA Metrics events.

\n
\n
\n
\n
\n
\n

commit_sha [required]

\n
\n

string

\n

Git Commit SHA.

\n
\n \n
\n
\n
\n
\n
\n

repository_url [required]

\n
\n

string

\n

Git Repository URL

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Incident name.

\n
\n \n
\n
\n
\n
\n
\n

services

\n
\n

[string]

\n

Service names impacted by the incident.

\n
\n \n
\n
\n
\n
\n
\n

severity

\n
\n

string

\n

Incident severity.

\n
\n \n
\n
\n
\n
\n
\n

started_at [required]

\n
\n

int64

\n

Unix timestamp when the incident started.

\n
\n \n
\n
\n
\n
\n
\n

team

\n
\n

string

\n

Name of the team owning the services impacted.

\n
\n \n
\n
\n
\n
\n
\n

version

\n
\n

string

\n

Version to correlate with APM Deployment Tracking.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

string

\n

The ID of the incident event.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

enum

\n

JSON:API type for DORA failure events. \nAllowed enum values: dora_failure

default: dora_failure

\n
\n \n
\n
\n
\n
" }, "400": { "json": { diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index e3b6cff203f..7b93c41e364 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -15785,6 +15785,78 @@ components: type: string nullable: true type: array + DORADeploymentFetchResponse: + description: Response for fetching a single deployment event. + properties: + data: + $ref: '#/components/schemas/DORADeploymentObject' + type: object + DORADeploymentObject: + description: A DORA deployment event. + example: + attributes: + custom_tags: + - language:java + - department:engineering + - region:us-east-1 + env: production + finished_at: 1693491984000000000 + git: + commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588 + repository_url: https://github.com/organization/example-repository + service: shopist + started_at: 1693491974000000000 + team: backend + version: v1.12.07 + id: 4242fcdd31586083 + type: dora_deployment + properties: + attributes: + $ref: '#/components/schemas/DORADeploymentObjectAttributes' + id: + description: The ID of the deployment event. + type: string + type: + $ref: '#/components/schemas/DORADeploymentType' + type: object + DORADeploymentObjectAttributes: + description: The attributes of the deployment event. + properties: + custom_tags: + $ref: '#/components/schemas/DORACustomTags' + env: + description: Environment name to where the service was deployed. + example: production + type: string + finished_at: + description: Unix timestamp when the deployment finished. + example: 1693491984000000000 + format: int64 + type: integer + git: + $ref: '#/components/schemas/DORAGitInfo' + service: + description: Service name. + example: shopist + type: string + started_at: + description: Unix timestamp when the deployment started. + example: 1693491974000000000 + format: int64 + type: integer + team: + description: Name of the team owning the deployed service. + example: backend + type: string + version: + description: Version to correlate with APM Deployment Tracking. + example: v1.12.07 + type: string + required: + - service + - started_at + - finished_at + type: object DORADeploymentRequest: description: Request to create a DORA deployment event. properties: @@ -15875,18 +15947,53 @@ components: type: string x-enum-varnames: - DORA_DEPLOYMENT - DORAEvent: - description: A DORA event. + DORADeploymentsListResponse: + description: Response for the list deployments endpoint. + example: + data: + - attributes: + custom_tags: + - language:java + - department:engineering + - region:us-east-1 + env: production + finished_at: 1693491984000000000 + git: + commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588 + repository_url: https://github.com/organization/example-repository + service: shopist + started_at: 1693491974000000000 + team: backend + version: v1.12.07 + id: 4242fcdd31586083 + type: dora_deployment + - attributes: + custom_tags: + - language:go + - department:platform + env: production + finished_at: 1693492084000000000 + git: + commit_sha: 77bdc9350f2cc9b250b69abddab733dd55e1a599 + repository_url: https://github.com/organization/api-service + service: api-service + started_at: 1693492074000000000 + team: backend + version: v2.1.0 + id: 4242fcdd31586084 + type: dora_deployment properties: - attributes: - description: The attributes of the event. - type: object - id: - description: The ID of the event. - type: string - type: - description: The type of the event. - type: string + data: + description: The list of DORA deployment events. + items: + $ref: '#/components/schemas/DORADeploymentObject' + type: array + type: object + DORAFailureFetchResponse: + description: Response for fetching a single failure event. + properties: + data: + $ref: '#/components/schemas/DORAIncidentObject' type: object DORAFailureRequest: description: Request to create a DORA failure event. @@ -15990,11 +16097,45 @@ components: type: string x-enum-varnames: - DORA_FAILURE - DORAFetchResponse: - description: Response for the DORA fetch endpoints. + DORAFailuresListResponse: + description: Response for the list failures endpoint. + example: + data: + - attributes: + custom_tags: + - incident_type:database + - department:engineering + env: production + finished_at: 1693492274000000000 + name: Database outage + services: + - shopist + severity: SEV-1 + started_at: 1693492174000000000 + team: backend + id: 4242fcdd31586085 + type: dora_incident + - attributes: + custom_tags: + - incident_type:service_down + - department:platform + env: production + finished_at: 1693492474000000000 + name: API service outage + services: + - api-service + - payment-service + severity: SEV-2 + started_at: 1693492374000000000 + team: backend + id: 4242fcdd31586086 + type: dora_incident properties: data: - $ref: '#/components/schemas/DORAEvent' + description: The list of DORA incident events. + items: + $ref: '#/components/schemas/DORAIncidentObject' + type: array type: object DORAGitInfo: description: Git info for DORA Metrics events. @@ -16007,6 +16148,82 @@ components: - repository_url - commit_sha type: object + DORAIncidentObject: + description: A DORA incident event. + example: + attributes: + custom_tags: + - incident_type:database + - department:engineering + env: production + finished_at: 1693492274000000000 + git: + commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588 + repository_url: https://github.com/organization/example-repository + name: Database outage + services: + - shopist + severity: SEV-1 + started_at: 1693492174000000000 + team: backend + id: 4242fcdd31586085 + type: dora_incident + properties: + attributes: + $ref: '#/components/schemas/DORAIncidentObjectAttributes' + id: + description: The ID of the incident event. + type: string + type: + $ref: '#/components/schemas/DORAFailureType' + type: object + DORAIncidentObjectAttributes: + description: The attributes of the incident event. + properties: + custom_tags: + $ref: '#/components/schemas/DORACustomTags' + env: + description: Environment name that was impacted by the incident. + example: production + type: string + finished_at: + description: Unix timestamp when the incident finished. + example: 1693491984000000000 + format: int64 + type: integer + git: + $ref: '#/components/schemas/DORAGitInfo' + name: + description: Incident name. + example: Database outage + type: string + services: + description: Service names impacted by the incident. + example: + - shopist + items: + type: string + type: array + severity: + description: Incident severity. + example: SEV-1 + type: string + started_at: + description: Unix timestamp when the incident started. + example: 1693491974000000000 + format: int64 + type: integer + team: + description: Name of the team owning the services impacted. + example: backend + type: string + version: + description: Version to correlate with APM Deployment Tracking. + example: v1.12.07 + type: string + required: + - started_at + type: object DORAListDeploymentsRequest: description: Request to get a list of deployments. example: @@ -16026,32 +16243,31 @@ components: type: object DORAListDeploymentsRequestAttributes: description: Attributes to get a list of deployments. - example: - from: '2025-01-01T00:00:00Z' - limit: 500 - query: service:(shopist OR api-service OR payment-service) env:(production - OR staging) team:(backend OR platform) - sort: -started_at - to: '2025-01-31T23:59:59Z' properties: from: description: Minimum timestamp for requested events. + example: '2025-01-01T00:00:00Z' format: date-time type: string limit: default: 10 description: Maximum number of events in the response. + example: 500 format: int32 maximum: 1000 type: integer query: description: Search query with event platform syntax. + example: service:(shopist OR api-service OR payment-service) env:(production + OR staging) team:(backend OR platform) type: string sort: description: Sort order (prefixed with `-` for descending). + example: -started_at type: string to: description: Maximum timestamp for requested events. + example: '2025-01-31T23:59:59Z' format: date-time type: string type: object @@ -16074,9 +16290,11 @@ components: - attributes type: object DORAListDeploymentsRequestDataType: + default: dora_deployments_list_request description: The definition of `DORAListDeploymentsRequestDataType` object. enum: - dora_deployments_list_request + example: dora_deployments_list_request type: string x-enum-varnames: - DORA_DEPLOYMENTS_LIST_REQUEST @@ -16099,32 +16317,31 @@ components: type: object DORAListFailuresRequestAttributes: description: Attributes to get a list of failures. - example: - from: '2025-01-01T00:00:00Z' - limit: 500 - query: severity:(SEV-1 OR SEV-2) env:(production OR staging) service:(shopist - OR api-service OR payment-service) team:(backend OR platform OR payments) - sort: -started_at - to: '2025-01-31T23:59:59Z' properties: from: description: Minimum timestamp for requested events. + example: '2025-01-01T00:00:00Z' format: date-time type: string limit: default: 10 description: Maximum number of events in the response. + example: 500 format: int32 maximum: 1000 type: integer query: description: Search query with event platform syntax. + example: severity:(SEV-1 OR SEV-2) env:(production OR staging) service:(shopist + OR api-service OR payment-service) team:(backend OR platform OR payments) type: string sort: description: Sort order (prefixed with `-` for descending). + example: -started_at type: string to: description: Maximum timestamp for requested events. + example: '2025-01-31T23:59:59Z' format: date-time type: string type: object @@ -16147,54 +16364,14 @@ components: - attributes type: object DORAListFailuresRequestDataType: + default: dora_failures_list_request description: The definition of `DORAListFailuresRequestDataType` object. enum: - dora_failures_list_request + example: dora_failures_list_request type: string x-enum-varnames: - DORA_FAILURES_LIST_REQUEST - DORAListResponse: - description: Response for the DORA list endpoints. - example: - data: - - attributes: - custom_tags: - - language:java - - department:engineering - - region:us-east-1 - env: production - finished_at: 1693491984000000000 - git: - commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588 - repository_url: https://github.com/organization/example-repository - service: shopist - started_at: 1693491974000000000 - team: backend - version: v1.12.07 - id: 4242fcdd31586083 - type: dora_deployment - - attributes: - custom_tags: - - language:go - - department:platform - env: production - finished_at: 1693492084000000000 - git: - commit_sha: 77bdc9350f2cc9b250b69abddab733dd55e1a599 - repository_url: https://github.com/organization/api-service - service: api-service - started_at: 1693492074000000000 - team: backend - version: v2.1.0 - id: 4242fcdd31586084 - type: dora_deployment - properties: - data: - description: The list of DORA events. - items: - $ref: '#/components/schemas/DORAEvent' - type: array - type: object DashboardListAddItemsRequest: description: Request containing a list of dashboards to add. properties: @@ -67946,7 +68123,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/DORAListResponse' + $ref: '#/components/schemas/DORADeploymentsListResponse' description: OK '400': content: @@ -67985,26 +68162,8 @@ paths: '200': content: application/json: - example: - data: - attributes: - custom_tags: - - language:java - - department:engineering - - region:us-east-1 - env: staging - finished_at: 1693491984000000000 - git: - commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588 - repository_url: https://github.com/organization/example-repository - service: shopist - started_at: 1693491974000000000 - team: backend - version: v1.12.07 - id: 4242fcdd31586083 - type: dora_deployment - schema: - $ref: '#/components/schemas/DORAFetchResponse' + schema: + $ref: '#/components/schemas/DORADeploymentFetchResponse' description: OK '400': content: @@ -68124,66 +68283,8 @@ paths: '200': content: application/json: - example: - data: - - attributes: - custom_tags: - - language:java - - department:engineering - - region:us-east-1 - env: production - finished_at: 1693491984000000000 - git: - commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588 - repository_url: https://github.com/organization/example-repository - name: Web server is down; all requests are failing. - services: - - shopist - severity: SEV-1 - started_at: 1693491974000000000 - team: backend - id: 4242fcdd31586085 - type: dora_failure - - attributes: - custom_tags: - - language:go - - department:platform - env: production - finished_at: 1693492084000000000 - git: - commit_sha: 77bdc9350f2cc9b250b69abddab733dd55e1a599 - repository_url: https://github.com/organization/api-service - name: Database connection timeout - services: - - api-service - - payment-service - severity: SEV-1 - started_at: 1693492074000000000 - team: platform - version: v2.1.0 - id: 4242fcdd31586086 - type: dora_failure - - attributes: - custom_tags: - - language:python - - department:payments - - region:eu-west-1 - env: staging - finished_at: 1693492204000000000 - git: - commit_sha: 99edc9350f2cc9b250b69abddab733dd55e1a601 - repository_url: https://github.com/organization/payment-service - name: Payment gateway API rate limit exceeded - services: - - payment-service - severity: SEV-2 - started_at: 1693492174000000000 - team: payments - version: v1.8.3 - id: 4242fcdd31586087 - type: dora_failure - schema: - $ref: '#/components/schemas/DORAListResponse' + schema: + $ref: '#/components/schemas/DORAFailuresListResponse' description: OK '400': content: @@ -68222,28 +68323,8 @@ paths: '200': content: application/json: - example: - data: - attributes: - custom_tags: - - language:java - - department:engineering - - region:us-east-1 - env: staging - finished_at: 1693491984000000000 - git: - commit_sha: 66adc9350f2cc9b250b69abddab733dd55e1a588 - repository_url: https://github.com/organization/example-repository - name: Web server is down; all requests are failing. - services: - - shopist - severity: High - started_at: 1693491974000000000 - team: backend - id: 4242fcdd31586085 - type: dora_failure - schema: - $ref: '#/components/schemas/DORAFetchResponse' + schema: + $ref: '#/components/schemas/DORAFailureFetchResponse' description: OK '400': content: