Skip to content

Commit 52c0cc6

Browse files
committed
Bump v3 API docs version release-candidate
1 parent 1046742 commit 52c0cc6

1 file changed

Lines changed: 26 additions & 1 deletion

File tree

version/release-candidate/index.html

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30073,6 +30073,7 @@ <h3 id="the-space-object">The space object</h3>
3007330073
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-02-01T01:33:58Z"</span><span class="p">,</span><span class="w">
3007430074
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-02-01T01:33:58Z"</span><span class="p">,</span><span class="w">
3007530075
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"my-space"</span><span class="p">,</span><span class="w">
30076+
</span><span class="nl">"suspended"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
3007630077
</span><span class="nl">"relationships"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
3007730078
</span><span class="nl">"organization"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
3007830079
</span><span class="nl">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
@@ -30133,6 +30134,11 @@ <h3 id="the-space-object">The space object</h3>
3013330134
<td>Name of the space</td>
3013430135
</tr>
3013530136
<tr>
30137+
<td><strong>suspended</strong></td>
30138+
<td><em>boolean</em></td>
30139+
<td>Whether a space is suspended or not; non-admins and non-org-managers will be blocked from creating, updating, or deleting resources in a suspended space</td>
30140+
</tr>
30141+
<tr>
3013630142
<td><strong>relationships.organization</strong></td>
3013730143
<td><a href="#to-one-relationships"><em>to-one relationship</em></a></td>
3013830144
<td>The organization the space is contained in</td>
@@ -30184,6 +30190,7 @@ <h3 id="create-a-space">Create a space</h3>
3018430190
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-02-01T01:33:58Z"</span><span class="p">,</span><span class="w">
3018530191
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-02-01T01:33:58Z"</span><span class="p">,</span><span class="w">
3018630192
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"my-space"</span><span class="p">,</span><span class="w">
30193+
</span><span class="nl">"suspended"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
3018730194
</span><span class="nl">"relationships"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
3018830195
</span><span class="nl">"organization"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
3018930196
</span><span class="nl">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
@@ -30251,6 +30258,11 @@ <h4 id="optional-parameters">Optional parameters</h4>
3025130258
</tr>
3025230259
</thead><tbody>
3025330260
<tr>
30261+
<td><strong>suspended</strong></td>
30262+
<td><em>boolean</em></td>
30263+
<td>Whether a space is suspended or not</td>
30264+
</tr>
30265+
<tr>
3025430266
<td><strong>metadata.labels</strong></td>
3025530267
<td><a href="#labels"><em>label object</em></a></td>
3025630268
<td>Labels applied to the space</td>
@@ -30290,6 +30302,7 @@ <h3 id="get-a-space">Get a space</h3>
3029030302
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-02-01T01:33:58Z"</span><span class="p">,</span><span class="w">
3029130303
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-02-01T01:33:58Z"</span><span class="p">,</span><span class="w">
3029230304
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"my-space"</span><span class="p">,</span><span class="w">
30305+
</span><span class="nl">"suspended"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
3029330306
</span><span class="nl">"relationships"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
3029430307
</span><span class="nl">"organization"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
3029530308
</span><span class="nl">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
@@ -30404,6 +30417,7 @@ <h3 id="list-spaces">List spaces</h3>
3040430417
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-02-01T01:33:58Z"</span><span class="p">,</span><span class="w">
3040530418
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-02-01T01:33:58Z"</span><span class="p">,</span><span class="w">
3040630419
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"space1"</span><span class="p">,</span><span class="w">
30420+
</span><span class="nl">"suspended"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
3040730421
</span><span class="nl">"relationships"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
3040830422
</span><span class="nl">"organization"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
3040930423
</span><span class="nl">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
@@ -30439,6 +30453,7 @@ <h3 id="list-spaces">List spaces</h3>
3043930453
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-02-02T00:14:30Z"</span><span class="p">,</span><span class="w">
3044030454
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-02-02T00:14:30Z"</span><span class="p">,</span><span class="w">
3044130455
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"space2"</span><span class="p">,</span><span class="w">
30456+
</span><span class="nl">"suspended"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
3044230457
</span><span class="nl">"relationships"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
3044330458
</span><span class="nl">"organization"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
3044430459
</span><span class="nl">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
@@ -30573,6 +30588,7 @@ <h3 id="update-a-space">Update a space</h3>
3057330588
</span><span class="nl">"created_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-02-01T01:33:58Z"</span><span class="p">,</span><span class="w">
3057430589
</span><span class="nl">"updated_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2017-02-01T01:33:58Z"</span><span class="p">,</span><span class="w">
3057530590
</span><span class="nl">"name"</span><span class="p">:</span><span class="w"> </span><span class="s2">"my-space"</span><span class="p">,</span><span class="w">
30591+
</span><span class="nl">"suspended"</span><span class="p">:</span><span class="w"> </span><span class="kc">false</span><span class="p">,</span><span class="w">
3057630592
</span><span class="nl">"relationships"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
3057730593
</span><span class="nl">"organization"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
3057830594
</span><span class="nl">"data"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
@@ -30624,6 +30640,11 @@ <h4 id="optional-parameters">Optional parameters</h4>
3062430640
<td>New space name</td>
3062530641
</tr>
3062630642
<tr>
30643+
<td><strong>suspended</strong></td>
30644+
<td><em>boolean</em></td>
30645+
<td>Whether a space is suspended or not</td>
30646+
</tr>
30647+
<tr>
3062730648
<td><strong>metadata.labels</strong></td>
3062830649
<td><a href="#labels"><em>label object</em></a></td>
3062930650
<td>Labels applied to the space</td>
@@ -30639,17 +30660,21 @@ <h4 id="permitted-roles">Permitted roles</h4>
3063930660

3064030661
<table><thead>
3064130662
<tr>
30642-
<th></th>
30663+
<th>Role</th>
30664+
<th>Notes</th>
3064330665
</tr>
3064430666
</thead><tbody>
3064530667
<tr>
3064630668
<td>Admin</td>
30669+
<td></td>
3064730670
</tr>
3064830671
<tr>
3064930672
<td>Org Manager</td>
30673+
<td></td>
3065030674
</tr>
3065130675
<tr>
3065230676
<td>Space Manager</td>
30677+
<td>Cannot change the <code class="prettyprint">suspended</code> field</td>
3065330678
</tr>
3065430679
</tbody></table>
3065530680
<h3 id="delete-a-space">Delete a space</h3>

0 commit comments

Comments
 (0)