[#73887] Add backlog buckets to API#23534
Merged
EinLama merged 12 commits intoJun 10, 2026
Merged
Conversation
EinLama
force-pushed
the
feature/73887-display-backlog-bucket-in-work-package-page
branch
from
a95f465 to
e0bea95
Compare
toy
reviewed
Jun 3, 2026
1 task
EinLama
force-pushed
the
feature/73887-display-backlog-bucket-in-work-package-page
branch
2 times, most recently
from
48f8e65 to
5315e95
Compare
EinLama
force-pushed
the
feature/73887-display-backlog-bucket-in-work-package-page
branch
2 times, most recently
from
3e288ae to
19ca6c9
Compare
EinLama
force-pushed
the
feature/73887-display-backlog-bucket-in-work-package-page
branch
from
19ca6c9 to
318e359
Compare
3 tasks
toy
approved these changes
Jun 9, 2026
| module V3 | ||
| module BacklogBuckets | ||
| class BacklogBucketRepresenter < ::API::Decorators::Single | ||
| include API::Decorators::LinkedResource |
Contributor
There was a problem hiding this comment.
Unrelated to PR - this should be automatically included by API::V3::Workspaces::LinkedResource
allowed_in_project? will return false for nil-projects, so this check is not needed.
… -> Query" This reverts commit 9c93ea8.
Contributor
Author
|
Applied almost all of your suggestions. Will merge once CI is green 🟢 |
toy
reviewed
Jun 10, 2026
…empty project It should not grant all permissions if the project argument is `nil`.
EinLama
force-pushed
the
feature/73887-display-backlog-bucket-in-work-package-page
branch
from
1582732 to
735bba8
Compare
|
Warning Flaky specs
|
EinLama
deleted the
feature/73887-display-backlog-bucket-in-work-package-page
branch
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Ticket
https://community.openproject.org/wp/AGILE-192
What are you trying to accomplish?
Make backlog buckets readable/writable in the work package details view. This also works for a large number of buckets since pagination is set to "no limit" (similar to Sprints).
Establish an API for backlog buckets.
Filtering and grouping is out of scope for this PR.
Screenshots
Known bugs
When you try to assign a Backlog Bucket to a work package that is already assigned to a Sprint: https://community.openproject.org/wp/AGILE-275
The backlog bucket attribute might be missing from the WP details page depending on which user populates the cache. There is a fix for Sprints that can also be applied to Backlog Buckets,
but #23523 has to be merged first.-> Bugfix applied to this PR.What approach did you choose and why?
Most of this work is based on the introduction of Sprints into the API and work package details view (#22328)
As for naming, the API routes are currently called
backlog_bucketinstead of the short formbucket, since the API is different to the regular routing in that it does not offer a namespace for the backlogs module. The API route for buckets is/projects/:id/backlog_buckets. If shortened to/projects/:id/buckets, it might be too ambiguous. On the other hand, this creates an inconsistency. It could be better to use the short form and accept that bucket is a well established term in our code base.The ACs state that the
manage_sprint_itemspermission is necessary to write the backlog_bucket attribute on WorkPackage. This was already established prior to this PR and was tested inmodules/backlogs/spec/contracts/work_packages/shared_contract_examples.rb. There is no explicit feature test for backlog buckets ensuring that the contract is really used for the WP details page.Merge checklist