Fix: renderDisplayName

mtojek · mtojek · commit 95718aa181f3 · 2022-12-19T11:51:02.000+01:00
diff --git a/docs/api/schemas.md b/docs/api/schemas.md
@@ -122,19 +122,19 @@
 
 ### Properties
 
-| Name                         | Type   | Required | Restrictions | Description |
-| ---------------------------- | ------ | -------- | ------------ | ----------- |
-| `canceled_at`                | string | false    | none         | none        |
-| `completed_at`               | string | false    | none         | none        |
-| `created_at`                 | string | false    | none         | none        |
-| `error`                      | string | false    | none         | none        |
-| `file_id`                    | string | false    | none         | none        |
-| `id`                         | string | false    | none         | none        |
-| `started_at`                 | string | false    | none         | none        |
-| `status`                     | string | false    | none         | none        |
-| `tags`                       | object | false    | none         | none        |
-| `» **additionalProperties**` | string | false    | none         | none        |
-| `worker_id`                  | string | false    | none         | none        |
+| Name               | Type   | Required | Restrictions | Description |
+| ------------------ | ------ | -------- | ------------ | ----------- |
+| `canceled_at`      | string | false    | none         | none        |
+| `completed_at`     | string | false    | none         | none        |
+| `created_at`       | string | false    | none         | none        |
+| `error`            | string | false    | none         | none        |
+| `file_id`          | string | false    | none         | none        |
+| `id`               | string | false    | none         | none        |
+| `started_at`       | string | false    | none         | none        |
+| `status`           | string | false    | none         | none        |
+| `tags`             | object | false    | none         | none        |
+| » `[any property]` | string | false    | none         | none        |
+| `worker_id`        | string | false    | none         | none        |
 
 ## codersdk.PutExtendWorkspaceRequest
 
@@ -545,13 +545,13 @@
 | `directory`                  | string                                                  | false    | none         | none                                                                    |
 | `disconnected_at`            | string                                                  | false    | none         | none                                                                    |
 | `environment_variables`      | object                                                  | false    | none         | none                                                                    |
-| `» **additionalProperties**` | string                                                  | false    | none         | none                                                                    |
+| » `[any property]`           | string                                                  | false    | none         | none                                                                    |
 | `first_connected_at`         | string                                                  | false    | none         | none                                                                    |
 | `id`                         | string                                                  | false    | none         | none                                                                    |
 | `instance_id`                | string                                                  | false    | none         | none                                                                    |
 | `last_connected_at`          | string                                                  | false    | none         | none                                                                    |
 | `latency`                    | object                                                  | false    | none         | DERPLatency is mapped by region name (e.g. "New York City", "Seattle"). |
-| `» **additionalProperties**` | [codersdk.DERPRegion](#codersdkderpregion)              | false    | none         | none                                                                    |
+| » `[any property]`           | [codersdk.DERPRegion](#codersdkderpregion)              | false    | none         | none                                                                    |
 | `name`                       | string                                                  | false    | none         | none                                                                    |
 | `operating_system`           | string                                                  | false    | none         | none                                                                    |
 | `resource_id`                | string                                                  | false    | none         | none                                                                    |
diff --git a/scripts/apidocgen/markdown-template/main.dot b/scripts/apidocgen/markdown-template/main.dot
@@ -17,6 +17,13 @@
 		}
 		return renderSinglePropertyType(p);
 	}
+
+	function renderDisplayName(p) {
+		if (p.displayName == "» **additionalProperties**") {
+			return "» `[any property]`";
+		}
+		return "`" + p.displayName + "`";
+	}
 }}
 
 {{? data.api.components && data.api.components.securitySchemes }}{{#def.security}}{{?}}
@@ -92,7 +99,7 @@
 
 {{? block.rows.length}}|Name|Type|Required|Restrictions|Description|
 |---|---|---|---|---|{{?}}
-{{~ block.rows :p}}|`{{=p.displayName}}`|{{= renderPropertyType(p)}}|{{=p.required}}|{{=p.restrictions||'none'}}|{{=p.description||'none'}}|
+{{~ block.rows :p}}|{{= renderDisplayName(p)}}|{{= renderPropertyType(p)}}|{{=p.required}}|{{=p.restrictions||'none'}}|{{=p.description||'none'}}|
 {{~}}
 {{~}}
 {{? (blocks[0].rows.length === 0) && (blocks.length === 1) }}
