From 958414dd49a393e2c103c4e537e91d313c34e472 Mon Sep 17 00:00:00 2001 From: David Buchmann Date: Tue, 8 Jan 2019 08:57:22 +0100 Subject: [PATCH] more verbose documentation on authentication --- src/Authentication.php | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/src/Authentication.php b/src/Authentication.php index b50366f..0fe0cb3 100644 --- a/src/Authentication.php +++ b/src/Authentication.php @@ -5,18 +5,21 @@ use Psr\Http\Message\RequestInterface; /** - * Authenticate a PSR-7 Request. + * Add authentication information to a PSR-7 Request. * * @author Márk Sági-Kazár */ interface Authentication { /** - * Authenticates a request. + * Alter the request to add the authentication credentials. * - * @param RequestInterface $request + * To do that, the implementation might use pre-stored credentials or do + * separate HTTP requests to obtain a valid token. * - * @return RequestInterface + * @param RequestInterface $request The request without authentication information + * + * @return RequestInterface The request with added authentication information */ public function authenticate(RequestInterface $request); }