Skip to content

Commit e57e370

Browse files
committed
Bump v3 API docs version release-candidate
1 parent c8cc3d6 commit e57e370

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

version/release-candidate/index.html

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -561,6 +561,12 @@ <h3 id="common-errors">Common errors</h3>
561561
<td>Catch-all error when an operation fails to complete; the <code class="prettyprint">detail</code> field will contain more information</td>
562562
</tr>
563563
<tr>
564+
<td><code class="prettyprint">CF-UaaRateLimited</code></td>
565+
<td>20008</td>
566+
<td>429</td>
567+
<td>Too many requests were made to the UAA instance. The request can be retried after the period stated in the <code class="prettyprint">Retry-After</code> header</td>
568+
</tr>
569+
<tr>
564570
<td><code class="prettyprint">UnknownError</code></td>
565571
<td>10001</td>
566572
<td>500</td>
@@ -6288,7 +6294,7 @@ <h2 id="deployments">Deployments</h2>
62886294
<li><p><a href="https://docs.cloudfoundry.org/devguide/deploy-apps/rolling-deploy.html">Rolling deployments</a> allows for
62896295
applications to be deployed without incurring downtime by gradually rolling out instances. Max-in-flight can be configured
62906296
to specify how many instances are rolled out simultaneously.</p></li>
6291-
<li><p>Canary deployments deploy a single instance and pause for user evaluation. If the canary instance is deemed successful, the deployment can be resumed via the <a href="#continue-a-deployment">continue action</a>. The deployment then continues like a rolling deployment. This feature is experimental and is subject to change.</p></li>
6297+
<li><p><a href="https://docs.cloudfoundry.org/devguide/deploy-apps/rolling-deploy.html#canary-deployment-process">Canary deployments</a> deploy a single instance and pause for user evaluation. If the canary instance is deemed successful, the deployment can be resumed via the <a href="#continue-a-deployment">continue action</a>. The deployment then continues like a rolling deployment. This feature is experimental and is subject to change.</p></li>
62926298
</ul>
62936299
<h3 id="the-deployment-object">The deployment object</h3>
62946300
<div class="highlight"><pre class="highlight plaintext"><code>Example Deployment object
@@ -6299,7 +6305,8 @@ <h3 id="the-deployment-object">The deployment object</h3>
62996305
</span><span class="nl">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ACTIVE"</span><span class="p">,</span><span class="w">
63006306
</span><span class="nl">"reason"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DEPLOYING"</span><span class="p">,</span><span class="w">
63016307
</span><span class="nl">"details"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
6302-
</span><span class="nl">"last_successful_healthcheck"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-04-25T22:42:10Z"</span><span class="w">
6308+
</span><span class="nl">"last_successful_healthcheck"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-04-25T22:42:10Z"</span><span class="p">,</span><span class="w">
6309+
</span><span class="nl">"last_status_change"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-04-25T22:42:10Z"</span><span class="w">
63036310
</span><span class="p">}</span><span class="w">
63046311
</span><span class="p">},</span><span class="w">
63056312
</span><span class="nl">"strategy"</span><span class="p">:</span><span class="w"> </span><span class="s2">"canary"</span><span class="p">,</span><span class="w">
@@ -6495,7 +6502,8 @@ <h3 id="create-a-deployment">Create a deployment</h3>
64956502
</span><span class="nl">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ACTIVE"</span><span class="p">,</span><span class="w">
64966503
</span><span class="nl">"reason"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DEPLOYING"</span><span class="p">,</span><span class="w">
64976504
</span><span class="nl">"details"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
6498-
</span><span class="nl">"last_successful_healthcheck"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-04-25T22:42:10Z"</span><span class="w">
6505+
</span><span class="nl">"last_successful_healthcheck"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-04-25T22:42:10Z"</span><span class="p">,</span><span class="w">
6506+
</span><span class="nl">"last_status_change"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-04-25T22:42:10Z"</span><span class="w">
64996507
</span><span class="p">}</span><span class="w">
65006508
</span><span class="p">},</span><span class="w">
65016509
</span><span class="nl">"strategy"</span><span class="p">:</span><span class="w"> </span><span class="s2">"canary"</span><span class="p">,</span><span class="w">
@@ -6655,7 +6663,8 @@ <h3 id="get-a-deployment">Get a deployment</h3>
66556663
</span><span class="nl">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ACTIVE"</span><span class="p">,</span><span class="w">
66566664
</span><span class="nl">"reason"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DEPLOYING"</span><span class="p">,</span><span class="w">
66576665
</span><span class="nl">"details"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
6658-
</span><span class="nl">"last_successful_healthcheck"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-04-25T22:42:10Z"</span><span class="w">
6666+
</span><span class="nl">"last_successful_healthcheck"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-04-25T22:42:10Z"</span><span class="p">,</span><span class="w">
6667+
</span><span class="nl">"last_status_change"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-04-25T22:42:10Z"</span><span class="w">
66596668
</span><span class="p">}</span><span class="w">
66606669
</span><span class="p">},</span><span class="w">
66616670
</span><span class="nl">"strategy"</span><span class="p">:</span><span class="w"> </span><span class="s2">"canary"</span><span class="p">,</span><span class="w">
@@ -6773,7 +6782,11 @@ <h3 id="list-deployments">List deployments</h3>
67736782
</span><span class="nl">"guid"</span><span class="p">:</span><span class="w"> </span><span class="s2">"59c3d133-2b83-46f3-960e-7765a129aea4"</span><span class="p">,</span><span class="w">
67746783
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
67756784
</span><span class="nl">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"FINALIZED"</span><span class="p">,</span><span class="w">
6776-
</span><span class="nl">"reason"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DEPLOYED"</span><span class="w">
6785+
</span><span class="nl">"reason"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DEPLOYED"</span><span class="p">,</span><span class="w">
6786+
</span><span class="nl">"details"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
6787+
</span><span class="nl">"last_successful_healthcheck"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-04-25T22:42:10Z"</span><span class="p">,</span><span class="w">
6788+
</span><span class="nl">"last_status_change"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-04-25T22:42:10Z"</span><span class="w">
6789+
</span><span class="p">}</span><span class="w">
67776790
</span><span class="p">},</span><span class="w">
67786791
</span><span class="nl">"strategy"</span><span class="p">:</span><span class="w"> </span><span class="s2">"rolling"</span><span class="p">,</span><span class="w">
67796792
</span><span class="nl">"options"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
@@ -6918,7 +6931,8 @@ <h3 id="update-a-deployment">Update a deployment</h3>
69186931
</span><span class="nl">"value"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ACTIVE"</span><span class="p">,</span><span class="w">
69196932
</span><span class="nl">"reason"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DEPLOYING"</span><span class="p">,</span><span class="w">
69206933
</span><span class="nl">"details"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
6921-
</span><span class="nl">"last_successful_healthcheck"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-04-25T22:42:10Z"</span><span class="w">
6934+
</span><span class="nl">"last_successful_healthcheck"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-04-25T22:42:10Z"</span><span class="p">,</span><span class="w">
6935+
</span><span class="nl">"last_status_change"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-04-25T22:42:10Z"</span><span class="w">
69226936
</span><span class="p">}</span><span class="w">
69236937
</span><span class="p">},</span><span class="w">
69246938
</span><span class="nl">"strategy"</span><span class="p">:</span><span class="w"> </span><span class="s2">"canary"</span><span class="p">,</span><span class="w">
@@ -17843,7 +17857,7 @@ <h3 id="the-route-options-object">The route options object</h3>
1784317857
<tr>
1784417858
<td><strong>loadbalancing</strong></td>
1784517859
<td><em>string</em></td>
17846-
<td>The load-balancer associated with this route. Valid values are &lsquo;round-robin&rsquo; and &lsquo;least-connections&rsquo;</td>
17860+
<td>The load-balancer associated with this route. Valid values are &lsquo;round-robin&rsquo; and &lsquo;least-connection&rsquo;</td>
1784717861
</tr>
1784817862
</tbody></table>
1784917863
<h3 id="create-a-route">Create a route</h3>

0 commit comments

Comments
 (0)