Fix: x-apidocgen

mtojek · mtojek · commit ae06598c9f37 · 2023-01-04T12:27:06.000+01:00
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
@@ -2796,6 +2796,7 @@ const docTemplate = `{
             }
         },
         "codersdk.PostWorkspaceAgentVersionRequest": {
+            "description": "x-apidocgen:skip",
             "type": "object",
             "properties": {
                 "version": {
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
@@ -2516,6 +2516,7 @@
       }
     },
     "codersdk.PostWorkspaceAgentVersionRequest": {
+      "description": "x-apidocgen:skip",
       "type": "object",
       "properties": {
         "version": {
diff --git a/codersdk/workspaceagents.go b/codersdk/workspaceagents.go
@@ -115,6 +115,7 @@ type WorkspaceAgentConnectionInfo struct {
 }
 
 // @typescript-ignore PostWorkspaceAgentVersionRequest
+// @Description x-apidocgen:skip
 type PostWorkspaceAgentVersionRequest struct {
 	Version string `json:"version"`
 }
diff --git a/docs/api/agents.md b/docs/api/agents.md
@@ -437,38 +437,3 @@ curl -X POST http://coder-server:8080/api/v2/workspaceagents/me/report-stats \
 | 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK          | [codersdk.AgentStatsResponse](schemas.md#codersdkagentstatsresponse) |
 
 To perform this operation, you must be authenticated by means of one of the following methods: **CoderSessionToken**.
-
-## Submit workspace agent version
-
-### Code samples
-
-```shell
-# Example request using curl
-curl -X POST http://coder-server:8080/api/v2/workspaceagents/me/version \
-  -H 'Content-Type: application/json' \
-  -H 'Coder-Session-Token: API_KEY'
-```
-
-`POST /workspaceagents/me/version`
-
-> Body parameter
-
-```json
-{
-  "version": "string"
-}
-```
-
-### Parameters
-
-| Name   | In   | Type                                                                                             | Required | Description     |
-| ------ | ---- | ------------------------------------------------------------------------------------------------ | -------- | --------------- |
-| `body` | body | [codersdk.PostWorkspaceAgentVersionRequest](schemas.md#codersdkpostworkspaceagentversionrequest) | true     | Version request |
-
-### Responses
-
-| Status | Meaning                                                 | Description | Schema |
-| ------ | ------------------------------------------------------- | ----------- | ------ |
-| 200    | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK          |        |
-
-To perform this operation, you must be authenticated by means of one of the following methods: **CoderSessionToken**.
diff --git a/docs/api/schemas.md b/docs/api/schemas.md
@@ -2276,20 +2276,6 @@ Parameter represents a set value for the scope.
 | `source_scheme`      | `none`                 |
 | `source_scheme`      | `data`                 |
 
-## codersdk.PostWorkspaceAgentVersionRequest
-
-```json
-{
-  "version": "string"
-}
-```
-
-### Properties
-
-| Name      | Type   | Required | Restrictions | Description |
-| --------- | ------ | -------- | ------------ | ----------- |
-| `version` | string | false    |              |             |
-
 ## codersdk.PostWorkspaceAppHealthsRequest
 
 ```json
diff --git a/scripts/apidocgen/markdown-template/main.dot b/scripts/apidocgen/markdown-template/main.dot
@@ -92,9 +92,14 @@
 
 > This page is incomplete, stay tuned.
 
-{{ for (var s in data.components.schemas) { }}
-{{ var origSchema = data.components.schemas[s]; }}
-{{ var schema = data.api.components.schemas[s]; }}
+{{ for (var s in data.components.schemas) {
+  var origSchema = data.components.schemas[s];
+  var schema = data.api.components.schemas[s];
+
+  if (schema.description && schema.description.startsWith("x-apidocgen:skip")) {
+	continue;
+  }
+}}
 
 {{= data.tags.section }}
 ## {{=s}}
diff --git a/scripts/apidocgen/markdown-template/operation.dot b/scripts/apidocgen/markdown-template/operation.dot
@@ -18,6 +18,12 @@
 
 ## {{= data.operationUniqueName}}
 
+{{
+  if (data.operation['x-apidocgen'] && data.operation['x-apidocgen'].skip) {
+	return "";
+  }
+}}
+
 {{ data.methodUpper = data.method.verb.toUpperCase(); }}
 {{ data.url = data.utils.slashes(data.baseUrl + data.method.path); }}
 {{ data.parameters = data.operation.parameters; }}

Original file line number	Diff line number	Diff line change
@@ -2796,6 +2796,7 @@ const docTemplate = `{
`2796`	`2796`	`}`
`2797`	`2797`	`},`
`2798`	`2798`	`"codersdk.PostWorkspaceAgentVersionRequest": {`
	`2799`	`+ "description": "x-apidocgen:skip",`
`2799`	`2800`	`"type": "object",`
`2800`	`2801`	`"properties": {`
`2801`	`2802`	`"version": {`
Original file line number	Diff line number	Diff line change
`@@ -2516,6 +2516,7 @@`
`2516`	`2516`	`}`
`2517`	`2517`	`},`
`2518`	`2518`	`"codersdk.PostWorkspaceAgentVersionRequest": {`
	`2519`	`+ "description": "x-apidocgen:skip",`
`2519`	`2520`	`"type": "object",`
`2520`	`2521`	`"properties": {`
`2521`	`2522`	`"version": {`
Original file line number	Diff line number	Diff line change
`@@ -115,6 +115,7 @@ type WorkspaceAgentConnectionInfo struct {`
`115`	`115`	`}`
`116`	`116`
`117`	`117`	`// @typescript-ignore PostWorkspaceAgentVersionRequest`
	`118`	`+// @Description x-apidocgen:skip`
`118`	`119`	`type PostWorkspaceAgentVersionRequest struct {`
`119`	`120`	Version string `json:"version"`
`120`	`121`	`}`