Workspaces: more docs

mtojek · mtojek · commit ddd2d7d80882 · 2022-12-19T11:28:04.000+01:00
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
@@ -482,7 +482,7 @@ const docTemplate = `{
                     }
                 ],
                 "produces": [
-                    "application/json"
+                    "text/event-stream"
                 ],
                 "tags": [
                     "Workspaces"
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
@@ -428,7 +428,7 @@
             "CoderSessionToken": []
           }
         ],
-        "produces": ["application/json"],
+        "produces": ["text/event-stream"],
         "tags": ["Workspaces"],
         "summary": "Watch workspace by ID",
         "operationId": "watch-workspace-id",
diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -884,7 +884,7 @@ func (api *API) putExtendWorkspace(rw http.ResponseWriter, r *http.Request) {
 // @Summary Watch workspace by ID
 // @ID watch-workspace-id
 // @Security CoderSessionToken
-// @Produce application/json
+// @Produce text/event-stream
 // @Tags Workspaces
 // @Param workspace path string true "Workspace ID" format(uuid)
 // @Success 200 {object} codersdk.Response
diff --git a/docs/api/workspaces.md b/docs/api/workspaces.md
@@ -852,7 +852,7 @@ To perform this operation, you must be authenticated by means of one of the foll
 ```shell
 # Example request using curl
 curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/watch \
-  -H 'Accept: application/json' \
+  -H 'Accept: text/event-stream' \
   -H 'Coder-Session-Token: API_KEY'
 
 ```
@@ -869,19 +869,6 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/watch \
 
 > 200 Response
 
-```json
-{
-  "detail": "string",
-  "message": "string",
-  "validations": [
-    {
-      "detail": "string",
-      "field": "string"
-    }
-  ]
-}
-```
-
 ### Responses
 
 | Status | Meaning                                                 | Description | Schema                                           |
diff --git a/scripts/apidocgen/markdown-template/responses.def b/scripts/apidocgen/markdown-template/responses.def
@@ -3,7 +3,16 @@
 		if (!r.content) {
 			return "none";
 		}
-		var oldRef = r.content['application/json'].schema['x-widdershins-oldRef'];
+		var content;
+		for (var ct in r.content) {
+			content = r.content[ct];
+			break;
+		}
+		if (!content) {
+			return "no schema";
+		}
+
+		var oldRef = content.schema["x-widdershins-oldRef"];
 		var aType = oldRef.replace("#/components/schemas/","");
 		var href = aType.replace(".","").toLowerCase();
 		return "[" + aType + "](schemas.md#" + href + ")";

Original file line number	Diff line number	Diff line change
@@ -482,7 +482,7 @@ const docTemplate = `{
`482`	`482`	`}`
`483`	`483`	`],`
`484`	`484`	`"produces": [`
`485`		`- "application/json"`
	`485`	`+ "text/event-stream"`
`486`	`486`	`],`
`487`	`487`	`"tags": [`
`488`	`488`	`"Workspaces"`
Original file line number	Diff line number	Diff line change
`@@ -428,7 +428,7 @@`
`428`	`428`	`"CoderSessionToken": []`
`429`	`429`	`}`
`430`	`430`	`],`
`431`		`- "produces": ["application/json"],`
	`431`	`+ "produces": ["text/event-stream"],`
`432`	`432`	`"tags": ["Workspaces"],`
`433`	`433`	`"summary": "Watch workspace by ID",`
`434`	`434`	`"operationId": "watch-workspace-id",`