From 24dd6bf371047d28987e213457fc95b46b10583a Mon Sep 17 00:00:00 2001 From: tyiuhc Date: Thu, 11 Jan 2024 13:22:40 -0800 Subject: [PATCH] docs: improve HttpClientInterface descriptions --- src/Http/HttpClientInterface.php | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/Http/HttpClientInterface.php b/src/Http/HttpClientInterface.php index 50de325..f378dad 100644 --- a/src/Http/HttpClientInterface.php +++ b/src/Http/HttpClientInterface.php @@ -2,10 +2,12 @@ namespace AmplitudeExperiment\Http; - use Psr\Http\Client\ClientInterface; use Psr\Http\Message\RequestInterface; +/** + * Interface for the HTTP clients set in {@link RemoteEvaluationConfig} and {@link LocalEvaluationConfig}. + */ interface HttpClientInterface { /** @@ -14,6 +16,9 @@ interface HttpClientInterface public function getClient(): ClientInterface; /** * Return a PSR Request to be sent by the underlying PSR HTTP Client + * @param string $method The HTTP method to use + * @param string $uri The URI to send the request to + * @param string|null $body The body of the request */ public function createRequest(string $method, string $uri, ?string $body = null) : RequestInterface; }