Skip to content

Commit

Permalink
docs: improve HttpClientInterface descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
tyiuhc committed Jan 11, 2024
1 parent 942bccf commit 24dd6bf
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/Http/HttpClientInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
/**
Expand All @@ -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;
}

0 comments on commit 24dd6bf

Please sign in to comment.