fix(3163): Add sort and sortby query params for pipeline list events #3169
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
sagar1312
reviewed
Aug 12, 2024
| @@ -44,7 +44,7 @@ module.exports = () => ({ | |||
| } | |||
|
|
|||
| const eventType = request.query.type || 'pipeline'; | |||
| const config = { params: { type: eventType } }; | |||
| const config = { params: { type: eventType }, sort }; | |||
There was a problem hiding this comment.
What happens when sort is not specified in the request.query?
i.e. when config.sort: undefined
Should we add sort to config only when it is explicitly specified?
There was a problem hiding this comment.
default should be descending
https://github.com/screwdriver-cd/data-schema/blob/master/api/pagination.js#L12
VonnyJap
reviewed
Aug 12, 2024
plugins/pipelines/README.md
Outdated
Comment on lines
118
to
120
| `GET /pipelines/{id}/events?id=gt:{eventId}&count={countNumber}` (greater than eventId) | ||
| `GET /pipelines/{id}/events?id=lt:{eventId}&count={countNumber}` (less than eventId) | ||
| `GET /pipelines/{id}/events?id=lt:{eventId}&count={countNumber}&sort=ascending` (less than eventId) |
There was a problem hiding this comment.
nitpick: put a line break between line 118 and 119.
tkyi
force-pushed
the
fixPipelineEvents
branch
from
dff9168 to
c8253cb
Compare
sagar1312
approved these changes
Aug 12, 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
We need to be able to sort in a different order than descending.
Objective
This PR adds sort and sortBy to pipeline list events endpoint. Also updates joi schema for event ID query param for Swagger.
References
Related to #3163
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.