feat: Add pipelines/id/builds endpoint [2] #3070
Merged
Conversation
This file contains 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
VonnyJap
reviewed
Mar 26, 2024
plugins/pipelines/listBuilds.js
Outdated
Comment on lines
34
to
39
| if (request.query.page || request.query.count) { | ||
| config.paginate = { | ||
| page: request.query.page, | ||
| count: request.query.count | ||
| }; | ||
| } |
There was a problem hiding this comment.
Can we have a default config.paginate in the case that client never specifically mention about pagination? This is related to my comment on the models PR.
There was a problem hiding this comment.
put the default paginate in models
VonnyJap
reviewed
Mar 29, 2024
plugins/pipelines/README.md
Outdated
| @@ -107,10 +107,10 @@ Only PR events of specified PR number will be searched when `prNum` is set | |||
| `GET /pipelines/{id}/events?page={pageNumber}&count={countNumber}&sort={sort}&prNum={prNumber}` | |||
|
|
|||
| #### Get all pipeline builds | |||
| `page`, `count`, `sort`, `latest`, and `groupEventId` are optional | |||
| `page`, `count`, `sort`, `latest`, `sortBy`, `fetchSteps`, `readOnly`, and `groupEventId` are optional | |||
| When `latest=true` and `groupEventId` is set, only latest builds in a pipeline based on groupEventId will be returned. `latest` and `groupEventId` must be set together | |||
There was a problem hiding this comment.
Suggested change
| When `latest=true` and `groupEventId` is set, only latest builds in a pipeline based on groupEventId will be returned. `latest` and `groupEventId` must be set together | |
| When `latest=true` and `groupEventId` is set, only latest builds in a pipeline based on groupEventId will be returned. The `latest` parameter must be used in conjunction with the `groupEventId`. |
| When `latest=true` and `groupEventId` is set, only latest builds in a pipeline based on groupEventId will be returned. `latest` and `groupEventId` must be set together | ||
|
|
||
| `GET /pipelines/{id}/builds?page={pageNumber}&count={countNumber}&sort={sort}&latest=true&groupEventId={groupEventId}` | ||
| `GET /pipelines/{id}/builds?page={pageNumber}&count={countNumber}&sort={sort}&latest=true&groupEventId={groupEventId}&sortBy={sortBy}&fetchSteps=false&readOnly=false` |
There was a problem hiding this comment.
fetchSteps=false will omit steps in the build response? This might be param that we can use to filter out the steps field in the build response.
VonnyJap
previously approved these changes
Mar 29, 2024
VonnyJap
approved these changes
Apr 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Context
Currently a lot of calls are being made on the PR tab page in the UI to:
GET /pipelines/:id/events?count=1&page=1&prNum=prNumGET /jobs/:id/builds?count=10&page=1GET /events/:id/buildsIt would be nice if we could simplify these calls to get only latest builds in a PR and make fewer calls to the API.
Objective
This PR adds an endpoint
GET /pipelines/:id/builds?groupEventId=id&latest=trueto get latest builds for a pipeline based ongroupEventId.References
Blocked by: screwdriver-cd/models#619
License
I confirm that this contribution is made under a BSD license and that I have the authority necessary to make this contribution on behalf of its copyright owner.