Update javadoc for stream() mentioning that the response content is not included in logging (as it is reactively being populated so can not be available at response logging time)

Author: rbygrave

client/src/main/java/io/avaje/http/client/HttpAsyncResponse.java

@@ -173,6 +173,14 @@ public interface HttpAsyncResponse {
   /**
    * Process response as a stream of beans (x-json-stream).
    * <p>
+   * Typically the response is expected to be {@literal application/x-json-stream}
+   * newline delimited json payload.
+   * <p>
+   * Note that for this stream request the response content is not deemed
+   * 'loggable' by avaje-http-client. This is because the entire response
+   * may not be available at the time of the callback. As such {@link RequestLogger}
+   * will not include response content in logging stream request/response.
+   * <p>
    * If the HTTP statusCode is 300 or above a HttpException is throw
    * which contains the HttpResponse. This is the cause in the
    * CompletionException.

client/src/main/java/io/avaje/http/client/HttpClientResponse.java

@@ -50,8 +50,13 @@ public interface HttpClientResponse {
   /**
    * Return the response as a stream of beans.
    * <p>
-   * Typically the response is expected to be {@literal applciation/x-json-stream}
+   * Typically the response is expected to be {@literal application/x-json-stream}
    * newline delimited json payload.
+   * <p>
+   * Note that for this stream request the response content is not deemed
+   * 'loggable' by avaje-http-client. This is because the entire response
+   * may not be available at the time of the callback. As such {@link RequestLogger}
+   * will not include response content when logging stream request/response
    *
    * @param type The type of the bean to convert the response content into.
    * @param <T>  The type that the content is converted to.