docs: update auth placeholder comment

This commit is contained in:
Zen Dodd 2026-05-03 13:32:54 +10:00
parent c87accc9d7
commit c67c8a2023
No known key found for this signature in database
GPG key ID: 6909546B2C52EC2D

View file

@ -32,10 +32,10 @@ func init() {
// Authentication is a middleware which provides user authentication.
// Rejects requests with HTTP 401 if the request is not authenticated.
//
// After a successful authentication, the placeholder
// When an authentication provider returns user information, the placeholder
// `{http.auth.user.id}` will be set to the username, and also
// `{http.auth.user.*}` placeholders may be set for any authentication
// modules that provide user metadata.
// modules that provide user metadata, even if authentication is rejected.
//
// In case of an error, the placeholder `{http.auth.<provider>.error}`
// will be set to the error message returned by the authentication