Skip to content

feat(API): add exclude_linked_child_keys to jobs and job templates #STRINGS-4424 #1356

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
Mikko Karkee (Varpuspaavi) merged 1 commit into from
Nov 4, 2026
Merged

feat(API): add exclude_linked_child_keys to jobs and job templates #STRINGS-4424 #1356

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
45 changes: 45 additions & 0 deletions doc/compiled.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3782,6 +3782,11 @@
"type": "boolean",
"description": "`true` if the job has been locked by the project's job-locking workflow (translations attached to the job are read-only until the job advances).\n"
},
"exclude_linked_child_keys": {
"type": "boolean",
"description": "`true` if linked child keys are excluded from this job. While enabled, linked child keys cannot be added to the job.\n",
"example": false
},
"automation_id": {
"type": "string",
"nullable": true,
Expand Down Expand Up @@ -3996,6 +4001,11 @@
"items": {
"$ref": "#/components/schemas/locale_preview"
}
},
"exclude_linked_child_keys": {
"type": "boolean",
"description": "`true` if jobs created from this template exclude linked child keys.\n",
"example": false
}
},
"example": {
Expand Down Expand Up @@ -4998,6 +5008,11 @@
"items": {
"$ref": "#/components/schemas/locale_preview"
}
},
"exclude_linked_child_keys": {
"type": "boolean",
"description": "`true` if jobs created from this template exclude linked child keys.\n",
"example": false
}
},
"example": {
Expand Down Expand Up @@ -12447,6 +12462,11 @@
"description": "Automatically translate the job using machine translation.",
"type": "boolean",
"example": true
},
"exclude_linked_child_keys": {
"description": "Exclude linked child keys from the job. While enabled, linked child keys cannot be added to the job. Defaults to `false`.",
"type": "boolean",
"example": false
}
}
}
Expand Down Expand Up @@ -12755,6 +12775,11 @@
"description": "Automatically translate the job using machine translation",
"type": "boolean",
"example": true
},
"exclude_linked_child_keys": {
"description": "Exclude linked child keys from the job. When set to `true`, linked child keys already in the job are removed and none can be added while the option is enabled.",
"type": "boolean",
"example": false
}
}
}
Expand Down Expand Up @@ -13621,6 +13646,11 @@
"type": "boolean",
"example": true
},
"exclude_linked_child_keys": {
"description": "Exclude linked child keys from jobs created from this template. Defaults to `false`.",
"type": "boolean",
"example": false
},
"source_locale_id": {
"description": "The API id of the source language. This locale will be set as source locale for the job template. If not provided, the project default locale will be used.",
"type": "string",
Expand Down Expand Up @@ -13819,6 +13849,11 @@
"type": "boolean",
"example": true
},
"exclude_linked_child_keys": {
"description": "Exclude linked child keys from jobs created from this template.",
"type": "boolean",
"example": false
},
"source_locale_id": {
"description": "The API id of the source language. This locale will be set as source locale for the job template. If not provided, the project default locale will be used.",
"type": "string",
Expand Down Expand Up @@ -31705,6 +31740,11 @@
"type": "boolean",
"example": true
},
"exclude_linked_child_keys": {
"description": "Exclude linked child keys from jobs created from this template. Defaults to `false`.",
"type": "boolean",
"example": false
},
"owner_id": {
"description": "Code of the account member to set as the job template owner. When omitted\nor blank, no owner is pre-set; the user who creates a job from this template\nis assigned as its owner at job-creation time.\n",
"type": "string"
Expand Down Expand Up @@ -31884,6 +31924,11 @@
"type": "boolean",
"example": true
},
"exclude_linked_child_keys": {
"description": "Exclude linked child keys from jobs created from this template.",
"type": "boolean",
"example": false
},
"owner_id": {
"description": "Code of the account member to set as the job template owner.\nPass an empty string to clear a previously set owner; when blank,\nthe owner is set to null and jobs created from this template will\ndefault to assigning the job creator as owner.\n",
"type": "string"
Expand Down
4 changes: 4 additions & 0 deletions paths/job_templates/create.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@ requestBody:
description: Automatically translate the job using machine translation.
type: boolean
example: true
exclude_linked_child_keys:
description: Exclude linked child keys from jobs created from this template. Defaults to `false`.
type: boolean
example: false
source_locale_id:
description: The API id of the source language. This locale will be set as source locale for the job template. If not provided, the project default locale will be used.
type: string
Expand Down
4 changes: 4 additions & 0 deletions paths/job_templates/update.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,10 @@ requestBody:
description: Automatically translate the job using machine translation.
type: boolean
example: true
exclude_linked_child_keys:
description: Exclude linked child keys from jobs created from this template.
type: boolean
example: false
source_locale_id:
description: The API id of the source language. This locale will be set as source locale for the job template. If not provided, the project default locale will be used.
type: string
Expand Down
4 changes: 4 additions & 0 deletions paths/jobs/create.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,4 +128,8 @@ requestBody:
description: Automatically translate the job using machine translation.
type: boolean
example: true
exclude_linked_child_keys:
description: Exclude linked child keys from the job. While enabled, linked child keys cannot be added to the job. Defaults to `false`.
type: boolean
example: false
x-cli-version: '2.5'
4 changes: 4 additions & 0 deletions paths/jobs/update.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,4 +96,8 @@ requestBody:
description: Automatically translate the job using machine translation
type: boolean
example: true
exclude_linked_child_keys:
description: Exclude linked child keys from the job. When set to `true`, linked child keys already in the job are removed and none can be added while the option is enabled.
type: boolean
example: false
x-cli-version: '2.5'
4 changes: 4 additions & 0 deletions paths/organization_job_templates/create.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@ requestBody:
description: Automatically translate the job using machine translation.
type: boolean
example: true
exclude_linked_child_keys:
description: Exclude linked child keys from jobs created from this template. Defaults to `false`.
type: boolean
example: false
owner_id:
description: |
Code of the account member to set as the job template owner. When omitted
Expand Down
4 changes: 4 additions & 0 deletions paths/organization_job_templates/update.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,10 @@ requestBody:
description: Automatically translate the job using machine translation.
type: boolean
example: true
exclude_linked_child_keys:
description: Exclude linked child keys from jobs created from this template.
type: boolean
example: false
owner_id:
description: |
Code of the account member to set as the job template owner.
Expand Down
5 changes: 5 additions & 0 deletions schemas/job_details.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,11 @@ job_details:
type: boolean
description: |
`true` if the job has been locked by the project's job-locking workflow (translations attached to the job are read-only until the job advances).
exclude_linked_child_keys:
type: boolean
description: |
`true` if linked child keys are excluded from this job. While enabled, linked child keys cannot be added to the job.
example: false
automation_id:
type: string
nullable: true
Expand Down
5 changes: 5 additions & 0 deletions schemas/job_template_details.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ job_template_details:
type: array
items:
"$ref": "./locale_preview.yaml#/locale_preview"
exclude_linked_child_keys:
type: boolean
description: |
`true` if jobs created from this template exclude linked child keys.
example: false
example:
owner:
id: abcd1234cdef1234abcd1234cdef1234
Expand Down
5 changes: 5 additions & 0 deletions schemas/organization_job_template_details.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ organization_job_template_details:
type: array
items:
"$ref": "./locale_preview.yaml#/locale_preview"
exclude_linked_child_keys:
type: boolean
description: |
`true` if jobs created from this template exclude linked child keys.
example: false
example:
owner:
id: abcd1234cdef1234abcd1234cdef1234
Expand Down
Loading