@@ -13940,95 +13940,99 @@ components:
1394013940 tags:
1394113941 $ref: "#/components/schemas/TagsEventAttribute"
1394213942 type: object
13943- CIAppPipelineEventFinishedPipeline :
13944- description: Details of a finished pipeline .
13943+ CIAppPipelineEventFinishedJob :
13944+ description: Details of a finished CI job .
1394513945 properties:
13946+ dependencies:
13947+ description: A list of job IDs that this job depends on.
13948+ example: ["f7e6a006-a029-46c3-b0cc-742c9d7d363b", "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe"]
13949+ items:
13950+ description: A list of job IDs.
13951+ type: string
13952+ nullable: true
13953+ type: array
1394613954 end:
13947- 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.
13955+ description: Time when the job run finished. The time format must be RFC3339.
1394813956 example: "2023-05-31T15:30:00Z"
1394913957 format: date-time
1395013958 type: string
1395113959 error:
1395213960 $ref: "#/components/schemas/CIAppCIError"
1395313961 git:
1395413962 $ref: "#/components/schemas/CIAppGitInfo"
13955- is_manual:
13956- description: Whether or not the pipeline was triggered manually by the user.
13957- example: false
13958- nullable: true
13959- type: boolean
13960- is_resumed:
13961- description: Whether or not the pipeline was resumed after being blocked.
13962- example: false
13963- nullable: true
13964- type: boolean
13963+ id:
13964+ description: The UUID for the job. It has to be unique within each pipeline execution.
13965+ example: c865bad4-de82-44b8-ade7-2c987528eb54
13966+ type: string
1396513967 level:
13966- $ref: "#/components/schemas/CIAppPipelineEventPipelineLevel "
13968+ $ref: "#/components/schemas/CIAppPipelineEventJobLevel "
1396713969 metrics:
1396813970 $ref: "#/components/schemas/CIAppPipelineEventMetrics"
1396913971 name:
13970- description: Name of the pipeline. All pipeline runs for the builds should have the same name .
13971- example: Deploy to AWS
13972+ description: The name for the job .
13973+ example: test
1397213974 type: string
1397313975 node:
1397413976 $ref: "#/components/schemas/CIAppHostInfo"
1397513977 parameters:
1397613978 $ref: "#/components/schemas/CIAppPipelineEventParameters"
13977- parent_pipeline:
13978- $ref: "#/components/schemas/CIAppPipelineEventParentPipeline"
13979- partial_retry:
13980- description: |-
13981- Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one
13982- which only runs a subset of the original jobs.
13983- example: false
13984- type: boolean
13985- pipeline_id:
13986- description: |-
13987- Any ID used in the provider to identify the pipeline run even if it is not unique across retries.
13988- If the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.
13989- example: "#023"
13979+ pipeline_name:
13980+ description: The parent pipeline name.
13981+ example: Build
13982+ type: string
13983+ pipeline_unique_id:
13984+ description: The parent pipeline UUID.
13985+ example: "76b572af-a078-42b2-a08a-cc28f98b944f"
1399013986 type: string
13991- previous_attempt:
13992- $ref: "#/components/schemas/CIAppPipelineEventPreviousPipeline"
1399313987 queue_time:
1399413988 description: The queue time in milliseconds, if applicable.
1399513989 example: 1004
1399613990 format: int64
1399713991 minimum: 0
1399813992 nullable: true
1399913993 type: integer
13994+ stage_id:
13995+ description: The parent stage UUID (if applicable).
13996+ nullable: true
13997+ type: string
13998+ stage_name:
13999+ description: The parent stage name (if applicable).
14000+ nullable: true
14001+ type: string
1400014002 start:
14001- description: Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.
14003+ description: |-
14004+ Time when the job run instance started (it should not include any queue time).
14005+ The time format must be RFC3339.
1400214006 example: "2023-05-31T15:30:00Z"
1400314007 format: date-time
1400414008 type: string
1400514009 status:
14006- $ref: "#/components/schemas/CIAppPipelineEventPipelineStatus "
14010+ $ref: "#/components/schemas/CIAppPipelineEventJobStatus "
1400714011 tags:
1400814012 $ref: "#/components/schemas/CIAppPipelineEventTags"
14009- unique_id:
14010- description: |-
14011- UUID of the pipeline run. The ID has to be unique across retries and pipelines,
14012- including partial retries.
14013- example: "3eacb6f3-ff04-4e10-8a9c-46e6d054024a"
14014- type: string
1401514013 url:
14016- description: The URL to look at the pipeline in the CI provider UI.
14017- example: https://my- ci-provider.example/pipelines/my-pipeline/run/1
14014+ description: The URL to look at the job in the CI provider UI.
14015+ example: https://ci-platform.com/job/your-job-name/build/123
1401814016 type: string
1401914017 required:
1402014018 - level
14021- - unique_id
14019+ - id
1402214020 - name
14023- - url
14021+ - pipeline_unique_id
14022+ - pipeline_name
1402414023 - start
1402514024 - end
1402614025 - status
14027- - partial_retry
14026+ - url
1402814027 type: object
14029- CIAppPipelineEventInProgressPipeline :
14030- description: Details of a running pipeline.
14028+ CIAppPipelineEventFinishedPipeline :
14029+ description: Details of a finished pipeline.
1403114030 properties:
14031+ end:
14032+ 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.
14033+ example: "2023-05-31T15:30:00Z"
14034+ format: date-time
14035+ type: string
1403214036 error:
1403314037 $ref: "#/components/schemas/CIAppCIError"
1403414038 git:
@@ -14084,12 +14088,13 @@ components:
1408414088 format: date-time
1408514089 type: string
1408614090 status:
14087- $ref: "#/components/schemas/CIAppPipelineEventPipelineInProgressStatus "
14091+ $ref: "#/components/schemas/CIAppPipelineEventPipelineStatus "
1408814092 tags:
1408914093 $ref: "#/components/schemas/CIAppPipelineEventTags"
1409014094 unique_id:
1409114095 description: |-
14092- UUID of the pipeline run. The ID has to be the same as the finished pipeline.
14096+ UUID of the pipeline run. The ID has to be unique across retries and pipelines,
14097+ including partial retries.
1409314098 example: "3eacb6f3-ff04-4e10-8a9c-46e6d054024a"
1409414099 type: string
1409514100 url:
@@ -14102,11 +14107,12 @@ components:
1410214107 - name
1410314108 - url
1410414109 - start
14110+ - end
1410514111 - status
1410614112 - partial_retry
1410714113 type: object
14108- CIAppPipelineEventJob :
14109- description: Details of a CI job.
14114+ CIAppPipelineEventInProgressJob :
14115+ description: Details of a running CI job.
1411014116 properties:
1411114117 dependencies:
1411214118 description: A list of job IDs that this job depends on.
@@ -14116,17 +14122,12 @@ components:
1411614122 type: string
1411714123 nullable: true
1411814124 type: array
14119- end:
14120- description: Time when the job run finished. The time format must be RFC3339.
14121- example: "2023-05-31T15:30:00Z"
14122- format: date-time
14123- type: string
1412414125 error:
1412514126 $ref: "#/components/schemas/CIAppCIError"
1412614127 git:
1412714128 $ref: "#/components/schemas/CIAppGitInfo"
1412814129 id:
14129- description: The UUID for the job. It has to be unique within each pipeline execution .
14130+ description: The UUID for the job. It must match the ID of the corresponding finished job .
1413014131 example: c865bad4-de82-44b8-ade7-2c987528eb54
1413114132 type: string
1413214133 level:
@@ -14165,12 +14166,14 @@ components:
1416514166 nullable: true
1416614167 type: string
1416714168 start:
14168- description: Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.
14169+ description: |-
14170+ Time when the job run instance started (it should not include any queue time).
14171+ The time format must be RFC3339.
1416914172 example: "2023-05-31T15:30:00Z"
1417014173 format: date-time
1417114174 type: string
1417214175 status:
14173- $ref: "#/components/schemas/CIAppPipelineEventJobStatus "
14176+ $ref: "#/components/schemas/CIAppPipelineEventJobInProgressStatus "
1417414177 tags:
1417514178 $ref: "#/components/schemas/CIAppPipelineEventTags"
1417614179 url:
@@ -14184,10 +14187,99 @@ components:
1418414187 - pipeline_unique_id
1418514188 - pipeline_name
1418614189 - start
14187- - end
1418814190 - status
1418914191 - url
1419014192 type: object
14193+ CIAppPipelineEventInProgressPipeline:
14194+ description: Details of a running pipeline.
14195+ properties:
14196+ error:
14197+ $ref: "#/components/schemas/CIAppCIError"
14198+ git:
14199+ $ref: "#/components/schemas/CIAppGitInfo"
14200+ is_manual:
14201+ description: Whether or not the pipeline was triggered manually by the user.
14202+ example: false
14203+ nullable: true
14204+ type: boolean
14205+ is_resumed:
14206+ description: Whether or not the pipeline was resumed after being blocked.
14207+ example: false
14208+ nullable: true
14209+ type: boolean
14210+ level:
14211+ $ref: "#/components/schemas/CIAppPipelineEventPipelineLevel"
14212+ metrics:
14213+ $ref: "#/components/schemas/CIAppPipelineEventMetrics"
14214+ name:
14215+ description: Name of the pipeline. All pipeline runs for the builds should have the same name.
14216+ example: Deploy to AWS
14217+ type: string
14218+ node:
14219+ $ref: "#/components/schemas/CIAppHostInfo"
14220+ parameters:
14221+ $ref: "#/components/schemas/CIAppPipelineEventParameters"
14222+ parent_pipeline:
14223+ $ref: "#/components/schemas/CIAppPipelineEventParentPipeline"
14224+ partial_retry:
14225+ description: |-
14226+ Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one
14227+ which only runs a subset of the original jobs.
14228+ example: false
14229+ type: boolean
14230+ pipeline_id:
14231+ description: |-
14232+ Any ID used in the provider to identify the pipeline run even if it is not unique across retries.
14233+ If the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.
14234+ example: "#023"
14235+ type: string
14236+ previous_attempt:
14237+ $ref: "#/components/schemas/CIAppPipelineEventPreviousPipeline"
14238+ queue_time:
14239+ description: The queue time in milliseconds, if applicable.
14240+ example: 1004
14241+ format: int64
14242+ minimum: 0
14243+ nullable: true
14244+ type: integer
14245+ start:
14246+ description: Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.
14247+ example: "2023-05-31T15:30:00Z"
14248+ format: date-time
14249+ type: string
14250+ status:
14251+ $ref: "#/components/schemas/CIAppPipelineEventPipelineInProgressStatus"
14252+ tags:
14253+ $ref: "#/components/schemas/CIAppPipelineEventTags"
14254+ unique_id:
14255+ description: |-
14256+ UUID of the pipeline run. The ID has to be the same as the finished pipeline.
14257+ example: "3eacb6f3-ff04-4e10-8a9c-46e6d054024a"
14258+ type: string
14259+ url:
14260+ description: The URL to look at the pipeline in the CI provider UI.
14261+ example: https://my-ci-provider.example/pipelines/my-pipeline/run/1
14262+ type: string
14263+ required:
14264+ - level
14265+ - unique_id
14266+ - name
14267+ - url
14268+ - start
14269+ - status
14270+ - partial_retry
14271+ type: object
14272+ CIAppPipelineEventJob:
14273+ description: Details of a CI job.
14274+ oneOf:
14275+ - $ref: "#/components/schemas/CIAppPipelineEventFinishedJob"
14276+ - $ref: "#/components/schemas/CIAppPipelineEventInProgressJob"
14277+ CIAppPipelineEventJobInProgressStatus:
14278+ description: The in-progress status of the job.
14279+ enum: ["running"]
14280+ example: running
14281+ type: string
14282+ x-enum-varnames: ["RUNNING"]
1419114283 CIAppPipelineEventJobLevel:
1419214284 default: job
1419314285 description: Used to distinguish between pipelines, stages, jobs, and steps.
0 commit comments