Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions components/schemas/includes/IncludedPipelines.yml
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume this will all be moved in bulk to common/includes when you start on that work, yeah?

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
title: IncludedPipelines
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
6 changes: 6 additions & 0 deletions components/schemas/includes/IncludedTriggerKeys.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
title: IncludedTriggerKeys
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
10 changes: 10 additions & 0 deletions components/schemas/pipelines/runs/PipelineRunIncludes.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
title: PipelineRunIncludes
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:
$ref: ../../../../components/schemas/includes/CreatorInclude.yml
pipelines:
$ref: ../../../../components/schemas/includes/IncludedPipelines.yml
keys:
$ref: ../../../../components/schemas/includes/IncludedTriggerKeys.yml
2 changes: 2 additions & 0 deletions platform/api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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}":
Expand Down
47 changes: 47 additions & 0 deletions platform/paths/pipelines/all-runs.yml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion platform/paths/pipelines/runs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down