Commitaf3eb0b

and

committed

docs(api-docs): make iterator download documentation more generic

Co-authored-by: Nejc Habjan <hab.nejc@gmail.com>

1 parentd7ee6f8 commitaf3eb0bCopy full SHA for af3eb0b

File tree

-3

lines changed

-3

lines changed

Lines changed: 4 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -274,12 +274,13 @@ You can also directly stream the output into a file, and unzip it afterwards::`
`274`	`274`	`subprocess.run(["unzip", "-bo", zipfn])`
`275`	`275`	`os.unlink(zipfn)`
`276`	`276`
`277`		`-It isalsopossible touse the underlying iterator directly::`
	`277`	`+Or, you canalso use the underlying response iterator directly::`
`278`	`278`
`279`	`279`	`artifact_bytes_iterator = build_or_job.artifacts(streamed=True, action='iterator')`
`280`	`280`
`281`		`-This can be used with FastAPI/Starlette StreamingResponse to forward a download from gitlab without having to download`
`282`		`-the entire file server side first::`
	`281`	`+This can be used with frameworks that expect an iterator (such as FastAPI/Starlette's`
	`282`	+``StreamingResponse``) to forward a download from GitLab without having to download
	`283`	`+the entire content server-side first::`
`283`	`284`
`284`	`285`	`@app.get("/download_artifact")`
`285`	`286`	`def download_artifact():`

Comments

(0)