Mention AuthMiddleware requirement (http4s#256)

chuwy · Oct 29, 2018 · 945a4aa · 945a4aa
1 parent f67eed3
commit 945a4aa
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/core/src/main/scala/org/http4s/rho/AuthedContext.scala b/core/src/main/scala/org/http4s/rho/AuthedContext.scala
@@ -10,6 +10,8 @@ import org.http4s.rho.bits.{FailureResponseOps, SuccessResponse, TypedHeader}
 
 /** The [[AuthedContext]] provides a convenient way to define a RhoRoutes
   * which works with http4s authentication middleware.
+  * Please note that `AuthMiddleware`-wrapping is mandatory, otherwise context
+  * doesn't take effect.
   * {{{
   *     case class User(name: String, id: UUID)
   *
@@ -48,7 +50,7 @@ class AuthedContext[F[_]: Monad, U] extends FailureResponseOps[F] {
     }
   }
 
-  /** Get the authInfo object from request */
+  /** Get the authInfo object from request if `AuthMiddleware` provided one */
   def getAuth(req: Request[F]): Option[U] =
     req.attributes.get(authKey)