Skip to content

feat: Updated OpenAPI spec #202

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
HavenDV merged 1 commit into from
Nov 10, 2026
Merged

feat: Updated OpenAPI spec #202

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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions src/libs/LabelStudio/Generated/LabelStudio.ExportClient.Create.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ partial void ProcessCreateResponseContent(

/// <summary>
/// Create new export snapshot<br/>
/// Create a new export request to start a background task and generate an export file for a specific project by ID.
/// Create a new export request to start a background task and generate an export file for a specific project by ID. Optional `since` / `until` limit the snapshot to tasks with `updated_at` in the half-open window `[since, until)`. `since` must be in the past; an omitted or later `until` becomes create/request time minus INCREMENTAL_EXPORT_UNTIL_LAG_SECONDS. Set `ephemeral=true` to omit the snapshot from list endpoints. On deployments that run the RQ cron scheduler (SaaS; on-prem with `rqcron.enabled`), ephemeral exports older than EPHEMERAL_EXPORT_TTL_HOURS (default 24) are deleted by a daily low-queue sweep; otherwise they remain unlisted until explicitly deleted. Use the resolved `until` from the response as `since` on the next incremental create. Task deletions are not represented in incremental snapshots (only surviving tasks with bumped `updated_at`). Rows committed after the export query starts but stamped with `updated_at` before `until` can fall outside both consecutive windows; the default `until` lag mitigates long transactions.
/// </summary>
/// <param name="id"></param>
/// <param name="request"></param>
Expand All @@ -71,7 +71,7 @@ partial void ProcessCreateResponseContent(
}
/// <summary>
/// Create new export snapshot<br/>
/// Create a new export request to start a background task and generate an export file for a specific project by ID.
/// Create a new export request to start a background task and generate an export file for a specific project by ID. Optional `since` / `until` limit the snapshot to tasks with `updated_at` in the half-open window `[since, until)`. `since` must be in the past; an omitted or later `until` becomes create/request time minus INCREMENTAL_EXPORT_UNTIL_LAG_SECONDS. Set `ephemeral=true` to omit the snapshot from list endpoints. On deployments that run the RQ cron scheduler (SaaS; on-prem with `rqcron.enabled`), ephemeral exports older than EPHEMERAL_EXPORT_TTL_HOURS (default 24) are deleted by a daily low-queue sweep; otherwise they remain unlisted until explicitly deleted. Use the resolved `until` from the response as `since` on the next incremental create. Task deletions are not represented in incremental snapshots (only surviving tasks with bumped `updated_at`). Rows committed after the export query starts but stamped with `updated_at` before `until` can fall outside both consecutive windows; the default `until` lag mitigates long transactions.
/// </summary>
/// <param name="id"></param>
/// <param name="request"></param>
Expand Down Expand Up @@ -444,7 +444,7 @@ partial void ProcessCreateResponseContent(
}
/// <summary>
/// Create new export snapshot<br/>
/// Create a new export request to start a background task and generate an export file for a specific project by ID.
/// Create a new export request to start a background task and generate an export file for a specific project by ID. Optional `since` / `until` limit the snapshot to tasks with `updated_at` in the half-open window `[since, until)`. `since` must be in the past; an omitted or later `until` becomes create/request time minus INCREMENTAL_EXPORT_UNTIL_LAG_SECONDS. Set `ephemeral=true` to omit the snapshot from list endpoints. On deployments that run the RQ cron scheduler (SaaS; on-prem with `rqcron.enabled`), ephemeral exports older than EPHEMERAL_EXPORT_TTL_HOURS (default 24) are deleted by a daily low-queue sweep; otherwise they remain unlisted until explicitly deleted. Use the resolved `until` from the response as `since` on the next incremental create. Task deletions are not represented in incremental snapshots (only surviving tasks with bumped `updated_at`). Rows committed after the export query starts but stamped with `updated_at` before `until` can fall outside both consecutive windows; the default `until` lag mitigates long transactions.
/// </summary>
/// <param name="id"></param>
/// <param name="annotationFilterOptions"></param>
Expand All @@ -456,14 +456,24 @@ partial void ProcessCreateResponseContent(
/// control which fields are displayed, and whether to replace simple<br/>
/// values with complex, nested serializations
/// </param>
/// <param name="ephemeral">
/// When true, the export is omitted from list endpoints. Detail and download by id still work. TTL deletion (EPHEMERAL_EXPORT_TTL_HOURS, default 24) runs via the RQ cron scheduler when enabled (SaaS; on-prem `rqcron.enabled`); otherwise delete explicitly.<br/>
/// Default Value: false
/// </param>
/// <param name="finishedAt">
/// Complete or fail time
/// </param>
/// <param name="md5"></param>
/// <param name="serializationOptions"></param>
/// <param name="since">
/// Inclusive lower bound on Task.updated_at for an incremental snapshot. Omit for a full export. Pair with until for a half-open window [since, until).
/// </param>
/// <param name="status"></param>
/// <param name="taskFilterOptions"></param>
/// <param name="title"></param>
/// <param name="until">
/// Exclusive upper bound on Task.updated_at. If omitted, or later than create/request time minus INCREMENTAL_EXPORT_UNTIL_LAG_SECONDS, the server uses that time instead. Use the returned value as since on the next incremental create.
/// </param>
/// <param name="requestOptions">Per-request overrides such as headers, query parameters, timeout, retries, and response buffering.</param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
Expand All @@ -473,12 +483,15 @@ partial void ProcessCreateResponseContent(
global::System.Collections.Generic.IList<global::LabelStudio.ConvertedFormatRequest>? convertedFormats = default,
object? counters = default,
global::LabelStudio.UserSimpleRequest? createdBy = default,
bool? ephemeral = default,
global::System.DateTime? finishedAt = default,
string? md5 = default,
global::LabelStudio.SerializationOptionsRequest? serializationOptions = default,
global::System.DateTime? since = default,
global::LabelStudio.ProjectImportStatusEnum? status = default,
global::LabelStudio.LseTaskFilterOptionsRequest? taskFilterOptions = default,
string? title = default,
global::System.DateTime? until = default,
global::LabelStudio.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default)
{
Expand All @@ -488,12 +501,15 @@ partial void ProcessCreateResponseContent(
ConvertedFormats = convertedFormats,
Counters = counters,
CreatedBy = createdBy,
Ephemeral = ephemeral,
FinishedAt = finishedAt,
Md5 = md5,
SerializationOptions = serializationOptions,
Since = since,
Status = status,
TaskFilterOptions = taskFilterOptions,
Title = title,
Until = until,
};

return await CreateAsync(
Expand Down
19 changes: 16 additions & 3 deletions src/libs/LabelStudio/Generated/LabelStudio.IExportClient.Create.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ public partial interface IExportClient
{
/// <summary>
/// Create new export snapshot<br/>
/// Create a new export request to start a background task and generate an export file for a specific project by ID.
/// Create a new export request to start a background task and generate an export file for a specific project by ID. Optional `since` / `until` limit the snapshot to tasks with `updated_at` in the half-open window `[since, until)`. `since` must be in the past; an omitted or later `until` becomes create/request time minus INCREMENTAL_EXPORT_UNTIL_LAG_SECONDS. Set `ephemeral=true` to omit the snapshot from list endpoints. On deployments that run the RQ cron scheduler (SaaS; on-prem with `rqcron.enabled`), ephemeral exports older than EPHEMERAL_EXPORT_TTL_HOURS (default 24) are deleted by a daily low-queue sweep; otherwise they remain unlisted until explicitly deleted. Use the resolved `until` from the response as `since` on the next incremental create. Task deletions are not represented in incremental snapshots (only surviving tasks with bumped `updated_at`). Rows committed after the export query starts but stamped with `updated_at` before `until` can fall outside both consecutive windows; the default `until` lag mitigates long transactions.
/// </summary>
/// <param name="id"></param>
/// <param name="request"></param>
Expand All @@ -21,7 +21,7 @@ public partial interface IExportClient
global::System.Threading.CancellationToken cancellationToken = default);
/// <summary>
/// Create new export snapshot<br/>
/// Create a new export request to start a background task and generate an export file for a specific project by ID.
/// Create a new export request to start a background task and generate an export file for a specific project by ID. Optional `since` / `until` limit the snapshot to tasks with `updated_at` in the half-open window `[since, until)`. `since` must be in the past; an omitted or later `until` becomes create/request time minus INCREMENTAL_EXPORT_UNTIL_LAG_SECONDS. Set `ephemeral=true` to omit the snapshot from list endpoints. On deployments that run the RQ cron scheduler (SaaS; on-prem with `rqcron.enabled`), ephemeral exports older than EPHEMERAL_EXPORT_TTL_HOURS (default 24) are deleted by a daily low-queue sweep; otherwise they remain unlisted until explicitly deleted. Use the resolved `until` from the response as `since` on the next incremental create. Task deletions are not represented in incremental snapshots (only surviving tasks with bumped `updated_at`). Rows committed after the export query starts but stamped with `updated_at` before `until` can fall outside both consecutive windows; the default `until` lag mitigates long transactions.
/// </summary>
/// <param name="id"></param>
/// <param name="request"></param>
Expand All @@ -36,7 +36,7 @@ public partial interface IExportClient
global::System.Threading.CancellationToken cancellationToken = default);
/// <summary>
/// Create new export snapshot<br/>
/// Create a new export request to start a background task and generate an export file for a specific project by ID.
/// Create a new export request to start a background task and generate an export file for a specific project by ID. Optional `since` / `until` limit the snapshot to tasks with `updated_at` in the half-open window `[since, until)`. `since` must be in the past; an omitted or later `until` becomes create/request time minus INCREMENTAL_EXPORT_UNTIL_LAG_SECONDS. Set `ephemeral=true` to omit the snapshot from list endpoints. On deployments that run the RQ cron scheduler (SaaS; on-prem with `rqcron.enabled`), ephemeral exports older than EPHEMERAL_EXPORT_TTL_HOURS (default 24) are deleted by a daily low-queue sweep; otherwise they remain unlisted until explicitly deleted. Use the resolved `until` from the response as `since` on the next incremental create. Task deletions are not represented in incremental snapshots (only surviving tasks with bumped `updated_at`). Rows committed after the export query starts but stamped with `updated_at` before `until` can fall outside both consecutive windows; the default `until` lag mitigates long transactions.
/// </summary>
/// <param name="id"></param>
/// <param name="annotationFilterOptions"></param>
Expand All @@ -48,14 +48,24 @@ public partial interface IExportClient
/// control which fields are displayed, and whether to replace simple<br/>
/// values with complex, nested serializations
/// </param>
/// <param name="ephemeral">
/// When true, the export is omitted from list endpoints. Detail and download by id still work. TTL deletion (EPHEMERAL_EXPORT_TTL_HOURS, default 24) runs via the RQ cron scheduler when enabled (SaaS; on-prem `rqcron.enabled`); otherwise delete explicitly.<br/>
/// Default Value: false
/// </param>
/// <param name="finishedAt">
/// Complete or fail time
/// </param>
/// <param name="md5"></param>
/// <param name="serializationOptions"></param>
/// <param name="since">
/// Inclusive lower bound on Task.updated_at for an incremental snapshot. Omit for a full export. Pair with until for a half-open window [since, until).
/// </param>
/// <param name="status"></param>
/// <param name="taskFilterOptions"></param>
/// <param name="title"></param>
/// <param name="until">
/// Exclusive upper bound on Task.updated_at. If omitted, or later than create/request time minus INCREMENTAL_EXPORT_UNTIL_LAG_SECONDS, the server uses that time instead. Use the returned value as since on the next incremental create.
/// </param>
/// <param name="requestOptions">Per-request overrides such as headers, query parameters, timeout, retries, and response buffering.</param>
/// <param name="cancellationToken">The token to cancel the operation with</param>
/// <exception cref="global::System.InvalidOperationException"></exception>
Expand All @@ -65,12 +75,15 @@ public partial interface IExportClient
global::System.Collections.Generic.IList<global::LabelStudio.ConvertedFormatRequest>? convertedFormats = default,
object? counters = default,
global::LabelStudio.UserSimpleRequest? createdBy = default,
bool? ephemeral = default,
global::System.DateTime? finishedAt = default,
string? md5 = default,
global::LabelStudio.SerializationOptionsRequest? serializationOptions = default,
global::System.DateTime? since = default,
global::LabelStudio.ProjectImportStatusEnum? status = default,
global::LabelStudio.LseTaskFilterOptionsRequest? taskFilterOptions = default,
string? title = default,
global::System.DateTime? until = default,
global::LabelStudio.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default);
}
Expand Down
Loading
Loading