Skip to content

Commit 70a694e

Browse files
authored
fix: document files API needs ustar format (#14152)
Signed-off-by: Spike Curtis <spike@coder.com>
1 parent 097f739 commit 70a694e

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

coderd/apidoc/docs.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

coderd/apidoc/swagger.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

coderd/files.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ const (
3838
// @Accept application/x-tar
3939
// @Tags Files
4040
// @Param Content-Type header string true "Content-Type must be `application/x-tar` or `application/zip`" default(application/x-tar)
41-
// @Param file formData file true "File to be uploaded"
41+
// @Param file formData file true "File to be uploaded. If using tar format, file must conform to ustar (pax may cause problems)."
4242
// @Success 201 {object} codersdk.UploadResponse
4343
// @Router /files [post]
4444
func (api *API) postFile(rw http.ResponseWriter, r *http.Request) {

docs/api/files.md

Lines changed: 5 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy