Skip to content

docs: add 503 status code row to EmailVerificationHandler status table#160

Merged
veverkap merged 1 commit into
mainfrom
docs/email-verification-503-status-table-e14f3bfa15e6bbc5
Apr 29, 2026
Merged

docs: add 503 status code row to EmailVerificationHandler status table#160
veverkap merged 1 commit into
mainfrom
docs/email-verification-503-status-table-e14f3bfa15e6bbc5

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented Apr 28, 2026

Summary

SendVerification returns HTTP 503 when SendEmail is nil (misconfiguration), but this case was missing from the HTTP status codes table in docs/handler/email-verification.md.

The behavior was already documented in the configuration-section prose:

When SendEmail is nil, SendVerification returns HTTP 503 before any database write...

...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:

Handler 503 in table?
MagicLinkHandler
PasskeyHandler
PasswordResetHandler
EmailVerificationHandler ❌ → this PR

Change

Added one row to the ## HTTP status codes table:

| `SendVerification` | 503 Service Unavailable | `SendEmail` is `nil` (not configured) |

No code changes — documentation only.

Generated by Update Docs · ● 753.7K ·

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/update-docs.md@96b9d4c39aa22359c0b38265927eadb31dcf4e2a

Greptile Summary

This documentation-only PR adds the missing 503 Service Unavailable row for SendVerification to the HTTP status codes table in docs/handler/email-verification.md. The added row is accurate and consistent with both the existing configuration prose and the implementation in handler/email_verification.go (lines 67–68), and it brings EmailVerificationHandler in 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

Filename Overview
docs/handler/email-verification.md Adds a missing 503 row to the HTTP status codes table, consistent with the existing prose and the implementation in handler/email_verification.go.

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
    end
Loading

Reviews (1): Last reviewed commit: "docs: add 503 status code row to EmailVe..." | Re-trigger Greptile

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>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Apr 28, 2026
@veverkap veverkap marked this pull request as ready for review April 29, 2026 12:16
@veverkap veverkap requested review from a team and Copilot April 29, 2026 12:16
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Unavailable row for SendVerification when SendEmail is nil in 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

@veverkap veverkap merged commit ce65b2a into main Apr 29, 2026
8 checks passed
@veverkap veverkap deleted the docs/email-verification-503-status-table-e14f3bfa15e6bbc5 branch April 29, 2026 12:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants