Update javadoc

commercetools · Oct 25, 2023 · 14b34fc · 14b34fc
1 parent 1b50957
commit 14b34fc
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 4 deletions.
diff --git a/javadoc/allclasses-index.html b/javadoc/allclasses-index.html
@@ -30303,7 +30303,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
 </div>
 <div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="io/vrap/rmf/base/client/http/RetryRequestMiddleware.html" title="interface in io.vrap.rmf.base.client.http">RetryRequestMiddleware</a></div>
 <div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
-<div class="block">Middleware for retrying of a requests upon configured response status codes and/or exceptions</div>
+<div class="block">Retry failed requests</div>
 </div>
 <div class="col-first even-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/api/models/order/ReturnInfo.html" title="interface in com.commercetools.api.models.order">ReturnInfo</a></div>
 <div class="col-last even-row-color all-classes-table all-classes-table-tab1">

diff --git a/javadoc/index-files/index-18.html b/javadoc/index-files/index-18.html
@@ -10173,7 +10173,7 @@ <h2 class="title" id="I:R">R</h2>
 </dd>
 <dt><a href="../io/vrap/rmf/base/client/http/RetryRequestMiddleware.html" class="type-name-link" title="interface in io.vrap.rmf.base.client.http">RetryRequestMiddleware</a> - Interface in <a href="../io/vrap/rmf/base/client/http/package-summary.html">io.vrap.rmf.base.client.http</a></dt>
 <dd>
-<div class="block">Middleware for retrying of a requests upon configured response status codes and/or exceptions</div>
+<div class="block">Retry failed requests</div>
 </dd>
 <dt><a href="../com/commercetools/api/models/state/StateRoleEnum.StateRoleEnumEnum.html#RETURN" class="member-name-link">RETURN</a> - Enum constant in enum com.commercetools.api.models.state.<a href="../com/commercetools/api/models/state/StateRoleEnum.StateRoleEnumEnum.html" title="enum in com.commercetools.api.models.state">StateRoleEnum.StateRoleEnumEnum</a></dt>
 <dd>

diff --git a/javadoc/io/vrap/rmf/base/client/http/RetryRequestMiddleware.html b/javadoc/io/vrap/rmf/base/client/http/RetryRequestMiddleware.html
@@ -78,7 +78,27 @@ <h1 title="Interface RetryRequestMiddleware" class="title">Interface RetryReques
 <hr>
 <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">RetryRequestMiddleware</span><span class="extends-implements">
 extends <a href="Middleware.html" title="interface in io.vrap.rmf.base.client.http">Middleware</a></span></div>
-<div class="block">Middleware for retrying of a requests upon configured response status codes and/or exceptions</div>
+<div class="block"><h2>Retry failed requests</h2>
+
+ <p>Middleware for retrying of a requests upon configured response status codes and/or exceptions</p>
+
+ <h3>Retrying on HTTP status codes</h3>
+
+ <p><pre><code class='java'><code>
+    ApiRootBuilder.of()
+      ...
+      .withRetryMiddleware(3, Arrays.asList(HttpStatusCode.SERVICE_UNAVAILABLE_503, HttpStatusCode.INTERNAL_SERVER_ERROR_500))
+  </code></code></pre>
+  </p>
+
+ <h3>Retrying specific exceptions</h3>
+
+ <p><pre><code class='java'><code>
+    ApiRootBuilder.of()
+      ...
+      .addMiddleware(RetryRequestMiddleware.of(3, emptyList(), singletonList(JsonException.class)))
+  </code></code></pre>
+  </p></div>
 </section>
 <section class="summary">
 <ul class="summary-list">

diff --git a/javadoc/io/vrap/rmf/base/client/http/package-summary.html b/javadoc/io/vrap/rmf/base/client/http/package-summary.html
@@ -163,7 +163,7 @@ <h1 title="Package io.vrap.rmf.base.client.http" class="title">Package io.vrap.r
 </div>
 <div class="col-first odd-row-color class-summary class-summary-tab1"><a href="RetryRequestMiddleware.html" title="interface in io.vrap.rmf.base.client.http">RetryRequestMiddleware</a></div>
 <div class="col-last odd-row-color class-summary class-summary-tab1">
-<div class="block">Middleware for retrying of a requests upon configured response status codes and/or exceptions</div>
+<div class="block">Retry failed requests</div>
 </div>
 <div class="col-first even-row-color class-summary class-summary-tab1"><a href="TelemetryMiddleware.html" title="interface in io.vrap.rmf.base.client.http">TelemetryMiddleware</a></div>
 <div class="col-last even-row-color class-summary class-summary-tab1">&nbsp;</div>