synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-15 22:20:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: document files API needs ustar format (#14152)

Browse Source 
Signed-off-by: Spike Curtis <spike@coder.com>
This commit is contained in:
Spike Curtis
2024-08-06 11:00:49 +04:00
committed by GitHub
parent 097f739492
commit 70a694ed4c
4 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
coderd/apidoc/docs.go generated
View File

@ -988,7 +988,7 @@ const docTemplate = `{
},
{
"type": "file",
"description": "File to be uploaded",
"description": "File to be uploaded. If using tar format, file must conform to ustar (pax may cause problems).",
"name": "file",
"in": "formData",
"required": true

2
coderd/apidoc/swagger.json generated
View File

@ -848,7 +848,7 @@
},
{
"type": "file",
"description": "File to be uploaded",
"description": "File to be uploaded. If using tar format, file must conform to ustar (pax may cause problems).",
"name": "file",
"in": "formData",
"required": true

2
coderd/files.go
View File

@ -38,7 +38,7 @@ const (
// @Accept application/x-tar
// @Tags Files
// @Param Content-Type header string true "Content-Type must be `application/x-tar` or `application/zip`" default(application/x-tar)
// @Param file formData file true "File to be uploaded"
// @Param file formData file true "File to be uploaded. If using tar format, file must conform to ustar (pax may cause problems)."
// @Success 201 {object} codersdk.UploadResponse
// @Router /files [post]
func (api *API) postFile(rw http.ResponseWriter, r *http.Request) {