Skip to content

feat: Updated OpenAPI spec #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
github-actions merged 1 commit into from
Aug 7, 2026
Merged

feat: Updated OpenAPI spec #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
24 changes: 10 additions & 14 deletions src/libs/LabelStudio/Generated/LabelStudio.ActionsClient.Create.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ partial void PrepareCreateArguments(
ref global::LabelStudio.ApiDmActionsCreateId id,
ref int project,
ref int? view,
global::LabelStudio.ApiDmActionsCreateRequest request);
global::LabelStudio.PrepareParamsRequestRequest request);
partial void PrepareCreateRequest(
global::System.Net.Http.HttpClient httpClient,
global::System.Net.Http.HttpRequestMessage httpRequestMessage,
global::LabelStudio.ApiDmActionsCreateId id,
int project,
int? view,
global::LabelStudio.ApiDmActionsCreateRequest request);
global::LabelStudio.PrepareParamsRequestRequest request);
partial void ProcessCreateResponse(
global::System.Net.Http.HttpClient httpClient,
global::System.Net.Http.HttpResponseMessage httpResponseMessage);
Expand All @@ -57,7 +57,7 @@ partial void ProcessCreateResponse(
global::LabelStudio.ApiDmActionsCreateId id,
int project,

global::LabelStudio.ApiDmActionsCreateRequest request,
global::LabelStudio.PrepareParamsRequestRequest request,
int? view = default,
global::LabelStudio.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default)
Expand Down Expand Up @@ -87,7 +87,7 @@ await CreateAsResponseAsync(
global::LabelStudio.ApiDmActionsCreateId id,
int project,

global::LabelStudio.ApiDmActionsCreateRequest request,
global::LabelStudio.PrepareParamsRequestRequest request,
int? view = default,
global::LabelStudio.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default)
Expand Down Expand Up @@ -449,12 +449,8 @@ await CreateAsResponseAsync(
/// <param name="id"></param>
/// <param name="project"></param>
/// <param name="view"></param>
/// <param name="filters">
/// Filters to apply on tasks. You can use [the helper class `Filters` from this page](https://labelstud.io/sdk/data_manager.html) to create Data Manager Filters.Example: `{"conjunction": "or", "items": [{"filter": "filter:tasks:completed_at", "operator": "greater", "type": "Datetime", "value": "2021-01-01T00:00:00.000Z"}]}`
/// </param>
/// <param name="ordering">
/// List of fields to order by. Fields are similar to filters but without the `filter:` prefix. To reverse the order, add a minus sign before the field name, e.g. `-tasks:created_at`.
/// </param>
/// <param name="filters"></param>
/// <param name="ordering"></param>
/// <param name="selectedItems">
/// Task selection by IDs. If filters are applied, the selection will be applied to the filtered tasks.If "all" is `false`, `"included"` must be used. If "all" is `true`, `"excluded"` must be used.Examples: `{"all": false, "included": [1, 2, 3]}` or `{"all": true, "excluded": [4, 5]}`
/// </param>
Expand All @@ -465,13 +461,13 @@ await CreateAsResponseAsync(
global::LabelStudio.ApiDmActionsCreateId id,
int project,
int? view = default,
global::LabelStudio.ApiDmActionsCreateRequestFilters? filters = default,
global::System.Collections.Generic.IList<global::LabelStudio.ApiDmActionsCreateRequestOrderingItem>? ordering = default,
global::LabelStudio.OneOf<global::LabelStudio.ApiDmActionsCreateRequestSelectedItemsAllFalse, global::LabelStudio.ApiDmActionsCreateRequestSelectedItemsAllTrue>? selectedItems = default,
global::LabelStudio.PrepareParamsFiltersRequest? filters = default,
global::System.Collections.Generic.IList<global::LabelStudio.PrepareParamsOrderingRequestItem>? ordering = default,
global::LabelStudio.OneOf<global::LabelStudio.PrepareParamsRequestRequestSelectedItemsAllFalse, global::LabelStudio.PrepareParamsRequestRequestSelectedItemsAllTrue>? selectedItems = default,
global::LabelStudio.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default)
{
var __request = new global::LabelStudio.ApiDmActionsCreateRequest
var __request = new global::LabelStudio.PrepareParamsRequestRequest
{
Filters = filters,
Ordering = ordering,
Expand Down
70 changes: 58 additions & 12 deletions src/libs/LabelStudio/Generated/LabelStudio.AnnotationsClient.Create.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ public partial class AnnotationsClient
partial void PrepareCreateArguments(
global::System.Net.Http.HttpClient httpClient,
ref int id,
global::LabelStudio.ApiTasksAnnotationsCreateRequest request);
global::LabelStudio.AnnotationRequest request);
partial void PrepareCreateRequest(
global::System.Net.Http.HttpClient httpClient,
global::System.Net.Http.HttpRequestMessage httpRequestMessage,
int id,
global::LabelStudio.ApiTasksAnnotationsCreateRequest request);
global::LabelStudio.AnnotationRequest request);
partial void ProcessCreateResponse(
global::System.Net.Http.HttpClient httpClient,
global::System.Net.Http.HttpResponseMessage httpResponseMessage);
Expand Down Expand Up @@ -68,7 +68,7 @@ partial void ProcessCreateResponseContent(
public async global::System.Threading.Tasks.Task<global::LabelStudio.Annotation> CreateAsync(
int id,

global::LabelStudio.ApiTasksAnnotationsCreateRequest request,
global::LabelStudio.AnnotationRequest request,
global::LabelStudio.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default)
{
Expand Down Expand Up @@ -107,7 +107,7 @@ partial void ProcessCreateResponseContent(
public async global::System.Threading.Tasks.Task<global::LabelStudio.AutoSDKHttpResponse<global::LabelStudio.Annotation>> CreateAsResponseAsync(
int id,

global::LabelStudio.ApiTasksAnnotationsCreateRequest request,
global::LabelStudio.AnnotationRequest request,
global::LabelStudio.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default)
{
Expand Down Expand Up @@ -486,26 +486,56 @@ partial void ProcessCreateResponseContent(
///
/// </summary>
/// <param name="id"></param>
/// <param name="completedBy">
/// User ID of the person who created this annotation
/// <param name="bulkCreated">
/// Annotation was created in bulk mode
/// </param>
/// <param name="completedBy"></param>
/// <param name="draftCreatedAt">
/// Draft creation time
/// </param>
/// <param name="groundTruth">
/// This annotation is a Ground Truth
/// This annotation is a Ground Truth (ground_truth)
/// </param>
/// <param name="importId">
/// Original annotation ID that was at the import step or NULL if this annotation wasn't imported
/// </param>
/// <param name="lastAction">
/// Action which was performed in the last annotation history item<br/>
/// * `prediction` - Created from prediction<br/>
/// * `propagated_annotation` - Created from another annotation<br/>
/// * `imported` - Imported<br/>
/// * `submitted` - Submitted<br/>
/// * `updated` - Updated<br/>
/// * `skipped` - Skipped<br/>
/// * `accepted` - Accepted<br/>
/// * `rejected` - Rejected<br/>
/// * `fixed_and_accepted` - Fixed and accepted<br/>
/// * `deleted_review` - Deleted review
/// </param>
/// <param name="lastCreatedBy">
/// User who created the last annotation history item
/// </param>
/// <param name="leadTime">
/// How much time it took to annotate the task (in seconds)<br/>
/// Example: 100.5
/// How much time it took to annotate the task
/// </param>
/// <param name="parentAnnotation">
/// Points to the parent annotation from which this annotation was created
/// </param>
/// <param name="parentPrediction">
/// Points to the prediction from which this annotation was created
/// </param>
/// <param name="project">
/// Project ID for this annotation
/// </param>
/// <param name="result">
/// Labeling result in JSON format. Read more about the format in [the Label Studio documentation.](https://labelstud.io/guide/task_format)<br/>
/// Example: [{"from_name":"bboxes","image_rotation":0,"original_height":1080,"original_width":1920,"to_name":"image","type":"rectanglelabels","value":{"height":60,"rotation":0,"values":{"rectanglelabels":["Person"]},"width":50,"x":20,"y":30}}]
/// List of annotation results for the task
/// </param>
/// <param name="task">
/// Corresponding task for this annotation
/// </param>
/// <param name="uniqueId">
/// Included only in requests
/// </param>
/// <param name="updatedBy">
/// Last user who updated this annotation
/// </param>
Expand All @@ -517,9 +547,17 @@ partial void ProcessCreateResponseContent(
/// <exception cref="global::System.InvalidOperationException"></exception>
public async global::System.Threading.Tasks.Task<global::LabelStudio.Annotation> CreateAsync(
int id,
string uniqueId,
bool? bulkCreated = default,
int? completedBy = default,
global::System.DateTime? draftCreatedAt = default,
bool? groundTruth = default,
long? importId = default,
global::LabelStudio.AnnotationHistoryActionEnum? lastAction = default,
int? lastCreatedBy = default,
double? leadTime = default,
int? parentAnnotation = default,
int? parentPrediction = default,
int? project = default,
global::System.Collections.Generic.IList<object>? result = default,
int? task = default,
Expand All @@ -528,14 +566,22 @@ partial void ProcessCreateResponseContent(
global::LabelStudio.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default)
{
var __request = new global::LabelStudio.ApiTasksAnnotationsCreateRequest
var __request = new global::LabelStudio.AnnotationRequest
{
BulkCreated = bulkCreated,
CompletedBy = completedBy,
DraftCreatedAt = draftCreatedAt,
GroundTruth = groundTruth,
ImportId = importId,
LastAction = lastAction,
LastCreatedBy = lastCreatedBy,
LeadTime = leadTime,
ParentAnnotation = parentAnnotation,
ParentPrediction = parentPrediction,
Project = project,
Result = result,
Task = task,
UniqueId = uniqueId,
UpdatedBy = updatedBy,
WasCancelled = wasCancelled,
};
Expand Down
6 changes: 4 additions & 2 deletions src/libs/LabelStudio/Generated/LabelStudio.AnnotationsClient.CreateBulk.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -481,7 +481,9 @@ partial void ProcessCreateBulkResponseContent(
/// <param name="result">
/// List of annotation results for the task
/// </param>
/// <param name="selectedItems"></param>
/// <param name="selectedItems">
/// Task selection by IDs. If filters are applied, the selection will be applied to the filtered tasks.If "all" is `false`, `"included"` must be used. If "all" is `true`, `"excluded"` must be used.Examples: `{"all": false, "included": [1, 2, 3]}` or `{"all": true, "excluded": [4, 5]}`
/// </param>
/// <param name="task">
/// Corresponding task for this annotation
/// </param>
Expand Down Expand Up @@ -512,7 +514,7 @@ partial void ProcessCreateBulkResponseContent(
int? parentPrediction = default,
int? project = default,
global::System.Collections.Generic.IList<object>? result = default,
global::LabelStudio.SelectedItemsRequest? selectedItems = default,
global::LabelStudio.OneOf<global::LabelStudio.AnnotationBulkSerializerWithSelectedItemsRequestSelectedItemsAllFalse, global::LabelStudio.AnnotationBulkSerializerWithSelectedItemsRequestSelectedItemsAllTrue>? selectedItems = default,
int? task = default,
global::System.Collections.Generic.IList<int>? tasks = default,
int? updatedBy = default,
Expand Down
70 changes: 58 additions & 12 deletions src/libs/LabelStudio/Generated/LabelStudio.AnnotationsClient.Update.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ public partial class AnnotationsClient
partial void PrepareUpdateArguments(
global::System.Net.Http.HttpClient httpClient,
ref int id,
global::LabelStudio.ApiAnnotationsPartialUpdateRequest request);
global::LabelStudio.PatchedAnnotationRequest request);
partial void PrepareUpdateRequest(
global::System.Net.Http.HttpClient httpClient,
global::System.Net.Http.HttpRequestMessage httpRequestMessage,
int id,
global::LabelStudio.ApiAnnotationsPartialUpdateRequest request);
global::LabelStudio.PatchedAnnotationRequest request);
partial void ProcessUpdateResponse(
global::System.Net.Http.HttpClient httpClient,
global::System.Net.Http.HttpResponseMessage httpResponseMessage);
Expand All @@ -55,7 +55,7 @@ partial void ProcessUpdateResponseContent(
public async global::System.Threading.Tasks.Task<global::LabelStudio.Annotation> UpdateAsync(
int id,

global::LabelStudio.ApiAnnotationsPartialUpdateRequest request,
global::LabelStudio.PatchedAnnotationRequest request,
global::LabelStudio.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default)
{
Expand All @@ -81,7 +81,7 @@ partial void ProcessUpdateResponseContent(
public async global::System.Threading.Tasks.Task<global::LabelStudio.AutoSDKHttpResponse<global::LabelStudio.Annotation>> UpdateAsResponseAsync(
int id,

global::LabelStudio.ApiAnnotationsPartialUpdateRequest request,
global::LabelStudio.PatchedAnnotationRequest request,
global::LabelStudio.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default)
{
Expand Down Expand Up @@ -447,26 +447,56 @@ partial void ProcessUpdateResponseContent(
/// Update existing attributes on an annotation.
/// </summary>
/// <param name="id"></param>
/// <param name="completedBy">
/// User ID of the person who created this annotation
/// <param name="bulkCreated">
/// Annotation was created in bulk mode
/// </param>
/// <param name="completedBy"></param>
/// <param name="draftCreatedAt">
/// Draft creation time
/// </param>
/// <param name="groundTruth">
/// This annotation is a Ground Truth
/// This annotation is a Ground Truth (ground_truth)
/// </param>
/// <param name="importId">
/// Original annotation ID that was at the import step or NULL if this annotation wasn't imported
/// </param>
/// <param name="lastAction">
/// Action which was performed in the last annotation history item<br/>
/// * `prediction` - Created from prediction<br/>
/// * `propagated_annotation` - Created from another annotation<br/>
/// * `imported` - Imported<br/>
/// * `submitted` - Submitted<br/>
/// * `updated` - Updated<br/>
/// * `skipped` - Skipped<br/>
/// * `accepted` - Accepted<br/>
/// * `rejected` - Rejected<br/>
/// * `fixed_and_accepted` - Fixed and accepted<br/>
/// * `deleted_review` - Deleted review
/// </param>
/// <param name="lastCreatedBy">
/// User who created the last annotation history item
/// </param>
/// <param name="leadTime">
/// How much time it took to annotate the task (in seconds)<br/>
/// Example: 100.5
/// How much time it took to annotate the task
/// </param>
/// <param name="parentAnnotation">
/// Points to the parent annotation from which this annotation was created
/// </param>
/// <param name="parentPrediction">
/// Points to the prediction from which this annotation was created
/// </param>
/// <param name="project">
/// Project ID for this annotation
/// </param>
/// <param name="result">
/// Labeling result in JSON format. Read more about the format in [the Label Studio documentation.](https://labelstud.io/guide/task_format)<br/>
/// Example: [{"from_name":"bboxes","image_rotation":0,"original_height":1080,"original_width":1920,"to_name":"image","type":"rectanglelabels","value":{"height":60,"rotation":0,"values":{"rectanglelabels":["Person"]},"width":50,"x":20,"y":30}}]
/// List of annotation results for the task
/// </param>
/// <param name="task">
/// Corresponding task for this annotation
/// </param>
/// <param name="uniqueId">
/// Included only in requests
/// </param>
/// <param name="updatedBy">
/// Last user who updated this annotation
/// </param>
Expand All @@ -478,9 +508,17 @@ partial void ProcessUpdateResponseContent(
/// <exception cref="global::System.InvalidOperationException"></exception>
public async global::System.Threading.Tasks.Task<global::LabelStudio.Annotation> UpdateAsync(
int id,
string uniqueId,
bool? bulkCreated = default,
int? completedBy = default,
global::System.DateTime? draftCreatedAt = default,
bool? groundTruth = default,
long? importId = default,
global::LabelStudio.AnnotationHistoryActionEnum? lastAction = default,
int? lastCreatedBy = default,
double? leadTime = default,
int? parentAnnotation = default,
int? parentPrediction = default,
int? project = default,
global::System.Collections.Generic.IList<object>? result = default,
int? task = default,
Expand All @@ -489,14 +527,22 @@ partial void ProcessUpdateResponseContent(
global::LabelStudio.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default)
{
var __request = new global::LabelStudio.ApiAnnotationsPartialUpdateRequest
var __request = new global::LabelStudio.PatchedAnnotationRequest
{
BulkCreated = bulkCreated,
CompletedBy = completedBy,
DraftCreatedAt = draftCreatedAt,
GroundTruth = groundTruth,
ImportId = importId,
LastAction = lastAction,
LastCreatedBy = lastCreatedBy,
LeadTime = leadTime,
ParentAnnotation = parentAnnotation,
ParentPrediction = parentPrediction,
Project = project,
Result = result,
Task = task,
UniqueId = uniqueId,
UpdatedBy = updatedBy,
WasCancelled = wasCancelled,
};
Expand Down
Loading
Loading