@@ -13954,95 +13954,99 @@ components:
1395413954 tags:
1395513955 $ref: "#/components/schemas/TagsEventAttribute"
1395613956 type: object
13957- CIAppPipelineEventFinishedPipeline :
13958- description: Details of a finished pipeline .
13957+ CIAppPipelineEventFinishedJob :
13958+ description: Details of a finished CI job .
1395913959 properties:
13960+ dependencies:
13961+ description: A list of job IDs that this job depends on.
13962+ example: ["f7e6a006-a029-46c3-b0cc-742c9d7d363b", "c8a69849-3c3b-4721-8b33-3e8ec2df1ebe"]
13963+ items:
13964+ description: A list of job IDs.
13965+ type: string
13966+ nullable: true
13967+ type: array
1396013968 end:
13961- 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.
13969+ description: Time when the job run finished. The time format must be RFC3339.
1396213970 example: "2023-05-31T15:30:00Z"
1396313971 format: date-time
1396413972 type: string
1396513973 error:
1396613974 $ref: "#/components/schemas/CIAppCIError"
1396713975 git:
1396813976 $ref: "#/components/schemas/CIAppGitInfo"
13969- is_manual:
13970- description: Whether or not the pipeline was triggered manually by the user.
13971- example: false
13972- nullable: true
13973- type: boolean
13974- is_resumed:
13975- description: Whether or not the pipeline was resumed after being blocked.
13976- example: false
13977- nullable: true
13978- type: boolean
13977+ id:
13978+ description: The UUID for the job. It has to be unique within each pipeline execution.
13979+ example: c865bad4-de82-44b8-ade7-2c987528eb54
13980+ type: string
1397913981 level:
13980- $ref: "#/components/schemas/CIAppPipelineEventPipelineLevel "
13982+ $ref: "#/components/schemas/CIAppPipelineEventJobLevel "
1398113983 metrics:
1398213984 $ref: "#/components/schemas/CIAppPipelineEventMetrics"
1398313985 name:
13984- description: Name of the pipeline. All pipeline runs for the builds should have the same name .
13985- example: Deploy to AWS
13986+ description: The name for the job .
13987+ example: test
1398613988 type: string
1398713989 node:
1398813990 $ref: "#/components/schemas/CIAppHostInfo"
1398913991 parameters:
1399013992 $ref: "#/components/schemas/CIAppPipelineEventParameters"
13991- parent_pipeline:
13992- $ref: "#/components/schemas/CIAppPipelineEventParentPipeline"
13993- partial_retry:
13994- description: |-
13995- Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one
13996- which only runs a subset of the original jobs.
13997- example: false
13998- type: boolean
13999- pipeline_id:
14000- description: |-
14001- Any ID used in the provider to identify the pipeline run even if it is not unique across retries.
14002- If the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.
14003- example: "#023"
13993+ pipeline_name:
13994+ description: The parent pipeline name.
13995+ example: Build
13996+ type: string
13997+ pipeline_unique_id:
13998+ description: The parent pipeline UUID.
13999+ example: "76b572af-a078-42b2-a08a-cc28f98b944f"
1400414000 type: string
14005- previous_attempt:
14006- $ref: "#/components/schemas/CIAppPipelineEventPreviousPipeline"
1400714001 queue_time:
1400814002 description: The queue time in milliseconds, if applicable.
1400914003 example: 1004
1401014004 format: int64
1401114005 minimum: 0
1401214006 nullable: true
1401314007 type: integer
14008+ stage_id:
14009+ description: The parent stage UUID (if applicable).
14010+ nullable: true
14011+ type: string
14012+ stage_name:
14013+ description: The parent stage name (if applicable).
14014+ nullable: true
14015+ type: string
1401414016 start:
14015- description: Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.
14017+ description: |-
14018+ Time when the job run instance started (it should not include any queue time).
14019+ The time format must be RFC3339.
1401614020 example: "2023-05-31T15:30:00Z"
1401714021 format: date-time
1401814022 type: string
1401914023 status:
14020- $ref: "#/components/schemas/CIAppPipelineEventPipelineStatus "
14024+ $ref: "#/components/schemas/CIAppPipelineEventJobStatus "
1402114025 tags:
1402214026 $ref: "#/components/schemas/CIAppPipelineEventTags"
14023- unique_id:
14024- description: |-
14025- UUID of the pipeline run. The ID has to be unique across retries and pipelines,
14026- including partial retries.
14027- example: "3eacb6f3-ff04-4e10-8a9c-46e6d054024a"
14028- type: string
1402914027 url:
14030- description: The URL to look at the pipeline in the CI provider UI.
14031- example: https://my- ci-provider.example/pipelines/my-pipeline/run/1
14028+ description: The URL to look at the job in the CI provider UI.
14029+ example: https://ci-platform.com/job/your-job-name/build/123
1403214030 type: string
1403314031 required:
1403414032 - level
14035- - unique_id
14033+ - id
1403614034 - name
14037- - url
14035+ - pipeline_unique_id
14036+ - pipeline_name
1403814037 - start
1403914038 - end
1404014039 - status
14041- - partial_retry
14040+ - url
1404214041 type: object
14043- CIAppPipelineEventInProgressPipeline :
14044- description: Details of a running pipeline.
14042+ CIAppPipelineEventFinishedPipeline :
14043+ description: Details of a finished pipeline.
1404514044 properties:
14045+ end:
14046+ 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.
14047+ example: "2023-05-31T15:30:00Z"
14048+ format: date-time
14049+ type: string
1404614050 error:
1404714051 $ref: "#/components/schemas/CIAppCIError"
1404814052 git:
@@ -14098,12 +14102,13 @@ components:
1409814102 format: date-time
1409914103 type: string
1410014104 status:
14101- $ref: "#/components/schemas/CIAppPipelineEventPipelineInProgressStatus "
14105+ $ref: "#/components/schemas/CIAppPipelineEventPipelineStatus "
1410214106 tags:
1410314107 $ref: "#/components/schemas/CIAppPipelineEventTags"
1410414108 unique_id:
1410514109 description: |-
14106- UUID of the pipeline run. The ID has to be the same as the finished pipeline.
14110+ UUID of the pipeline run. The ID has to be unique across retries and pipelines,
14111+ including partial retries.
1410714112 example: "3eacb6f3-ff04-4e10-8a9c-46e6d054024a"
1410814113 type: string
1410914114 url:
@@ -14116,11 +14121,12 @@ components:
1411614121 - name
1411714122 - url
1411814123 - start
14124+ - end
1411914125 - status
1412014126 - partial_retry
1412114127 type: object
14122- CIAppPipelineEventJob :
14123- description: Details of a CI job.
14128+ CIAppPipelineEventInProgressJob :
14129+ description: Details of a running CI job.
1412414130 properties:
1412514131 dependencies:
1412614132 description: A list of job IDs that this job depends on.
@@ -14130,17 +14136,12 @@ components:
1413014136 type: string
1413114137 nullable: true
1413214138 type: array
14133- end:
14134- description: Time when the job run finished. The time format must be RFC3339.
14135- example: "2023-05-31T15:30:00Z"
14136- format: date-time
14137- type: string
1413814139 error:
1413914140 $ref: "#/components/schemas/CIAppCIError"
1414014141 git:
1414114142 $ref: "#/components/schemas/CIAppGitInfo"
1414214143 id:
14143- description: The UUID for the job. It has to be unique within each pipeline execution .
14144+ description: The UUID for the job. It must match the ID of the corresponding finished job .
1414414145 example: c865bad4-de82-44b8-ade7-2c987528eb54
1414514146 type: string
1414614147 level:
@@ -14179,12 +14180,14 @@ components:
1417914180 nullable: true
1418014181 type: string
1418114182 start:
14182- description: Time when the job run instance started (it should not include any queue time). The time format must be RFC3339.
14183+ description: |-
14184+ Time when the job run instance started (it should not include any queue time).
14185+ The time format must be RFC3339.
1418314186 example: "2023-05-31T15:30:00Z"
1418414187 format: date-time
1418514188 type: string
1418614189 status:
14187- $ref: "#/components/schemas/CIAppPipelineEventJobStatus "
14190+ $ref: "#/components/schemas/CIAppPipelineEventJobInProgressStatus "
1418814191 tags:
1418914192 $ref: "#/components/schemas/CIAppPipelineEventTags"
1419014193 url:
@@ -14198,10 +14201,99 @@ components:
1419814201 - pipeline_unique_id
1419914202 - pipeline_name
1420014203 - start
14201- - end
1420214204 - status
1420314205 - url
1420414206 type: object
14207+ CIAppPipelineEventInProgressPipeline:
14208+ description: Details of a running pipeline.
14209+ properties:
14210+ error:
14211+ $ref: "#/components/schemas/CIAppCIError"
14212+ git:
14213+ $ref: "#/components/schemas/CIAppGitInfo"
14214+ is_manual:
14215+ description: Whether or not the pipeline was triggered manually by the user.
14216+ example: false
14217+ nullable: true
14218+ type: boolean
14219+ is_resumed:
14220+ description: Whether or not the pipeline was resumed after being blocked.
14221+ example: false
14222+ nullable: true
14223+ type: boolean
14224+ level:
14225+ $ref: "#/components/schemas/CIAppPipelineEventPipelineLevel"
14226+ metrics:
14227+ $ref: "#/components/schemas/CIAppPipelineEventMetrics"
14228+ name:
14229+ description: Name of the pipeline. All pipeline runs for the builds should have the same name.
14230+ example: Deploy to AWS
14231+ type: string
14232+ node:
14233+ $ref: "#/components/schemas/CIAppHostInfo"
14234+ parameters:
14235+ $ref: "#/components/schemas/CIAppPipelineEventParameters"
14236+ parent_pipeline:
14237+ $ref: "#/components/schemas/CIAppPipelineEventParentPipeline"
14238+ partial_retry:
14239+ description: |-
14240+ Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one
14241+ which only runs a subset of the original jobs.
14242+ example: false
14243+ type: boolean
14244+ pipeline_id:
14245+ description: |-
14246+ Any ID used in the provider to identify the pipeline run even if it is not unique across retries.
14247+ If the `pipeline_id` is unique, then both `unique_id` and `pipeline_id` can be set to the same value.
14248+ example: "#023"
14249+ type: string
14250+ previous_attempt:
14251+ $ref: "#/components/schemas/CIAppPipelineEventPreviousPipeline"
14252+ queue_time:
14253+ description: The queue time in milliseconds, if applicable.
14254+ example: 1004
14255+ format: int64
14256+ minimum: 0
14257+ nullable: true
14258+ type: integer
14259+ start:
14260+ description: Time when the pipeline run started (it should not include any queue time). The time format must be RFC3339.
14261+ example: "2023-05-31T15:30:00Z"
14262+ format: date-time
14263+ type: string
14264+ status:
14265+ $ref: "#/components/schemas/CIAppPipelineEventPipelineInProgressStatus"
14266+ tags:
14267+ $ref: "#/components/schemas/CIAppPipelineEventTags"
14268+ unique_id:
14269+ description: |-
14270+ UUID of the pipeline run. The ID has to be the same as the finished pipeline.
14271+ example: "3eacb6f3-ff04-4e10-8a9c-46e6d054024a"
14272+ type: string
14273+ url:
14274+ description: The URL to look at the pipeline in the CI provider UI.
14275+ example: https://my-ci-provider.example/pipelines/my-pipeline/run/1
14276+ type: string
14277+ required:
14278+ - level
14279+ - unique_id
14280+ - name
14281+ - url
14282+ - start
14283+ - status
14284+ - partial_retry
14285+ type: object
14286+ CIAppPipelineEventJob:
14287+ description: Details of a CI job.
14288+ oneOf:
14289+ - $ref: "#/components/schemas/CIAppPipelineEventFinishedJob"
14290+ - $ref: "#/components/schemas/CIAppPipelineEventInProgressJob"
14291+ CIAppPipelineEventJobInProgressStatus:
14292+ description: The in-progress status of the job.
14293+ enum: ["running"]
14294+ example: running
14295+ type: string
14296+ x-enum-varnames: ["RUNNING"]
1420514297 CIAppPipelineEventJobLevel:
1420614298 default: job
1420714299 description: Used to distinguish between pipelines, stages, jobs, and steps.
0 commit comments