Skip to content

Clarify description on job_token API param

Albert requested to merge 347244-clarify-job-artifacts-api-job-token-auth into master

What does this MR do and why?

The documentation on job_token API param in Job Artifacts API is currently sparse in the detail and open to interpretation.

This MR clarifies that the job_token API param must only be used in a CI job defined through .gitlab-ci.yml, because it can only be used by a job that is currently running.

Side note: The job_token param is only available on Premium upwards. This is indicated clearly in the doc source code, but it is not very visible in the rendered doc page as it is hidden behind a tooltip. See gitlab-docs#1251 (closed) for more on that.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #347244 (closed)

Edited by Albert

Merge request reports