Notice

mtojek · mtojek · commit 78dc628da315 · 2022-12-22T12:59:58.000+01:00
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
@@ -310,6 +310,7 @@ const docTemplate = `{
                         "CoderSessionToken": []
                     }
                 ],
+                "description": "Notice: Swagger 2.0 doesn't support file upload with a ` + "`" + `content-type` + "`" + ` different than ` + "`" + `application/x-www-form-urlencoded` + "`" + `.",
                 "consumes": [
                     "application/x-tar"
                 ],
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
@@ -264,6 +264,7 @@
             "CoderSessionToken": []
           }
         ],
+        "description": "Notice: Swagger 2.0 doesn't support file upload with a `content-type` different than `application/x-www-form-urlencoded`.",
         "consumes": ["application/x-tar"],
         "produces": ["application/json"],
         "tags": ["Files"],
diff --git a/coderd/files.go b/coderd/files.go
@@ -24,6 +24,7 @@ const (
 )
 
 // @Summary Upload file
+// @Description Notice: Swagger 2.0 doesn't support file upload with a `content-type` different than `application/x-www-form-urlencoded`.
 // @ID update-file
 // @Security CoderSessionToken
 // @Produce json
diff --git a/docs/api/files.md b/docs/api/files.md
@@ -16,6 +16,8 @@ curl -X POST http://coder-server:8080/api/v2/files \
 
 `POST /files`
 
+Notice: Swagger 2.0 doesn't support file upload with a `content-type` different than `application/x-www-form-urlencoded`.
+
 > Body parameter
 
 ```yaml

Original file line number	Diff line number	Diff line change
@@ -310,6 +310,7 @@ const docTemplate = `{
`310`	`310`	`"CoderSessionToken": []`
`311`	`311`	`}`
`312`	`312`	`],`
	`313`	+ "description": "Notice: Swagger 2.0 doesn't support file upload with a ` + "`" + `content-type` + "`" + ` different than ` + "`" + `application/x-www-form-urlencoded` + "`" + `.",
`313`	`314`	`"consumes": [`
`314`	`315`	`"application/x-tar"`
`315`	`316`	`],`
Original file line number	Diff line number	Diff line change
`@@ -264,6 +264,7 @@`
`264`	`264`	`"CoderSessionToken": []`
`265`	`265`	`}`
`266`	`266`	`],`
	`267`	+ "description": "Notice: Swagger 2.0 doesn't support file upload with a `content-type` different than `application/x-www-form-urlencoded`.",
`267`	`268`	`"consumes": ["application/x-tar"],`
`268`	`269`	`"produces": ["application/json"],`
`269`	`270`	`"tags": ["Files"],`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ const (`
`24`	`24`	`)`
`25`	`25`
`26`	`26`	`// @Summary Upload file`
	`27`	+// @Description Notice: Swagger 2.0 doesn't support file upload with a `content-type` different than `application/x-www-form-urlencoded`.
`27`	`28`	`// @ID update-file`
`28`	`29`	`// @Security CoderSessionToken`
`29`	`30`	`// @Produce json`