split out the body stuff into a different branch

coder · aslilac · Jul 16, 2024 · Jul 8, 2024 · Jul 8, 2024 · Jul 8, 2024
commit 608ea6972502f546d1b41602ab47f70526c541e3
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
 	}
 
-	rw.WriteHeader(http.StatusNoContent)
+	httpapi.Write(ctx, rw, http.StatusNoContent, nil)
 }
 
 // @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
-		rw.WriteHeader(http.StatusNoContent)
+		httpapi.Write(r.Context(), rw, http.StatusNoContent, nil)
 		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
 		}
 	}
-	rw.WriteHeader(http.StatusNoContent)
+	httpapi.Write(ctx, rw, http.StatusNoContent, nil)
 }
 
 // @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
 		}
-		rw.WriteHeader(http.StatusNoContent)
+		httpapi.Write(ctx, rw, http.StatusNoContent, nil)
 	}
 }
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
 	}
-	rw.WriteHeader(http.StatusNoContent)
+	httpapi.Write(ctx, rw, http.StatusNoContent, nil)
 }
 
 // @Summary Get OAuth2 application secrets.
@@ -324,7 +324,7 @@ func (api *API) deleteOAuth2ProviderAppSecret(rw http.ResponseWriter, r *http.Re
 		})
 		return
 	}
-	rw.WriteHeader(http.StatusNoContent)
+	httpapi.Write(ctx, rw, http.StatusNoContent, nil)
 }
 
 // @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
-		rw.WriteHeader(http.StatusNotModified)
+		httpapi.Write(ctx, rw, http.StatusNotModified, nil)
 		return
 	}
 	aReq.New = updated

diff --git a/coderd/users.go b/coderd/users.go
@@ -504,7 +504,7 @@ func (api *API) postUser(rw http.ResponseWriter, r *http.Request) {
 // @Produce json
 // @Tags Users
 // @Param user path string true "User ID, name, or me"
-// @Success 204
+// @Success 200 {object} codersdk.User
 // @Router /users/{user} [delete]
 func (api *API) deleteUser(rw http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
@@ -558,7 +558,9 @@ func (api *API) deleteUser(rw http.ResponseWriter, r *http.Request) {
 	}
 	user.Deleted = true
 	aReq.New = user
-	rw.WriteHeader(http.StatusNoContent)
+	httpapi.Write(ctx, rw, http.StatusOK, codersdk.Response{
+		Message: "User has been deleted!",
+	})
 }
 
 // Returns the parameterized user requested. All validation
@@ -1011,7 +1013,7 @@ func (api *API) putUserPassword(rw http.ResponseWriter, r *http.Request) {
 	newUser.HashedPassword = []byte(hashedPassword)
 	aReq.New = newUser
 
-	rw.WriteHeader(http.StatusNoContent)
+	httpapi.Write(ctx, rw, http.StatusNoContent, nil)
 }
 
 // @Summary Get user roles

diff --git a/coderd/workspaces.go b/coderd/workspaces.go
@@ -927,7 +927,9 @@ 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 {
-		rw.WriteHeader(http.StatusNotModified)
+		httpapi.Write(ctx, rw, http.StatusNotModified, codersdk.Response{
+			Message: "Nothing to do!",
+		})
 		return
 	}
 

diff --git a/docs/api/users.md b/docs/api/users.md
-Original file line number
+Diff line change
@@ Expand Up @@
     		return
     	}
-    	rw.WriteHeader(http.StatusNoContent)
+    	httpapi.Write(ctx, rw, http.StatusNoContent, nil)
     }
     // @Summary Get token config
@@ Expand Down @@