Jobs API browse Artifacts
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Problem to solve
I would like to list the files contained in an artifact zip file using the Jobs API, similar to that of the browse function in the UI.
Intended users
Further details
At present the only way to explore the contents of an artefact is to use the browse functionality in the UI. This means that there is no way to download a single artefact without knowing the full path before hand.
Proposal
Create a new endpoint: GET /projects/:id/jobs/:job_id/artifacts/browse which will return the list of files contained in the artefact.
Permissions and Security
This is exposed on the UI already, so I don't see any security concerns.
Documentation
https://docs.gitlab.com/ee/api/jobs.html will need updating.
Testing
This additional endpoint would have no effect on the current system, just additional tests would need adding.
What does success look like, and how can we measure that?
Returning a list of files that are contained in the artefact. Perhaps in a similar format to the artifacts key in the Job Response:
{
"file_type": "metadata",
"size": 232,
"filename": "metadata.gz",
"file_format": "gzip"
}What is the type of buyer?
Standard feature.