Repository navigation
feat(API): add include_branches field to automations request and response #STRINGS-3748 - #1329
Merged
Merged
Conversation
…onse #STRINGS-3748
Contributor
API changelog (oasdiff)Doc-only edits (descriptions, examples) do not appear here. |
Efe Bikmaz (bikmazefe)
approved these changes
Oct 16, 2026
This was referenced Oct 16, 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
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.
This PR was generated by the
openapi-applyagent in response to a/openapi-sync applyrequest onPhrase-Engineering/strings-app#19067.
What changed in the API
include_branches(boolean) in the request body. Whentrue, the automation will also target branches of the configured projects; the authorization layer additionally checks whether the designated job owner has permission to create jobs in branches — if not, the request is rejected with 403.include_branches(boolean) in the request body, with the same authorization semantics.include_branchesboolean field in every serialized automation object.Source
Notes for reviewers
lint.shstep (openapi-generator-cli validate) was skipped in CI because Java is not installed in the agent's environment — this is a pre-existing environment constraint, not caused by the spec change.npx swagger-cli validate main.yamlpassed cleanly.create.yamlandupdate.yamlfiles contain a pre-existing convention issue: the403response has both a$refand a siblingdescription:key (which OpenAPI silently ignores). These were not modified as part of this change.include_brancheswas added surgically afterinclude_only_updated_localesin all three files (schemas/automation.yaml,paths/automations/create.yaml,paths/automations/update.yaml), preserving all surrounding content.Opened automatically by the
openapi-applyagent. Review the spec changesagainst the linked strings-app PR; the agent does not vouch for correctness
beyond "the YAML parsed and the documented layout was followed."