Swagger notice

mtojek · mtojek · commit ec782b200f6a · 2023-01-03T18:21:14.000+01:00
diff --git a/docs/api/files.md b/docs/api/files.md
@@ -16,8 +16,6 @@ curl -X POST http://coder-server:8080/api/v2/files \
 
 `POST /files`
 
-Swagger notice: Swagger 2.0 doesn't support file upload with a `content-type` different than `application/x-www-form-urlencoded`.
-
 > Body parameter
 
 ```yaml
diff --git a/scripts/apidocgen/markdown-template/operation.dot b/scripts/apidocgen/markdown-template/operation.dot
@@ -1,7 +1,17 @@
 {{
 	function renderCodeSample(data) {
 		const originalCodeSample = data.utils.getCodeSamples(data);
-		return originalCodeSample.replace("\n```\n", "```\n")
+		return originalCodeSample.replace("\n```\n", "```\n");
+	}
+
+	function renderDescription(data) {
+		if (!data.operation.description) {
+			return "";
+		}
+		if (data.operation.description.startsWith("Swagger notice:")) {
+			return "";
+		}
+		return data.operation.description;
 	}
 }}
 {{= data.tags.section }}
@@ -27,7 +37,7 @@
 
 {{? data.operation.summary && !data.options.tocSummary}}*{{= data.operation.summary }}*{{?}}
 
-{{? data.operation.description}}{{= data.operation.description }}{{?}}
+{{= renderDescription(data)}}
 
 {{? data.operation.requestBody}}
 > Body parameter
