Skip to content

Commit 90da7ee

Browse files
authored
Add JavaDoc for health-check request handling
Added JavaDoc comment for the doGet method in HealthServlet.
1 parent 4316376 commit 90da7ee

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

src/main/java/me/nickhanson/codeforge/web/HealthServlet.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@
1515
@WebServlet(urlPatterns = {"/health"})
1616
public class HealthServlet extends HttpServlet {
1717

18+
/**
19+
* Handles health-check requests by returning an immediate {@code 200 OK}
20+
* response with a plain-text {@code OK} body.
21+
*
22+
* @param req the incoming HTTP request
23+
* @param resp the HTTP response used to return health status
24+
* @throws IOException if writing the response fails
25+
*/
1826
@Override
1927
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
2028
resp.setStatus(HttpServletResponse.SC_OK);

0 commit comments

Comments
 (0)