fix: return http 204 on test notification (#16651)

mtojek · web-flow · commit fcc9b05d293d · 2025-02-21T13:54:29.000+01:00
This PR changes the API response for `/api/v2/notifications/test`
endpoint to HTTP 204 / No Content.
diff --git a/coderd/notifications.go b/coderd/notifications.go
@@ -210,7 +210,7 @@ func (api *API) postTestNotification(rw http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	httpapi.Write(ctx, rw, http.StatusOK, nil)
+	rw.WriteHeader(http.StatusNoContent)
 }
 
 // @Summary Get user notification preferences
diff --git a/codersdk/notifications.go b/codersdk/notifications.go
@@ -200,10 +200,9 @@ func (c *Client) PostTestNotification(ctx context.Context) error {
 	}
 	defer res.Body.Close()
 
-	if res.StatusCode != http.StatusOK {
+	if res.StatusCode != http.StatusNoContent {
 		return ReadBodyAsError(res)
 	}
-
 	return nil
 }
 

Original file line number	Diff line number	Diff line change
`@@ -210,7 +210,7 @@ func (api API) postTestNotification(rw http.ResponseWriter, r http.Request) {`
`210`	`210`	`return`
`211`	`211`	`}`
`212`	`212`
`213`		`- httpapi.Write(ctx, rw, http.StatusOK, nil)`
	`213`	`+ rw.WriteHeader(http.StatusNoContent)`
`214`	`214`	`}`
`215`	`215`
`216`	`216`	`// @Summary Get user notification preferences`
Original file line number	Diff line number	Diff line change
`@@ -200,10 +200,9 @@ func (c *Client) PostTestNotification(ctx context.Context) error {`
`200`	`200`	`}`
`201`	`201`	`defer res.Body.Close()`
`202`	`202`
`203`		`- if res.StatusCode != http.StatusOK {`
	`203`	`+ if res.StatusCode != http.StatusNoContent {`
`204`	`204`	`return ReadBodyAsError(res)`
`205`	`205`	`}`
`206`		`-`
`207`	`206`	`return nil`
`208`	`207`	`}`
`209`	`208`