Add examples for DORA deployments and failures list endpoints

.generator/schemas/v2/openapi.yaml

@@ -15837,6 +15837,15 @@ components:
       type: object
     DORAListDeploymentsRequest:
       description: Request to get a list of deployments.
+      example:
+        data:
+          attributes:
+            from: '2025-01-01T00:00:00Z'
+            limit: 100
+            query: service:(shopist OR api-service) env:production team:backend
+            sort: -started_at
+            to: '2025-01-31T23:59:59Z'
+          type: dora_deployments_list_request
       properties:
         data:
           $ref: '#/components/schemas/DORAListDeploymentsRequestData'
@@ -15845,6 +15854,13 @@ 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.
@@ -15869,6 +15885,14 @@ components:
       type: object
     DORAListDeploymentsRequestData:
       description: The JSON:API data.
+      example:
+        attributes:
+          from: '2025-01-15T08:00:00Z'
+          limit: 200
+          query: env:production service:payment-service version:*v2*
+          sort: -finished_at
+          to: '2025-01-15T18:00:00Z'
+        type: dora_deployments_list_request
       properties:
         attributes:
           $ref: '#/components/schemas/DORAListDeploymentsRequestAttributes'
@@ -15886,6 +15910,15 @@ components:
       - DORA_DEPLOYMENTS_LIST_REQUEST
     DORAListFailuresRequest:
       description: Request to get a list of failures.
+      example:
+        data:
+          attributes:
+            from: '2025-01-01T00:00:00Z'
+            limit: 100
+            query: severity:(SEV-1 OR SEV-2) env:production team:backend
+            sort: -started_at
+            to: '2025-01-31T23:59:59Z'
+          type: dora_failures_list_request
       properties:
         data:
           $ref: '#/components/schemas/DORAListFailuresRequestData'
@@ -15894,6 +15927,13 @@ 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.
@@ -15918,6 +15958,14 @@ components:
       type: object
     DORAListFailuresRequestData:
       description: The JSON:API data.
+      example:
+        attributes:
+          from: '2025-01-15T00:00:00Z'
+          limit: 200
+          query: severity:SEV-1 service:(api-service OR payment-service) env:production
+          sort: -finished_at
+          to: '2025-01-15T23:59:59Z'
+        type: dora_failures_list_request
       properties:
         attributes:
           $ref: '#/components/schemas/DORAListFailuresRequestAttributes'
@@ -15935,6 +15983,39 @@ components:
       - 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.
@@ -66790,6 +66871,24 @@ 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'
           description: OK
@@ -66908,6 +67007,64 @@ 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'
           description: OK
@@ -66947,6 +67104,26 @@ 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'
           description: OK