Skip to content
Snippets Groups Projects

Draft: Enable downloading of a specific report

4 unresolved threads

What does this MR do and why?

Job Artifact API endpoints do not work for report artifacts -#352644 

Artifacts download REST API doesn't work for reports unless they are also listed under artifacts - #426810

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

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

Before After

How to set up and validate locally

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

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
151 desc 'Download a specific report from artifacts archive' do
152 failure [
153 { code: 400, message: 'Bad request' },
154 { code: 401, message: 'Unauthorized' },
155 { code: 403, message: 'Forbidden' },
156 { code: 404, message: 'Not found' }
157 ]
158 end
159 params do
160 requires :job_id, type: Integer, desc: 'The ID of a job'
161 requires :report_type, type: String, desc: 'Type of downloadable report .'
162 optional :job_token, type: String,
163 desc: 'To be used with triggers for multi-project pipelines, ' \
164 'available only on Premium and Ultimate tiers.'
165 end
166 route_setting :authentication, job_token_allowed: true
  • Caroline Simpson requested review from @drew

    requested review from @drew

    • @oksanakohuch-ext I have the regular amount of hesitation about adding a new endpoint :sweat_smile: and while I was considering that, I started to wonder why we would add a new endpoint instead of supporting report artifacts in the existing one?

      I'm not saying I'm certain we should do that instead, but it's definitely something we should consider before we commit to a new endpoint.

    • I had also thought about that. But the existing artifacts endpoints don't fit. Reports don't have a path, so we cannot mix them into the single artifacts endpoint.

    • Please register or sign in to reply
  • drew stachon mentioned in issue #504176

    mentioned in issue #504176

  • @drew :wave: I'm closing the MR. Feel free to reopen and take over if that falls under the solution for #504176

  • closed

  • Please register or sign in to reply
    Loading