Skip to content

Commit 6bcfa49

Browse files
committed
Bump v3 API docs version release-candidate
1 parent 901b3fb commit 6bcfa49

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

version/release-candidate/index.html

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6327,6 +6327,7 @@ <h3 id="the-deployment-object">The deployment object</h3>
63276327
</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">
63286328
</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">
63296329
</span><span class="nl">"max_in_flight"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w">
6330+
</span><span class="nl">"web_instances"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w">
63306331
</span><span class="nl">"canary"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
63316332
</span><span class="nl">"steps"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
63326333
</span><span class="p">{</span><span class="w">
@@ -6449,6 +6450,11 @@ <h3 id="the-deployment-object">The deployment object</h3>
64496450
<td>The maximum number of new instances to deploy simultaneously</td>
64506451
</tr>
64516452
<tr>
6453+
<td><strong>options.web_instances</strong></td>
6454+
<td><em>integer</em></td>
6455+
<td>The number of web instances the deployment will scale to</td>
6456+
</tr>
6457+
<tr>
64526458
<td><strong>options.canary.steps</strong></td>
64536459
<td><em>array of <a href="#canary-steps-object">canary step objects</a></em></td>
64546460
<td>Canary steps to use for the deployment. Only available for deployments with strategy &lsquo;canary&rsquo;. (experimental)</td>
@@ -6559,6 +6565,7 @@ <h3 id="create-a-deployment">Create a deployment</h3>
65596565
</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">
65606566
</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">
65616567
</span><span class="nl">"max_in_flight"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w">
6568+
</span><span class="nl">"web_instances"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w">
65626569
</span><span class="nl">"canary"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
65636570
</span><span class="nl">"steps"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
65646571
</span><span class="p">{</span><span class="w">
@@ -6675,6 +6682,12 @@ <h4 id="optional-parameters">Optional parameters</h4>
66756682
<td>1</td>
66766683
</tr>
66776684
<tr>
6685+
<td><strong>options.web_instances</strong></td>
6686+
<td><em>integer</em></td>
6687+
<td>The number of web instances the deployment will scale to</td>
6688+
<td>The current web process&rsquo;s instance count</td>
6689+
</tr>
6690+
<tr>
66786691
<td><strong>options.canary.steps</strong></td>
66796692
<td><em>array of <a href="#canary-steps-object">canary step objects</a></em></td>
66806693
<td>An array of canary steps to use for the deployment</td>
@@ -6742,6 +6755,7 @@ <h3 id="get-a-deployment">Get a deployment</h3>
67426755
</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">
67436756
</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">
67446757
</span><span class="nl">"max_in_flight"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w">
6758+
</span><span class="nl">"web_instances"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w">
67456759
</span><span class="nl">"canary"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
67466760
</span><span class="nl">"steps"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
67476761
</span><span class="p">{</span><span class="w">
@@ -7026,6 +7040,7 @@ <h3 id="update-a-deployment">Update a deployment</h3>
70267040
</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">
70277041
</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">
70287042
</span><span class="nl">"max_in_flight"</span><span class="p">:</span><span class="w"> </span><span class="mi">3</span><span class="p">,</span><span class="w">
7043+
</span><span class="nl">"web_instances"</span><span class="p">:</span><span class="w"> </span><span class="mi">5</span><span class="p">,</span><span class="w">
70297044
</span><span class="nl">"canary"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
70307045
</span><span class="nl">"steps"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
70317046
</span><span class="p">{</span><span class="w">

0 commit comments

Comments
 (0)