From b2a4770c7830bc068ce5621b38cfd636ae05adb0 Mon Sep 17 00:00:00 2001 From: Bryce Date: Fri, 9 Jan 2026 09:06:07 -0800 Subject: [PATCH 1/2] all pipeline runs --- .../schemas/includes/IncludedPipelines.yml | 5 ++ .../schemas/includes/IncludedTriggerKeys.yml | 5 ++ .../pipelines/runs/PipelineRunIncludes.yml | 10 ++++ platform/api.yml | 2 + platform/paths/pipelines/all-runs.yml | 47 +++++++++++++++++++ 5 files changed, 69 insertions(+) create mode 100644 components/schemas/includes/IncludedPipelines.yml create mode 100644 components/schemas/includes/IncludedTriggerKeys.yml create mode 100644 components/schemas/pipelines/runs/PipelineRunIncludes.yml create mode 100644 platform/paths/pipelines/all-runs.yml diff --git a/components/schemas/includes/IncludedPipelines.yml b/components/schemas/includes/IncludedPipelines.yml new file mode 100644 index 00000000..74f187b0 --- /dev/null +++ b/components/schemas/includes/IncludedPipelines.yml @@ -0,0 +1,5 @@ +title: IncludedPipelines +description: A pipeline map provided when requested via includes. +type: object +additionalProperties: + $ref: ../pipelines/Pipeline.yml diff --git a/components/schemas/includes/IncludedTriggerKeys.yml b/components/schemas/includes/IncludedTriggerKeys.yml new file mode 100644 index 00000000..ad8b6f77 --- /dev/null +++ b/components/schemas/includes/IncludedTriggerKeys.yml @@ -0,0 +1,5 @@ +title: IncludedTriggerKeys +description: A trigger key map provided when requested via includes. +type: object +additionalProperties: + $ref: ../pipelines/trigger-keys/TriggerKey.yml diff --git a/components/schemas/pipelines/runs/PipelineRunIncludes.yml b/components/schemas/pipelines/runs/PipelineRunIncludes.yml new file mode 100644 index 00000000..3c28b768 --- /dev/null +++ b/components/schemas/pipelines/runs/PipelineRunIncludes.yml @@ -0,0 +1,10 @@ +title: PipelineRunIncludes +description: All includable resources linkable to the given pipeline run. +type: object +properties: + creators: + $ref: ../../../../components/schemas/includes/CreatorInclude.yml + pipelines: + $ref: ../../../../components/schemas/includes/IncludedPipelines.yml + keys: + $ref: ../../../../components/schemas/includes/IncludedTriggerKeys.yml diff --git a/platform/api.yml b/platform/api.yml index edc9d82b..45b7207c 100644 --- a/platform/api.yml +++ b/platform/api.yml @@ -692,6 +692,8 @@ paths: $ref: "./paths/pipelines/pipeline.yml" "/v1/pipelines/{pipelineId}/access": $ref: "./paths/pipelines/access.yml" + "/v1/pipelines/runs": + $ref: "./paths/pipelines/all-runs.yml" "/v1/pipelines/{pipelineId}/runs": $ref: "./paths/pipelines/runs.yml" "/v1/pipelines/{pipelineId}/runs/{runId}": diff --git a/platform/paths/pipelines/all-runs.yml b/platform/paths/pipelines/all-runs.yml new file mode 100644 index 00000000..2c419257 --- /dev/null +++ b/platform/paths/pipelines/all-runs.yml @@ -0,0 +1,47 @@ +get: + operationId: "getAllPipelineRuns" + summary: List All Pipeline Runs + description: | + Lists all pipeline runs, regardless of the pipeline they are associated with. + + Requires the `pipelines-view` capability. + tags: + - Pipelines + parameters: + - $ref: ../../../components/parameters/PageParam.yml + - $ref: ../../../components/parameters/SortParam.yml + - name: include + in: query + required: false + description: + A comma separated list of include values. Included resources will show + up under the root document's `include` field, with the key being the id of the included + resource. In the case of applying an include to a collection of resources, if two + resources share the same include, it will only appear once in the return. + schema: + type: array + items: + type: string + enum: + - creators + - keys + - pipelines + responses: + 200: + description: Returns a list of Pipeline runs. + content: + application/json: + schema: + type: object + required: + - data + properties: + data: + type: array + items: + $ref: ../../../components/schemas/pipelines/runs/PipelineRun.yml + includes: + $ref: ../../../components/schemas/pipelines/runs/PipelineRunIncludes.yml + + default: + $ref: ../../../components/responses/errors/DefaultError.yml From 46023a18b09a31b36a7bf4e86f1eeb2186e7af01 Mon Sep 17 00:00:00 2001 From: Bryce Date: Fri, 9 Jan 2026 09:25:08 -0800 Subject: [PATCH 2/2] comments --- components/schemas/includes/IncludedPipelines.yml | 3 ++- components/schemas/includes/IncludedTriggerKeys.yml | 3 ++- components/schemas/pipelines/runs/PipelineRunIncludes.yml | 2 +- platform/paths/pipelines/all-runs.yml | 2 +- platform/paths/pipelines/runs.yml | 2 +- 5 files changed, 7 insertions(+), 5 deletions(-) diff --git a/components/schemas/includes/IncludedPipelines.yml b/components/schemas/includes/IncludedPipelines.yml index 74f187b0..c7dc7c39 100644 --- a/components/schemas/includes/IncludedPipelines.yml +++ b/components/schemas/includes/IncludedPipelines.yml @@ -1,5 +1,6 @@ title: IncludedPipelines -description: A pipeline map provided when requested via includes. +description: | + A map of pipelines, keyed by ID, included on endpoints that support it when passing the matching includes query parameter. type: object additionalProperties: $ref: ../pipelines/Pipeline.yml diff --git a/components/schemas/includes/IncludedTriggerKeys.yml b/components/schemas/includes/IncludedTriggerKeys.yml index ad8b6f77..c53078af 100644 --- a/components/schemas/includes/IncludedTriggerKeys.yml +++ b/components/schemas/includes/IncludedTriggerKeys.yml @@ -1,5 +1,6 @@ title: IncludedTriggerKeys -description: A trigger key map provided when requested via includes. +description: | + A map of trigger keys, keyed by ID, included on endpoints that support it when passing the matching includes query parameter. type: object additionalProperties: $ref: ../pipelines/trigger-keys/TriggerKey.yml diff --git a/components/schemas/pipelines/runs/PipelineRunIncludes.yml b/components/schemas/pipelines/runs/PipelineRunIncludes.yml index 3c28b768..2e104a0e 100644 --- a/components/schemas/pipelines/runs/PipelineRunIncludes.yml +++ b/components/schemas/pipelines/runs/PipelineRunIncludes.yml @@ -1,5 +1,5 @@ title: PipelineRunIncludes -description: All includable resources linkable to the given pipeline run. +description: Resources related to a pipeline run, that can be included on supported endpoints when the matching includes query parameter is passed. type: object properties: creators: diff --git a/platform/paths/pipelines/all-runs.yml b/platform/paths/pipelines/all-runs.yml index 2c419257..2f9a2a37 100644 --- a/platform/paths/pipelines/all-runs.yml +++ b/platform/paths/pipelines/all-runs.yml @@ -28,7 +28,7 @@ get: - pipelines responses: 200: - description: Returns a list of Pipeline runs. + description: Returns a list of pipeline runs. content: application/json: schema: diff --git a/platform/paths/pipelines/runs.yml b/platform/paths/pipelines/runs.yml index 1541fda2..3d4b255e 100644 --- a/platform/paths/pipelines/runs.yml +++ b/platform/paths/pipelines/runs.yml @@ -31,7 +31,7 @@ get: - creators responses: 200: - description: Returns a list of Pipeline runs. + description: Returns a list of pipeline runs. content: application/json: schema: