Produce: json

mtojek · mtojek · commit 6d21862cc3b9 · 2023-01-13T15:09:46.000+01:00
diff --git a/coderd/coderdtest/swaggerparser.go b/coderd/coderdtest/swaggerparser.go
@@ -295,6 +295,8 @@ func assertAccept(t *testing.T, comment SwaggerComment) {
 	}
 }
 
+var allowedProduceTypes = []string{"json", "text/event-stream"}
+
 func assertProduce(t *testing.T, comment SwaggerComment) {
 	var hasResponseModel bool
 	for _, r := range comment.successes {
@@ -306,6 +308,7 @@ func assertProduce(t *testing.T, comment SwaggerComment) {
 
 	if hasResponseModel {
 		assert.True(t, comment.produce != "", "Route must have @Produce annotation as it responds with a model structure")
+		assert.Contains(t, allowedProduceTypes, comment.produce, "@Produce value is limited to specific types: %s", strings.Join(allowedProduceTypes, ","))
 	} else {
 		if (comment.router == "/workspaceagents/me/app-health" && comment.method == "post") ||
 			(comment.router == "/workspaceagents/me/version" && comment.method == "post") ||
diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -826,7 +826,7 @@ func convertWorkspaceAgent(derpMap *tailcfg.DERPMap, coordinator tailnet.Coordin
 // @ID submit-workspace-agent-stats
 // @Security CoderSessionToken
 // @Accept json
-// @Produce application/json
+// @Produce json
 // @Tags Agents
 // @Param request body codersdk.AgentStats true "Stats request"
 // @Success 200 {object} codersdk.AgentStatsResponse
@@ -904,7 +904,7 @@ func (api *API) workspaceAgentReportStats(rw http.ResponseWriter, r *http.Reques
 // @ID submit-workspace-agent-application-health
 // @Security CoderSessionToken
 // @Accept json
-// @Produce application/json
+// @Produce json
 // @Tags Agents
 // @Param request body codersdk.PostWorkspaceAppHealthsRequest true "Application health request"
 // @Success 200

Original file line number	Diff line number	Diff line change
`@@ -295,6 +295,8 @@ func assertAccept(t *testing.T, comment SwaggerComment) {`
`295`	`295`	`}`
`296`	`296`	`}`
`297`	`297`
	`298`	`+var allowedProduceTypes = []string{"json", "text/event-stream"}`
	`299`	`+`
`298`	`300`	`func assertProduce(t *testing.T, comment SwaggerComment) {`
`299`	`301`	`var hasResponseModel bool`
`300`	`302`	`for _, r := range comment.successes {`
`@@ -306,6 +308,7 @@ func assertProduce(t *testing.T, comment SwaggerComment) {`
`306`	`308`
`307`	`309`	`if hasResponseModel {`
`308`	`310`	`assert.True(t, comment.produce != "", "Route must have @Produce annotation as it responds with a model structure")`
	`311`	`+ assert.Contains(t, allowedProduceTypes, comment.produce, "@Produce value is limited to specific types: %s", strings.Join(allowedProduceTypes, ","))`
`309`	`312`	`} else {`
`310`	`313`	`if (comment.router == "/workspaceagents/me/app-health" && comment.method == "post") \|\|`
`311`	`314`	`(comment.router == "/workspaceagents/me/version" && comment.method == "post") \|\|`