docs: add 503 status code row to EmailVerificationHandler status table#160
Merged
veverkap merged 1 commit intoApr 29, 2026
Merged
Conversation
SendVerification returns HTTP 503 when SendEmail is nil, but this case was missing from the HTTP status codes table in the docs. Added the row to match the behaviour documented in prose and match the pattern used by MagicLinkHandler, PasskeyHandler, and PasswordResetHandler. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the EmailVerificationHandler documentation to accurately reflect existing runtime behavior when email delivery is not configured, keeping the HTTP status code table consistent with the prose and with other similar handlers.
Changes:
- Add a missing
503 Service Unavailablerow forSendVerificationwhenSendEmailisnilin the HTTP status codes table.
Show a summary per file
| File | Description |
|---|---|
| docs/handler/email-verification.md | Adds the missing 503/misconfiguration case to the endpoint status table for SendVerification. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
SendVerificationreturns HTTP 503 whenSendEmailisnil(misconfiguration), but this case was missing from the HTTP status codes table indocs/handler/email-verification.md.The behavior was already documented in the configuration-section prose:
...but the status-table at the bottom of the page was inconsistent with the prose and with every other handler that has the same pattern:
MagicLinkHandlerPasskeyHandlerPasswordResetHandlerEmailVerificationHandlerChange
Added one row to the
## HTTP status codestable:No code changes — documentation only.
Greptile Summary
This documentation-only PR adds the missing
503 Service Unavailablerow forSendVerificationto the HTTP status codes table indocs/handler/email-verification.md. The added row is accurate and consistent with both the existing configuration prose and the implementation inhandler/email_verification.go(lines 67–68), and it bringsEmailVerificationHandlerin line with the other handlers that document this same nil-sender pattern.Confidence Score: 5/5
Safe to merge — documentation-only change that accurately reflects existing behavior.
Single-file docs change; the added row matches the implementation (HTTP 503 on nil SendEmail), the existing prose, and the pattern in sibling handler docs. No code is modified.
No files require special attention.
Important Files Changed
Sequence Diagram
sequenceDiagram participant Client participant SendVerification participant Store Client->>SendVerification: POST /verify-email/send {email} alt SendEmail is nil SendVerification-->>Client: 503 Service Unavailable else Missing email field SendVerification-->>Client: 400 Bad Request else Valid request SendVerification->>Store: LookupUser(email) Store-->>SendVerification: user (or not found) SendVerification->>Store: CreateEmailVerification(token) Store-->>SendVerification: ok SendVerification-->>Client: 200 OK endReviews (1): Last reviewed commit: "docs: add 503 status code row to EmailVe..." | Re-trigger Greptile