Skip to content

Add support for running CI jobs #3714

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add support for running CI jobs #3714

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
210 changes: 151 additions & 59 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13851,95 +13851,99 @@ components:
tags:
$ref: "#/components/schemas/TagsEventAttribute"
type: object
CIAppPipelineEventFinishedPipeline:
description: Details of a finished pipeline.
CIAppPipelineEventFinishedJob:
description: Details of a finished CI job.
properties:
dependencies:
description: A list of job IDs that this job depends on.
example: ["f7e6a006-a029-46c3-b0cc-742c9d7d363b", "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe"]
items:
description: A list of job IDs.
type: string
nullable: true
type: array
end:
description: Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.
description: Time when the job run finished. The time format must be RFC3339.
example: "2023-05-31T15:30:00Z"
format: date-time
type: string
error:
$ref: "#/components/schemas/CIAppCIError"
git:
$ref: "#/components/schemas/CIAppGitInfo"
is_manual:
description: Whether or not the pipeline was triggered manually by the user.
example: false
nullable: true
type: boolean
is_resumed:
description: Whether or not the pipeline was resumed after being blocked.
example: false
nullable: true
type: boolean
id:
description: The UUID for the job. It has to be unique within each pipeline execution.
example: c865bad4-de82-44b8-ade7-2c987528eb54
type: string
level:
$ref: "#/components/schemas/CIAppPipelineEventPipelineLevel"
$ref: "#/components/schemas/CIAppPipelineEventJobLevel"
metrics:
$ref: "#/components/schemas/CIAppPipelineEventMetrics"
name:
description: Name of the pipeline. All pipeline runs for the builds should have the same name.
example: Deploy to AWS
description: The name for the job.
example: test
type: string
node:
$ref: "#/components/schemas/CIAppHostInfo"
parameters:
$ref: "#/components/schemas/CIAppPipelineEventParameters"
parent_pipeline:
$ref: "#/components/schemas/CIAppPipelineEventParentPipeline"
partial_retry:
description: |-
Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one
which only runs a subset of the original jobs.
example: false
type: boolean
pipeline_id:
description: |-
Any ID used in the provider to identify the pipeline run even if it is not unique across retries.
If the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.
example: "#023"
pipeline_name:
description: The parent pipeline name.
example: Build
type: string
pipeline_unique_id:
description: The parent pipeline UUID.
example: "76b572af-a078-42b2-a08a-cc28f98b944f"
type: string
previous_attempt:
$ref: "#/components/schemas/CIAppPipelineEventPreviousPipeline"
queue_time:
description: The queue time in milliseconds, if applicable.
example: 1004
format: int64
minimum: 0
nullable: true
type: integer
stage_id:
description: The parent stage UUID (if applicable).
nullable: true
type: string
stage_name:
description: The parent stage name (if applicable).
nullable: true
type: string
start:
description: Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.
description: |-
Time when the job run instance started (it should not include any queue time).
The time format must be RFC3339.
example: "2023-05-31T15:30:00Z"
format: date-time
type: string
status:
$ref: "#/components/schemas/CIAppPipelineEventPipelineStatus"
$ref: "#/components/schemas/CIAppPipelineEventJobStatus"
tags:
$ref: "#/components/schemas/CIAppPipelineEventTags"
unique_id:
description: |-
UUID of the pipeline run. The ID has to be unique across retries and pipelines,
including partial retries.
example: "3eacb6f3-ff04-4e10-8a9c-46e6d054024a"
type: string
url:
description: The URL to look at the pipeline in the CI provider UI.
example: https://my-ci-provider.example/pipelines/my-pipeline/run/1
description: The URL to look at the job in the CI provider UI.
example: https://ci-platform.com/job/your-job-name/build/123
type: string
required:
- level
- unique_id
- id
- name
- url
- pipeline_unique_id
- pipeline_name
- start
- end
- status
- partial_retry
- url
type: object
CIAppPipelineEventInProgressPipeline:
description: Details of a running pipeline.
CIAppPipelineEventFinishedPipeline:
description: Details of a finished pipeline.
properties:
end:
description: Time when the pipeline run finished. It cannot be older than 18 hours in the past from the current time. The time format must be RFC3339.
example: "2023-05-31T15:30:00Z"
format: date-time
type: string
error:
$ref: "#/components/schemas/CIAppCIError"
git:
Expand Down Expand Up @@ -13995,12 +13999,13 @@ components:
format: date-time
type: string
status:
$ref: "#/components/schemas/CIAppPipelineEventPipelineInProgressStatus"
$ref: "#/components/schemas/CIAppPipelineEventPipelineStatus"
tags:
$ref: "#/components/schemas/CIAppPipelineEventTags"
unique_id:
description: |-
UUID of the pipeline run. The ID has to be the same as the finished pipeline.
UUID of the pipeline run. The ID has to be unique across retries and pipelines,
including partial retries.
example: "3eacb6f3-ff04-4e10-8a9c-46e6d054024a"
type: string
url:
Expand All @@ -14013,11 +14018,12 @@ components:
- name
- url
- start
- end
- status
- partial_retry
type: object
CIAppPipelineEventJob:
description: Details of a CI job.
CIAppPipelineEventInProgressJob:
description: Details of a running CI job.
properties:
dependencies:
description: A list of job IDs that this job depends on.
Expand All @@ -14027,17 +14033,12 @@ components:
type: string
nullable: true
type: array
end:
description: Time when the job run finished. The time format must be RFC3339.
example: "2023-05-31T15:30:00Z"
format: date-time
type: string
error:
$ref: "#/components/schemas/CIAppCIError"
git:
$ref: "#/components/schemas/CIAppGitInfo"
id:
description: The UUID for the job. It has to be unique within each pipeline execution.
description: The UUID for the job. It must match the ID of the corresponding finished job.
example: c865bad4-de82-44b8-ade7-2c987528eb54
type: string
level:
Expand Down Expand Up @@ -14076,12 +14077,14 @@ components:
nullable: true
type: string
start:
description: Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.
description: |-
Time when the job run instance started (it should not include any queue time).
The time format must be RFC3339.
example: "2023-05-31T15:30:00Z"
format: date-time
type: string
status:
$ref: "#/components/schemas/CIAppPipelineEventJobStatus"
$ref: "#/components/schemas/CIAppPipelineEventJobInProgressStatus"
tags:
$ref: "#/components/schemas/CIAppPipelineEventTags"
url:
Expand All @@ -14095,10 +14098,99 @@ components:
- pipeline_unique_id
- pipeline_name
- start
- end
- status
- url
type: object
CIAppPipelineEventInProgressPipeline:
description: Details of a running pipeline.
properties:
error:
$ref: "#/components/schemas/CIAppCIError"
git:
$ref: "#/components/schemas/CIAppGitInfo"
is_manual:
description: Whether or not the pipeline was triggered manually by the user.
example: false
nullable: true
type: boolean
is_resumed:
description: Whether or not the pipeline was resumed after being blocked.
example: false
nullable: true
type: boolean
level:
$ref: "#/components/schemas/CIAppPipelineEventPipelineLevel"
metrics:
$ref: "#/components/schemas/CIAppPipelineEventMetrics"
name:
description: Name of the pipeline. All pipeline runs for the builds should have the same name.
example: Deploy to AWS
type: string
node:
$ref: "#/components/schemas/CIAppHostInfo"
parameters:
$ref: "#/components/schemas/CIAppPipelineEventParameters"
parent_pipeline:
$ref: "#/components/schemas/CIAppPipelineEventParentPipeline"
partial_retry:
description: |-
Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one
which only runs a subset of the original jobs.
example: false
type: boolean
pipeline_id:
description: |-
Any ID used in the provider to identify the pipeline run even if it is not unique across retries.
If the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.
example: "#023"
type: string
previous_attempt:
$ref: "#/components/schemas/CIAppPipelineEventPreviousPipeline"
queue_time:
description: The queue time in milliseconds, if applicable.
example: 1004
format: int64
minimum: 0
nullable: true
type: integer
start:
description: Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.
example: "2023-05-31T15:30:00Z"
format: date-time
type: string
status:
$ref: "#/components/schemas/CIAppPipelineEventPipelineInProgressStatus"
tags:
$ref: "#/components/schemas/CIAppPipelineEventTags"
unique_id:
description: |-
UUID of the pipeline run. The ID has to be the same as the finished pipeline.
example: "3eacb6f3-ff04-4e10-8a9c-46e6d054024a"
type: string
url:
description: The URL to look at the pipeline in the CI provider UI.
example: https://my-ci-provider.example/pipelines/my-pipeline/run/1
type: string
required:
- level
- unique_id
- name
- url
- start
- status
- partial_retry
type: object
CIAppPipelineEventJob:
description: Details of a CI job.
oneOf:
- $ref: "#/components/schemas/CIAppPipelineEventFinishedJob"
- $ref: "#/components/schemas/CIAppPipelineEventInProgressJob"
CIAppPipelineEventJobInProgressStatus:
description: The in-progress status of the job.
enum: ["running"]
example: running
type: string
x-enum-varnames: ["RUNNING"]
CIAppPipelineEventJobLevel:
default: job
description: Used to distinguish between pipelines, stages, jobs, and steps.
Expand Down
21 changes: 21 additions & 0 deletions docs/datadog_api_client.v2.model.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6150,13 +6150,27 @@ datadog\_api\_client.v2.model.ci\_app\_pipeline\_event\_attributes module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.ci\_app\_pipeline\_event\_finished\_job module
----------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.ci_app_pipeline_event_finished_job
:members:
:show-inheritance:

datadog\_api\_client.v2.model.ci\_app\_pipeline\_event\_finished\_pipeline module
---------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.ci_app_pipeline_event_finished_pipeline
:members:
:show-inheritance:

datadog\_api\_client.v2.model.ci\_app\_pipeline\_event\_in\_progress\_job module
--------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.ci_app_pipeline_event_in_progress_job
:members:
:show-inheritance:

datadog\_api\_client.v2.model.ci\_app\_pipeline\_event\_in\_progress\_pipeline module
-------------------------------------------------------------------------------------

Expand All @@ -6171,6 +6185,13 @@ datadog\_api\_client.v2.model.ci\_app\_pipeline\_event\_job module
:members:
:show-inheritance:

datadog\_api\_client.v2.model.ci\_app\_pipeline\_event\_job\_in\_progress\_status module
----------------------------------------------------------------------------------------

.. automodule:: datadog_api_client.v2.model.ci_app_pipeline_event_job_in_progress_status
:members:
:show-inheritance:

datadog\_api\_client.v2.model.ci\_app\_pipeline\_event\_job\_level module
-------------------------------------------------------------------------

Expand Down
4 changes: 2 additions & 2 deletions examples/v2/ci-visibility-pipelines/CreateCIAppPipelineEvent_129899466.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@
from datadog_api_client.v2.model.ci_app_create_pipeline_event_request_data_type import (
CIAppCreatePipelineEventRequestDataType,
)
from datadog_api_client.v2.model.ci_app_pipeline_event_job import CIAppPipelineEventJob
from datadog_api_client.v2.model.ci_app_pipeline_event_finished_job import CIAppPipelineEventFinishedJob
from datadog_api_client.v2.model.ci_app_pipeline_event_job_level import CIAppPipelineEventJobLevel
from datadog_api_client.v2.model.ci_app_pipeline_event_job_status import CIAppPipelineEventJobStatus

body = CIAppCreatePipelineEventRequest(
data=CIAppCreatePipelineEventRequestData(
attributes=CIAppCreatePipelineEventRequestAttributes(
resource=CIAppPipelineEventJob(
resource=CIAppPipelineEventFinishedJob(
level=CIAppPipelineEventJobLevel.JOB,
id="cf9456de-8b9e-4c27-aa79-27b1e78c1a33",
name="Build image",
Expand Down
Loading
Loading