Skip to content

feat(API): add include_branches field to automations request and response #STRINGS-3748 - #1329

Merged
Efe Bikmaz (bikmazefe) merged 1 commit into
mainfrom
openapi-sync/strings-app-pr-19067
Oct 16, 2026
Merged

Efe Bikmaz (bikmazefe) merged 1 commit into
mainfrom
openapi-sync/strings-app-pr-19067

Conversation

@phrase-bot

Copy link
Copy Markdown
Collaborator

This PR was generated by the openapi-apply agent in response to a
/openapi-sync apply request on
Phrase-Engineering/strings-app#19067.

What changed in the API

  • POST /api/v2/automations now accepts include_branches (boolean) in the request body. When true, 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.
  • PATCH /api/v2/automations/{id} now accepts include_branches (boolean) in the request body, with the same authorization semantics.
  • All automation responses (GET /api/v2/automations, GET /api/v2/automations/{id}, and the create/update/activate/deactivate response bodies) now include the include_branches boolean field in every serialized automation object.

Source

Notes for reviewers

  • The lint.sh step (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.yaml passed cleanly.
  • The existing create.yaml and update.yaml files contain a pre-existing convention issue: the 403 response has both a $ref and a sibling description: key (which OpenAPI silently ignores). These were not modified as part of this change.
  • include_branches was added surgically after include_only_updated_locales in all three files (schemas/automation.yaml, paths/automations/create.yaml, paths/automations/update.yaml), preserving all surrounding content.

Opened automatically by the openapi-apply agent. Review the spec changes
against the linked strings-app PR; the agent does not vouch for correctness
beyond "the YAML parsed and the documented layout was followed."

@github-actions

Copy link
Copy Markdown
Contributor

API changelog (oasdiff)

Doc-only edits (descriptions, examples) do not appear here.

8 changes: 0 error, 0 warning, 8 info
info	[response-optional-property-added] at doc/compiled.json
	in API GET /accounts/{account_id}/automations
		added the optional property `items/include_branches` to the response with the `200` status

info	[new-optional-request-property] at doc/compiled.json
	in API POST /accounts/{account_id}/automations
		added the new optional request property `include_branches`

info	[response-optional-property-added] at doc/compiled.json
	in API POST /accounts/{account_id}/automations
		added the optional property `include_branches` to the response with the `201` status

info	[response-optional-property-added] at doc/compiled.json
	in API GET /accounts/{account_id}/automations/{automation_id}
		added the optional property `include_branches` to the response with the `200` status

info	[new-optional-request-property] at doc/compiled.json
	in API PATCH /accounts/{account_id}/automations/{automation_id}
		added the new optional request property `include_branches`

info	[response-optional-property-added] at doc/compiled.json
	in API PATCH /accounts/{account_id}/automations/{automation_id}
		added the optional property `include_branches` to the response with the `200` status

info	[response-optional-property-added] at doc/compiled.json
	in API POST /accounts/{account_id}/automations/{automation_id}/activate
		added the optional property `include_branches` to the response with the `200` status

info	[response-optional-property-added] at doc/compiled.json
	in API POST /accounts/{account_id}/automations/{automation_id}/deactivate
		added the optional property `include_branches` to the response with the `200` status

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants