fix(API): branching: align operations with the backend behavior#1136
Merged
Sven Dunemann (forelabs) merged 2 commits intoMay 20, 2026
Merged
Conversation
Aligns the Branches operations and branch schema with the actual behavior of Api::V2::BranchesController: - Add 401, 403, 422, and 409 responses where reachable across all Branches endpoints; 403 descriptions note the specific conditions (OAuth scope, Pundit, restrict_feature!(:branching)) - Document asynchronous semantics for create, merge, and sync: background jobs, transitional states, empty response bodies for merge/sync, and guidance to poll until state settles - Add base field to create request body and branch schema (nullable, newer-branching system only) - Declare strategy as an enum (use_main, use_branch) in merge and sync - Enumerate the seven public-facing state values in branch schema - Note that the Branching account feature must be enabled on every operation; clarify that update only accepts name
jablan
changed the title
jablan
approved these changes
May 20, 2026
Collaborator
jablan
left a comment
jablan
left a comment
There was a problem hiding this comment.
I altered the title a bit.
Sven Dunemann (forelabs)
deleted the
docs/branches-align-controller-behavior
branch
This was referenced May 20, 2026
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Aligns the Branches operations and branch schema with the actual behavior of Api::V2::BranchesController: