Function assertProduce

coderd/coderdtest/swaggerparser.go:389–415

(t *testing.T, comment SwaggerComment)

var allowedProduceTypes = []string{"json", "text/event-stream", "text/html", "text/plain"}

func assertProduce(t *testing.T, comment SwaggerComment) {
	var hasResponseModel bool
	for _, r := range comment.successes {
		if r.model != "" {
			hasResponseModel = true
			break
		}
	}

	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 == "/api/v2/workspaceagents/me/app-health" && comment.method == "post") ||
			(comment.router == "/api/v2/workspaceagents/me/startup" && comment.method == "post") ||
			(comment.router == "/api/v2/workspaceagents/me/startup/logs" && comment.method == "patch") ||
			(comment.router == "/api/v2/licenses/{id}" && comment.method == "delete") ||
			(comment.router == "/api/v2/debug/coordinator" && comment.method == "get") ||
			(comment.router == "/api/v2/debug/tailnet" && comment.method == "get") ||
			(comment.router == "/api/v2/workspaces/{workspace}/acl" && comment.method == "patch") ||
			(comment.router == "/api/v2/init-script/{os}/{arch}" && comment.method == "get") {
			return // Exception: HTTP 200 is returned without response entity
		}

		assert.Truef(t, comment.produce == "", "Response model is undefined, so we can't predict the content type: %v", comment)
	}
}