Skip to content

Commit b0250c5

Browse files
committed
ci: Generate docs
1 parent 7e88485 commit b0250c5

2 files changed

Lines changed: 83 additions & 1 deletion

File tree

docs/api/_report.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
- `/noise_sensors/noise_thresholds`
2323
- `/noise_sensors/simulate`
2424
- `/webhooks`
25-
- `/workspaces`
2625

2726
### Endpoints
2827

docs/api/workspaces/README.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Workspaces
2+
3+
## `workspace`
4+
5+
### `company_name`
6+
7+
Format: `String`
8+
9+
---
10+
11+
### `connect_partner_name`
12+
13+
{% hint style="warning" %}
14+
**Deprecated**. use company_name
15+
{% endhint %}
16+
17+
Format: `String`
18+
19+
---
20+
21+
### `connect_webview_customization`
22+
23+
Format: `Object`
24+
25+
<details>
26+
27+
<summary><code>inviter_logo_url</code> Format: <code>String</code></summary>
28+
</details>
29+
30+
<details>
31+
32+
<summary><code>logo_shape</code> Format: <code>Enum</code></summary>
33+
34+
Possible enum values:
35+
- `circle`
36+
- `square`
37+
</details>
38+
39+
<details>
40+
41+
<summary><code>primary_button_color</code> Format: <code>String</code></summary>
42+
</details>
43+
44+
<details>
45+
46+
<summary><code>primary_button_text_color</code> Format: <code>String</code></summary>
47+
</details>
48+
49+
<details>
50+
51+
<summary><code>success_message</code> Format: <code>String</code></summary>
52+
</details>
53+
54+
---
55+
56+
### `is_sandbox`
57+
58+
Format: `Boolean`
59+
60+
---
61+
62+
### `is_suspended`
63+
64+
Format: `Boolean`
65+
66+
True if a sandbox workspace has not been accessed in 14 days
67+
68+
---
69+
70+
### `name`
71+
72+
Format: `String`
73+
74+
---
75+
76+
### `workspace_id`
77+
78+
Format: `UUID`
79+
80+
---
81+
82+
## Endpoints
83+

0 commit comments

Comments
 (0)