Clean templates

mtojek · mtojek · commit 05b6a984b5fc · 2023-01-09T15:54:22.000+01:00
diff --git a/docs/api/agents.md b/docs/api/agents.md
@@ -192,6 +192,9 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/coordinate \
 
 `GET /workspaceagents/me/coordinate`
 
+It accepts a WebSocket connection to an agent that listens to
+incoming connections and publishes node updates.
+
 ### Responses
 
 | Status | Meaning                                                                  | Description         | Schema |
diff --git a/scripts/apidocgen/markdown-template/debug.def b/scripts/apidocgen/markdown-template/debug.def
diff --git a/scripts/apidocgen/markdown-template/main.dot b/scripts/apidocgen/markdown-template/main.dot
@@ -53,12 +53,16 @@
 
 		const countUppercase = words[0].length - words[0].replace(/[A-Z]/g, '').length;
 		if (countUppercase > 1) {
-			let displayName = p.displayName.replace(/» \*\*additionalProperties\*\*/g, "It");
+			let displayName = p.displayName.replace(/» \*\*additionalProperties\*\*/g, "It").replace("» ", "");
 			displayName = displayName.charAt(0).toUpperCase() + displayName.replace(/_/g, " ").toLowerCase().slice(1);
 			description = displayName + " " + words.slice(1).join(' ');
 		}
 		return correctLetterCase(description);
 	}
+
+	/* Export functions that are used by other template partials. */
+	data.functions = {};
+	data.functions.renderDescription = renderDescription;
 }}
 
 {{? data.api.components && data.api.components.securitySchemes }}{{#def.security}}{{?}}
diff --git a/scripts/apidocgen/markdown-template/responses.def b/scripts/apidocgen/markdown-template/responses.def
@@ -44,41 +44,6 @@
 
 		return p.safeType;
 	}
-
-	function correctLetterCase(description) {
-		const dictionary = ["id", "url"];
-
-		const words = description.split(' ');
-		var corrected = [];
-		words.forEach(word => {
-			if (dictionary.includes(word.toLowerCase())) {
-				corrected.push(word.toUpperCase());
-				return;
-			}
-			corrected.push(word);
-		});
-		return corrected.join(" ");
-	}
-
-	function renderDescription(p) {
-		if (!p.description) {
-			return "";
-		}
-
-		let description = p.description.replace(/<br><br>/g, "\n").replace(/<br>/g, " ");
-		const words = description.split(' ');
-		if (words.length == 0) {
-			return "";
-		}
-
-		const countUppercase = words[0].length - words[0].replace(/[A-Z]/g, '').length;
-		if (countUppercase > 1) {
-			let displayName = p.displayName.replace(/» \*\*additionalProperties\*\*/g, "It").replace("» ", "");
-			displayName = displayName.charAt(0).toUpperCase() + displayName.replace(/_/g, " ").toLowerCase().slice(1);
-			description = displayName + " " + words.slice(1).join(' ');
-		}
-		return correctLetterCase(description);
-	}
 }}
 {{ data.responses = data.utils.getResponses(data); }}
 {{ data.responseSchemas = false; }}
@@ -132,7 +97,7 @@ Status Code **{{=response.status}}**
 {{?}}
 |Name|Type|Required|Restrictions|Description|
 |---|---|---|---|---|
-{{~block.rows :p}}|`{{=renderDisplayName(p)}}`|{{=renderResponsePropertyType(p)}}|{{=p.required}}|{{=p.restrictions||''}}|{{=renderDescription(p)}}|
+{{~block.rows :p}}|`{{=renderDisplayName(p)}}`|{{=renderResponsePropertyType(p)}}|{{=p.required}}|{{=p.restrictions||''}}|{{=data.functions.renderDescription(p)}}|
 {{~}}
 {{~}}
 {{?}}
