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
4 changes: 3 additions & 1 deletion platform/api.yml
Original file line number Diff line number Diff line change
Expand Up @@ -734,6 +734,8 @@ paths:
$ref: "./paths/stacks/tasks.yml"

## Stack Builds
"/v1/stacks/builds":
$ref: "./paths/stacks/builds/all-builds.yml"
"/v1/stacks/builds/{buildId}":
$ref: "./paths/stacks/builds/lookup.yml"
"/v1/stacks/{stackId}/builds":
Expand Down Expand Up @@ -805,4 +807,4 @@ webhooks:
schema:
type: array
items:
$ref: ../components/schemas/monitoring/events/Event.yml
$ref: ../components/schemas/monitoring/events/Event.yml
62 changes: 62 additions & 0 deletions platform/paths/stacks/builds/all-builds.yml
Copy link
Member

Choose a reason for hiding this comment

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

needs to be all-builds

Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
get:
operationId: "getAllStackBuilds"
summary: List All Builds
description: |
Fetches all stack builds regardless of their association to a stack.

Requires the `stacks-view` capability.
tags:
- Stack Builds
parameters:
- name: meta
in: query
required: false
description:
A comma separated list of meta values. Meta values will show up under a resource's
`meta` field. In the case of applying a meta to a collection of resources, each
resource will have it's own relevant meta data. In some rare cases, meta may not
apply to individual resources, and may appear in the root document. These will be
clearly labeled.
schema:
type: array
items:
type: string
enum:
- containers_count
- name: filter
in: query
# Deep nested arrays are undefined https://github.com/OAI/OpenAPI-Specification/issues/1706
style: deepObject
required: false
description: |
## Filter Field
The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.
schema:
type: object
properties:
search:
type: string
description: |
`filter[search]=value` search for a value associated with a field on the given Stack Build(s).
state:
type: string
description: |
`filter[state]=value1,value2` state filtering will allow you to filter by the Stack Build's current state.
- $ref: ../../../../components/parameters/SortParam.yml
- $ref: ../../../../components/parameters/PageParam.yml
responses:
200:
description: Returns a list of stack builds.
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: array
items:
$ref: ../../../../components/schemas/stacks/builds/StackBuild.yml
default:
$ref: ../../../../components/responses/errors/DefaultError.yml