Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .mock/definition/activityLogs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ service:
method: GET
auth: true
docs: >-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Retrieve activity logs filtered by workspace, project, user, HTTP
method, date range or search query.
source:
Expand Down
21 changes: 20 additions & 1 deletion .mock/definition/annotationHistory.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ service:
method: GET
auth: true
docs: >-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
List annotation history items for an annotation. Annotation history logs
all actions performed with annotations, such as: imports, submits,
updates, reviews, and more. Users can view annotation history items in
Expand Down Expand Up @@ -54,6 +60,12 @@ service:
method: DELETE
auth: true
docs: >-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Delete all annotation history items for a specific annotation, task or
project. This method is available only for users with administrator
roles.
Expand Down Expand Up @@ -85,7 +97,14 @@ service:
path: /api/projects/{id}/annotation-history/
method: GET
auth: true
docs: List all annotation history items for the project with pagination.
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
List all annotation history items for the project with pagination.
source:
openapi: openapi/openapi.yaml
path-parameters:
Expand Down
54 changes: 48 additions & 6 deletions .mock/definition/annotationReviews.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,14 @@ service:
path: /api/annotation-reviews/
method: GET
auth: true
docs: List all reviews for a specific annotation ID.
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
List all reviews for a specific annotation ID.
source:
openapi: openapi/openapi.yaml
display-name: List reviews
Expand Down Expand Up @@ -44,7 +51,14 @@ service:
path: /api/annotation-reviews/
method: POST
auth: true
docs: Create a review for a specific annotation ID.
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Create a review for a specific annotation ID.
source:
openapi: openapi/openapi.yaml
display-name: Create review
Expand Down Expand Up @@ -82,7 +96,14 @@ service:
path: /api/annotation-reviews/{id}/
method: GET
auth: true
docs: Retrieve a specific review by ID for an annotation.
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Retrieve a specific review by ID for an annotation.
source:
openapi: openapi/openapi.yaml
path-parameters:
Expand Down Expand Up @@ -116,7 +137,14 @@ service:
path: /api/annotation-reviews/{id}/
method: PUT
auth: true
docs: Overwrite a specific review by ID.
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Overwrite a specific review by ID.
source:
openapi: openapi/openapi.yaml
path-parameters:
Expand Down Expand Up @@ -155,7 +183,14 @@ service:
path: /api/annotation-reviews/{id}/
method: DELETE
auth: true
docs: Delete a review by ID
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Delete a review by ID
source:
openapi: openapi/openapi.yaml
path-parameters:
Expand All @@ -172,7 +207,14 @@ service:
path: /api/annotation-reviews/{id}/
method: PATCH
auth: true
docs: Update a specific review by ID.
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Update a specific review by ID.
source:
openapi: openapi/openapi.yaml
path-parameters:
Expand Down
9 changes: 8 additions & 1 deletion .mock/definition/billing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,14 @@ service:
path: /api/billing/info
method: GET
auth: true
docs: Retrieve billing checks and feature flags for the active organization.
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Retrieve billing checks and feature flags for the active organization.
source:
openapi: openapi/openapi.yaml
display-name: Get billing info
Expand Down
63 changes: 56 additions & 7 deletions .mock/definition/comments.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,14 @@ service:
path: /api/comments/
method: GET
auth: true
docs: List all comments for a specific annotation ID.
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
List all comments for a specific annotation ID.
source:
openapi: openapi/openapi.yaml
display-name: List comments
Expand Down Expand Up @@ -50,7 +57,14 @@ service:
path: /api/comments/
method: POST
auth: true
docs: Create a comment for a specific annotation ID.
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Create a comment for a specific annotation ID.
source:
openapi: openapi/openapi.yaml
display-name: Create comment
Expand Down Expand Up @@ -90,7 +104,14 @@ service:
path: /api/comments/export/
method: GET
auth: true
docs: Export comments to CSV file
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Export comments to CSV file
source:
openapi: openapi/openapi.yaml
display-name: Export comments to CSV
Expand All @@ -116,7 +137,14 @@ service:
path: /api/comments/{id}/
method: GET
auth: true
docs: Retrieve a specific comment by ID for an annotation.
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Retrieve a specific comment by ID for an annotation.
source:
openapi: openapi/openapi.yaml
path-parameters:
Expand Down Expand Up @@ -157,7 +185,14 @@ service:
path: /api/comments/{id}/
method: PUT
auth: true
docs: Overwrite a specific comment by ID.
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Overwrite a specific comment by ID.
source:
openapi: openapi/openapi.yaml
path-parameters:
Expand Down Expand Up @@ -201,7 +236,14 @@ service:
path: /api/comments/{id}/
method: DELETE
auth: true
docs: Delete a comment by ID
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Delete a comment by ID
source:
openapi: openapi/openapi.yaml
path-parameters:
Expand All @@ -222,7 +264,14 @@ service:
path: /api/comments/{id}/
method: PATCH
auth: true
docs: Update a specific comment by ID.
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Update a specific comment by ID.
source:
openapi: openapi/openapi.yaml
path-parameters:
Expand Down
45 changes: 44 additions & 1 deletion .mock/definition/exportStorage/azureSpi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ service:
method: GET
auth: true
docs: >-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Get a list of all Azure export storage connections that were set up with
Service Principal authentication.
source:
Expand Down Expand Up @@ -60,6 +66,12 @@ service:
method: POST
auth: true
docs: >-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Create an Azure export storage connection with Service Principal
authentication to store annotations.
source:
Expand Down Expand Up @@ -107,6 +119,12 @@ service:
method: POST
auth: true
docs: >-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Validate a specific Azure export storage connection that was set up with
Service Principal authentication.
source:
Expand All @@ -125,6 +143,12 @@ service:
method: GET
auth: true
docs: >-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Get a specific Azure export storage connection that was set up with
Service Principal authentication.
source:
Expand Down Expand Up @@ -171,6 +195,12 @@ service:
method: DELETE
auth: true
docs: >-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Delete a specific Azure export storage connection that was set up with
Service Principal authentication.
source:
Expand All @@ -188,6 +218,12 @@ service:
method: PATCH
auth: true
docs: >-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Update a specific Azure export storage connection that was set up with
Service Principal authentication.
source:
Expand Down Expand Up @@ -302,7 +338,14 @@ service:
path: /api/storages/export/azure_spi/{id}/sync
method: POST
auth: true
docs: Sync tasks from an Azure SPI export storage.
docs: |-
<Card href="https://humansignal.com/goenterprise">
<img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/>
<p style="margin-top: 10px; font-size: 14px;">
This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)
</p>
</Card>
Sync tasks from an Azure SPI export storage.
source:
openapi: openapi/openapi.yaml
path-parameters:
Expand Down
Loading
Loading