Skip to content

Commit 01e9d00

Browse files
chore: ROOT-201: Add a note to Workspace endpoints that indicates endpoint is LSE only (#627)
Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
1 parent 8b27bc6 commit 01e9d00

File tree

11 files changed

+421
-24
lines changed

11 files changed

+421
-24
lines changed

.mock/definition/workspaces.yml

Lines changed: 60 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ service:
99
method: GET
1010
auth: true
1111
docs: >-
12+
<Card href="https://humansignal.com/goenterprise">
13+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
14+
<p style="margin-top: 10px; font-size: 14px;">
15+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
16+
</p>
17+
</Card>
1218
List all workspaces for your organization. Workspaces in Label Studio
1319
let you organize your projects and users into separate spaces. This is
1420
useful for managing different teams, departments, or projects within
@@ -46,6 +52,12 @@ service:
4652
method: POST
4753
auth: true
4854
docs: >-
55+
<Card href="https://humansignal.com/goenterprise">
56+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
57+
<p style="margin-top: 10px; font-size: 14px;">
58+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
59+
</p>
60+
</Card>
4961
Create a new workspace. Workspaces in Label Studio let you organize your
5062
projects and users into separate spaces. This is useful for managing
5163
different teams, departments, or projects within your organization. For
@@ -99,7 +111,14 @@ service:
99111
path: /api/workspaces/{id}/
100112
method: GET
101113
auth: true
102-
docs: Retrieve details for a specific workspace by ID.
114+
docs: |-
115+
<Card href="https://humansignal.com/goenterprise">
116+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
117+
<p style="margin-top: 10px; font-size: 14px;">
118+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
119+
</p>
120+
</Card>
121+
Retrieve details for a specific workspace by ID.
103122
source:
104123
openapi: openapi/openapi.yaml
105124
path-parameters:
@@ -126,7 +145,14 @@ service:
126145
path: /api/workspaces/{id}/
127146
method: DELETE
128147
auth: true
129-
docs: Delete a specific workspace by ID.
148+
docs: |-
149+
<Card href="https://humansignal.com/goenterprise">
150+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
151+
<p style="margin-top: 10px; font-size: 14px;">
152+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
153+
</p>
154+
</Card>
155+
Delete a specific workspace by ID.
130156
source:
131157
openapi: openapi/openapi.yaml
132158
path-parameters:
@@ -141,7 +167,14 @@ service:
141167
path: /api/workspaces/{id}/
142168
method: PATCH
143169
auth: true
144-
docs: Update settings for a specific workspace by ID.
170+
docs: |-
171+
<Card href="https://humansignal.com/goenterprise">
172+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
173+
<p style="margin-top: 10px; font-size: 14px;">
174+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
175+
</p>
176+
</Card>
177+
Update settings for a specific workspace by ID.
145178
source:
146179
openapi: openapi/openapi.yaml
147180
path-parameters:
@@ -193,7 +226,14 @@ service:
193226
path: /api/workspaces/{id}/projects/
194227
method: GET
195228
auth: true
196-
docs: Retrieve a list of all projects in a specific workspace.
229+
docs: |-
230+
<Card href="https://humansignal.com/goenterprise">
231+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
232+
<p style="margin-top: 10px; font-size: 14px;">
233+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
234+
</p>
235+
</Card>
236+
Retrieve a list of all projects in a specific workspace.
197237
source:
198238
openapi: openapi/openapi.yaml
199239
path-parameters:
@@ -262,7 +302,14 @@ service:
262302
path: /api/workspaces/{id}/projects/
263303
method: POST
264304
auth: true
265-
docs: Create a project in a specific workspace.
305+
docs: |-
306+
<Card href="https://humansignal.com/goenterprise">
307+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
308+
<p style="margin-top: 10px; font-size: 14px;">
309+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
310+
</p>
311+
</Card>
312+
Create a project in a specific workspace.
266313
source:
267314
openapi: openapi/openapi.yaml
268315
path-parameters:
@@ -432,7 +479,14 @@ service:
432479
path: /api/workspaces/{id}/projects/
433480
method: DELETE
434481
auth: true
435-
docs: Delete projects from a specific workspace.
482+
docs: |-
483+
<Card href="https://humansignal.com/goenterprise">
484+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
485+
<p style="margin-top: 10px; font-size: 14px;">
486+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
487+
</p>
488+
</Card>
489+
Delete projects from a specific workspace.
436490
source:
437491
openapi: openapi/openapi.yaml
438492
path-parameters:

.mock/definition/workspaces/members.yml

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,14 @@ service:
88
path: /api/workspaces/{id}/memberships/
99
method: GET
1010
auth: true
11-
docs: Get a list of all members in a specific workspace.
11+
docs: |-
12+
<Card href="https://humansignal.com/goenterprise">
13+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
14+
<p style="margin-top: 10px; font-size: 14px;">
15+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
16+
</p>
17+
</Card>
18+
Get a list of all members in a specific workspace.
1219
source:
1320
openapi: openapi/openapi.yaml
1421
path-parameters:
@@ -58,7 +65,14 @@ service:
5865
path: /api/workspaces/{id}/memberships/
5966
method: POST
6067
auth: true
61-
docs: Add a new workspace member by user ID.
68+
docs: |-
69+
<Card href="https://humansignal.com/goenterprise">
70+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
71+
<p style="margin-top: 10px; font-size: 14px;">
72+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
73+
</p>
74+
</Card>
75+
Add a new workspace member by user ID.
6276
source:
6377
openapi: openapi/openapi.yaml
6478
path-parameters:
@@ -94,6 +108,12 @@ service:
94108
method: DELETE
95109
auth: true
96110
docs: >-
111+
<Card href="https://humansignal.com/goenterprise">
112+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
113+
<p style="margin-top: 10px; font-size: 14px;">
114+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
115+
</p>
116+
</Card>
97117
Remove a specific member by ID from a workspace. This endpoint expects
98118
an object like `{"user_id": 123}`.
99119
source:

.mock/definition/workspaces/members/bulk.yml

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,14 @@ service:
1717
path: /api/workspaces/{id}/memberships/bulk/
1818
method: POST
1919
auth: true
20-
docs: Assign workspace members in bulk.
20+
docs: |-
21+
<Card href="https://humansignal.com/goenterprise">
22+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
23+
<p style="margin-top: 10px; font-size: 14px;">
24+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
25+
</p>
26+
</Card>
27+
Assign workspace members in bulk.
2128
source:
2229
openapi: openapi/openapi.yaml
2330
path-parameters:
@@ -49,6 +56,12 @@ service:
4956
method: DELETE
5057
auth: true
5158
docs: >-
59+
<Card href="https://humansignal.com/goenterprise">
60+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
61+
<p style="margin-top: 10px; font-size: 14px;">
62+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
63+
</p>
64+
</Card>
5265
Unassign workspace members in bulk. Allows the same request body as bulk
5366
assign.
5467
source:

.mock/definition/workspaces/members/paginated.yml

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,14 @@ service:
88
path: /api/workspaces/{id}/memberships/paginated/
99
method: GET
1010
auth: true
11-
docs: Retrieve the members for a specific workspace.
11+
docs: |-
12+
<Card href="https://humansignal.com/goenterprise">
13+
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
14+
<p style="margin-top: 10px; font-size: 14px;">
15+
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
16+
</p>
17+
</Card>
18+
Retrieve the members for a specific workspace.
1219
pagination:
1320
offset: $request.page
1421
results: $response.results

0 commit comments

Comments
 (0)