chore: use rw.WriteHeader to write responses without bodies (#13870)

aslilac · web-flow · commit de2585b0b6e9 · 2024-07-11T13:38:33.000-06:00
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/apikey.go b/coderd/apikey.go
@@ -333,7 +333,7 @@ func (api *API) deleteAPIKey(rw http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	httpapi.Write(ctx, rw, http.StatusNoContent, nil)
+	rw.WriteHeader(http.StatusNoContent)
 }
 
 // @Summary Get token config
diff --git a/coderd/debug.go b/coderd/debug.go
@@ -235,7 +235,7 @@ func (api *API) putDeploymentHealthSettings(rw http.ResponseWriter, r *http.Requ
 
 	if bytes.Equal(settingsJSON, []byte(currentSettingsJSON)) {
 		// See: https://www.rfc-editor.org/rfc/rfc7231#section-6.3.5
-		httpapi.Write(r.Context(), rw, http.StatusNoContent, nil)
+		rw.WriteHeader(http.StatusNoContent)
 		return
 	}
 
diff --git a/coderd/externalauth.go b/coderd/externalauth.go
@@ -197,7 +197,7 @@ func (api *API) postExternalAuthDeviceByID(rw http.ResponseWriter, r *http.Reque
 			return
 		}
 	}
-	httpapi.Write(ctx, rw, http.StatusNoContent, nil)
+	rw.WriteHeader(http.StatusNoContent)
 }
 
 // @Summary Get external auth device by ID.
diff --git a/coderd/identityprovider/revoke.go b/coderd/identityprovider/revoke.go
@@ -39,6 +39,6 @@ func RevokeApp(db database.Store) http.HandlerFunc {
 			httpapi.InternalServerError(rw, err)
 			return
 		}
-		httpapi.Write(ctx, rw, http.StatusNoContent, nil)
+		rw.WriteHeader(http.StatusNoContent)
 	}
 }
diff --git a/coderd/oauth2.go b/coderd/oauth2.go
@@ -207,7 +207,7 @@ func (api *API) deleteOAuth2ProviderApp(rw http.ResponseWriter, r *http.Request)
 		})
 		return
 	}
-	httpapi.Write(ctx, rw, http.StatusNoContent, nil)
+	rw.WriteHeader(http.StatusNoContent)
 }
 
 // @Summary Get OAuth2 application secrets.
@@ -324,7 +324,7 @@ func (api *API) deleteOAuth2ProviderAppSecret(rw http.ResponseWriter, r *http.Re
 		})
 		return
 	}
-	httpapi.Write(ctx, rw, http.StatusNoContent, nil)
+	rw.WriteHeader(http.StatusNoContent)
 }
 
 // @Summary OAuth2 authorization request.
diff --git a/coderd/templates.go b/coderd/templates.go
@@ -791,7 +791,7 @@ func (api *API) patchTemplateMeta(rw http.ResponseWriter, r *http.Request) {
 
 	if updated.UpdatedAt.IsZero() {
 		aReq.New = template
-		httpapi.Write(ctx, rw, http.StatusNotModified, nil)
+		rw.WriteHeader(http.StatusNotModified)
 		return
 	}
 	aReq.New = updated
diff --git a/coderd/users.go b/coderd/users.go
@@ -501,10 +501,9 @@ func (api *API) postUser(rw http.ResponseWriter, r *http.Request) {
 // @Summary Delete user
 // @ID delete-user
 // @Security CoderSessionToken
-// @Produce json
 // @Tags Users
 // @Param user path string true "User ID, name, or me"
-// @Success 200 {object} codersdk.User
+// @Success 204
 // @Router /users/{user} [delete]
 func (api *API) deleteUser(rw http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
@@ -558,9 +557,7 @@ func (api *API) deleteUser(rw http.ResponseWriter, r *http.Request) {
 	}
 	user.Deleted = true
 	aReq.New = user
-	httpapi.Write(ctx, rw, http.StatusOK, codersdk.Response{
-		Message: "User has been deleted!",
-	})
+	rw.WriteHeader(http.StatusNoContent)
 }
 
 // Returns the parameterized user requested. All validation
@@ -1013,7 +1010,7 @@ func (api *API) putUserPassword(rw http.ResponseWriter, r *http.Request) {
 	newUser.HashedPassword = []byte(hashedPassword)
 	aReq.New = newUser
 
-	httpapi.Write(ctx, rw, http.StatusNoContent, nil)
+	rw.WriteHeader(http.StatusNoContent)
 }
 
 // @Summary Get user roles
diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -927,9 +927,7 @@ func (api *API) putWorkspaceDormant(rw http.ResponseWriter, r *http.Request) {
 
 	// If the workspace is already in the desired state do nothing!
 	if workspace.DormantAt.Valid == req.Dormant {
-		httpapi.Write(ctx, rw, http.StatusNotModified, codersdk.Response{
-			Message: "Nothing to do!",
-		})
+		rw.WriteHeader(http.StatusNotModified)
 		return
 	}
 
diff --git a/codersdk/users.go b/codersdk/users.go
@@ -308,7 +308,7 @@ func (c *Client) DeleteUser(ctx context.Context, id uuid.UUID) error {
 		return err
 	}
 	defer res.Body.Close()
-	if res.StatusCode != http.StatusOK {
+	if res.StatusCode != http.StatusNoContent {
 		return ReadBodyAsError(res)
 	}
 	return nil
diff --git a/docs/api/users.md b/docs/api/users.md

Original file line number	Diff line number	Diff line change
`@@ -333,7 +333,7 @@ func (api API) deleteAPIKey(rw http.ResponseWriter, r http.Request) {`
`333`	`333`	`return`
`334`	`334`	`}`
`335`	`335`
`336`		`- httpapi.Write(ctx, rw, http.StatusNoContent, nil)`
	`336`	`+ rw.WriteHeader(http.StatusNoContent)`
`337`	`337`	`}`
`338`	`338`
`339`	`339`	`// @Summary Get token config`
Original file line number	Diff line number	Diff line change
`@@ -235,7 +235,7 @@ func (api API) putDeploymentHealthSettings(rw http.ResponseWriter, r http.Requ`
`235`	`235`
`236`	`236`	`if bytes.Equal(settingsJSON, []byte(currentSettingsJSON)) {`
`237`	`237`	`// See: https://www.rfc-editor.org/rfc/rfc7231#section-6.3.5`
`238`		`- httpapi.Write(r.Context(), rw, http.StatusNoContent, nil)`
	`238`	`+ rw.WriteHeader(http.StatusNoContent)`
`239`	`239`	`return`
`240`	`240`	`}`
`241`	`241`
Original file line number	Diff line number	Diff line change
`@@ -197,7 +197,7 @@ func (api API) postExternalAuthDeviceByID(rw http.ResponseWriter, r http.Reque`
`197`	`197`	`return`
`198`	`198`	`}`
`199`	`199`	`}`
`200`		`- httpapi.Write(ctx, rw, http.StatusNoContent, nil)`
	`200`	`+ rw.WriteHeader(http.StatusNoContent)`
`201`	`201`	`}`
`202`	`202`
`203`	`203`	`// @Summary Get external auth device by ID.`
Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,6 @@ func RevokeApp(db database.Store) http.HandlerFunc {`
`39`	`39`	`httpapi.InternalServerError(rw, err)`
`40`	`40`	`return`
`41`	`41`	`}`
`42`		`- httpapi.Write(ctx, rw, http.StatusNoContent, nil)`
	`42`	`+ rw.WriteHeader(http.StatusNoContent)`
`43`	`43`	`}`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -207,7 +207,7 @@ func (api API) deleteOAuth2ProviderApp(rw http.ResponseWriter, r http.Request)`
`207`	`207`	`})`
`208`	`208`	`return`
`209`	`209`	`}`
`210`		`- httpapi.Write(ctx, rw, http.StatusNoContent, nil)`
	`210`	`+ rw.WriteHeader(http.StatusNoContent)`
`211`	`211`	`}`
`212`	`212`
`213`	`213`	`// @Summary Get OAuth2 application secrets.`
`@@ -324,7 +324,7 @@ func (api API) deleteOAuth2ProviderAppSecret(rw http.ResponseWriter, r http.Re`
`324`	`324`	`})`
`325`	`325`	`return`
`326`	`326`	`}`
`327`		`- httpapi.Write(ctx, rw, http.StatusNoContent, nil)`
	`327`	`+ rw.WriteHeader(http.StatusNoContent)`
`328`	`328`	`}`
`329`	`329`
`330`	`330`	`// @Summary OAuth2 authorization request.`
Original file line number	Diff line number	Diff line change
`@@ -791,7 +791,7 @@ func (api API) patchTemplateMeta(rw http.ResponseWriter, r http.Request) {`
`791`	`791`
`792`	`792`	`if updated.UpdatedAt.IsZero() {`
`793`	`793`	`aReq.New = template`
`794`		`- httpapi.Write(ctx, rw, http.StatusNotModified, nil)`
	`794`	`+ rw.WriteHeader(http.StatusNotModified)`
`795`	`795`	`return`
`796`	`796`	`}`
`797`	`797`	`aReq.New = updated`
Original file line number	Diff line number	Diff line change
`@@ -927,9 +927,7 @@ func (api API) putWorkspaceDormant(rw http.ResponseWriter, r http.Request) {`
`927`	`927`
`928`	`928`	`// If the workspace is already in the desired state do nothing!`
`929`	`929`	`if workspace.DormantAt.Valid == req.Dormant {`
`930`		`- httpapi.Write(ctx, rw, http.StatusNotModified, codersdk.Response{`
`931`		`- Message: "Nothing to do!",`
`932`		`- })`
	`930`	`+ rw.WriteHeader(http.StatusNotModified)`
`933`	`931`	`return`
`934`	`932`	`}`
`935`	`933`