-
Notifications
You must be signed in to change notification settings - Fork 1
Add "getAllBuilds" endpoint #781
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+65
−1
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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