@@ -57,6 +57,17 @@ withServantServerAndContext api ctx server t
5757-- Evidently, if the behaviour of the server is expected to be
5858-- non-deterministic, this function may produce spurious failures
5959--
60+-- Note that only valid requests are generated and tested. As an example of why
61+-- this matters, let's say your API specifies that a particular endpoint can
62+-- only generate @JSON@. @serversEqual@ will then not generate any requests
63+-- with an @Accept@ header _other_ than @application/json@. It may therefore
64+-- fail to notice that one application, when the request has @Accept:
65+-- text/html@, returns a @406 Not Acceptable@ HTTP response, and another
66+-- returns a @200 Success@, but with @application/json@ as the content-type.
67+--
68+-- The fact that only valid requests are tested also means that no endpoints
69+-- not listed in the API type are tested.
70+--
6071-- /Since 0.0.0.0/
6172serversEqual :: HasGenRequest a =>
6273 Proxy a -> BaseUrl -> BaseUrl -> Args -> ResponseEquality LBS.ByteString -> Expectation