Skip to content

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

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.

Sign up for GitHub

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

Merged
Efe Bikmaz (bikmazefe) merged 1 commit into from
Oct 16, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions doc/compiled.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5287,6 +5287,10 @@
"type": "boolean",
"description": "When `true`, the automation only acts on locales that changed since its last run."
},
"include_branches": {
"type": "boolean",
"description": "When true, the automation targets branches of the configured projects in addition to the main project. Requires the designated job owner to have permission to create jobs in branches for every configured project.\n"
},
"tags": {
"type": "array",
"items": {
Expand Down Expand Up @@ -32889,6 +32893,10 @@
"description": "When `true`, the automation only acts on locales that changed since its last run. Defaults to `false`.\n",
"type": "boolean",
"example": false
},
"include_branches": {
"description": "When true, the automation also runs against branches of the configured projects. The designated job owner must have permission to create jobs in branches for every configured project; otherwise the request is rejected with 403.\n",
"type": "boolean"
}
}
}
Expand Down Expand Up @@ -33118,6 +33126,10 @@
"description": "When `true`, the automation only acts on locales that changed since its last run.\n",
"type": "boolean",
"example": false
},
"include_branches": {
"description": "When true, the automation also runs against branches of the configured projects. The designated job owner must have permission to create jobs in branches for every configured project; otherwise the request is rejected with 403.\n",
"type": "boolean"
}
}
}
Expand Down
7 changes: 7 additions & 0 deletions paths/automations/create.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,13 @@ requestBody:
When `true`, the automation only acts on locales that changed since its last run. Defaults to `false`.
type: boolean
example: false
include_branches:
description: >
When true, the automation also runs against branches of the configured
projects. The designated job owner must have permission to create jobs
in branches for every configured project; otherwise the request is
rejected with 403.
type: boolean
responses:
'201':
description: Created
Expand Down
7 changes: 7 additions & 0 deletions paths/automations/update.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,13 @@ requestBody:
When `true`, the automation only acts on locales that changed since its last run.
type: boolean
example: false
include_branches:
description: >
When true, the automation also runs against branches of the configured
projects. The designated job owner must have permission to create jobs
in branches for every configured project; otherwise the request is
rejected with 403.
type: boolean
responses:
'200':
description: OK
Expand Down
6 changes: 6 additions & 0 deletions schemas/automation.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,12 @@ automation:
include_only_updated_locales:
type: boolean
description: When `true`, the automation only acts on locales that changed since its last run.
include_branches:
type: boolean
description: >
When true, the automation targets branches of the configured projects in
addition to the main project. Requires the designated job owner to have
permission to create jobs in branches for every configured project.
tags:
type: array
items:
Expand Down
Loading