Skip to content
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

fix(3163): Update list pipeline events ID schema description for Swagger [skip ci] #3165

Closed
wants to merge 2 commits into from
Closed
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
1 change: 1 addition & 0 deletions plugins/pipelines/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@ Query Params:
`GET /pipelines/{id}/events?page={pageNumber}&count={countNumber}&sort={sort}&type={type}&prNum={prNumber}&sha={sha}`

`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 all pipeline builds
Expand Down
2 changes: 1 addition & 1 deletion plugins/pipelines/listEvents.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ const INEQUALITY_SIGNS = /^(gt|lt):([\d]+)$/;
const queryIdSchema = joi
.alternatives()
.try(pipelineIdSchema, joi.string().regex(INEQUALITY_SIGNS))
.label('Query ID schema')
.description('Event ID; alternatively can use greater than(gt:) or less than(lt:) prefix')
.example('gt:12345');

module.exports = () => ({
Expand Down