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

Signed-off-by: Spike Curtis <spike@coder.com>

coderd/apidoc/docs.go

@@ -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

coderd/apidoc/swagger.json

@@ -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

coderd/files.go

@@ -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) {