Skip to content

docs(API): document 404 response for inaccessible job template on job creation #1352

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
jablan merged 2 commits into from
Oct 28, 2026
Merged

docs(API): document 404 response for inaccessible job template on job creation #1352

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0455d1
feat(API): enforce job template read authorization on job creation
github-actions[bot] Oct 28, 2026
6f8ec72
Merge branch 'main' into openapi-sync/strings-app-pr-19192
jablan Oct 28, 2026
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
5 changes: 2 additions & 3 deletions doc/compiled.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12337,8 +12337,7 @@
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403",
"description": "Forbidden. Returned when the access token lacks the `write` scope or when the requesting user is not allowed to create jobs in this project."
"description": "Forbidden. Returned when the OAuth token lacks the `write` scope or when the authenticated user does not have permission to create jobs in the given project.\n"
},
"404": {
"$ref": "#/components/responses/404"
Expand Down Expand Up @@ -12440,7 +12439,7 @@
]
},
"job_template_id": {
"description": "id of a job template you would like to model the created job after. Any manually added parameters will take preference over template attributes. Mutually exclusive with `target_locale_ids`.",
"description": "id of a job template you would like to model the created job after. Any manually added parameters will take preference over template attributes. Mutually exclusive with `target_locale_ids`. The calling user must have read access to the template; if the template exists but is not accessible, the request returns 404.\n",
"type": "string",
"example": "abcd1234cdef1234abcd1234cdef1234"
},
Expand Down
13 changes: 10 additions & 3 deletions paths/jobs/create.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,10 @@ responses:
'401':
"$ref": "../../responses.yaml#/401"
'403':
"$ref": "../../responses.yaml#/403"
description: Forbidden. Returned when the access token lacks the `write` scope or when the requesting user is not allowed to create jobs in this project.
description: >
Forbidden. Returned when the OAuth token lacks the `write` scope
or when the authenticated user does not have permission to create
jobs in the given project.
'422':
"$ref": "../../responses.yaml#/422"
'429':
Expand Down Expand Up @@ -114,7 +116,12 @@ requestBody:
example:
- abcd1234cdef1234abcd1234cdef1234
job_template_id:
description: id of a job template you would like to model the created job after. Any manually added parameters will take preference over template attributes. Mutually exclusive with `target_locale_ids`.
description: >
id of a job template you would like to model the created job after.
Any manually added parameters will take preference over template attributes.
Mutually exclusive with `target_locale_ids`. The calling user must have
read access to the template; if the template exists but is not accessible,
the request returns 404.
type: string
example: abcd1234cdef1234abcd1234cdef1234
autotranslate:
Expand Down
Loading