diff --git a/doc/compiled.json b/doc/compiled.json index 766710a45..bf255f734 100644 --- a/doc/compiled.json +++ b/doc/compiled.json @@ -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": { @@ -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" } } } @@ -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" } } } diff --git a/paths/automations/create.yaml b/paths/automations/create.yaml index 24e87c06b..ffdf9bbdb 100644 --- a/paths/automations/create.yaml +++ b/paths/automations/create.yaml @@ -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 diff --git a/paths/automations/update.yaml b/paths/automations/update.yaml index 9dc30d063..7e29cc0ca 100644 --- a/paths/automations/update.yaml +++ b/paths/automations/update.yaml @@ -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 diff --git a/schemas/automation.yaml b/schemas/automation.yaml index 5f851a94c..11015e7c9 100644 --- a/schemas/automation.yaml +++ b/schemas/automation.yaml @@ -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: