Skip to content

feat: Updated OpenAPI spec #113

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 5, 2026
Merged

feat: Updated OpenAPI spec #113

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
80 changes: 80 additions & 0 deletions ...erated/LabelStudio.ILearningResourcesClient.ApiLearningResourcesEditingSessionCreate.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
#nullable enable

namespace LabelStudio
{
public partial interface ILearningResourcesClient
{
/// <summary>
/// ✨ Heartbeat or release an editing session for a learning resource<br/>
/// &lt;Card href="https://humansignal.com/goenterprise"&gt;<br/>
/// &lt;img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/&gt;<br/>
/// &lt;p style="margin-top: 10px; font-size: 14px;"&gt;<br/>
/// This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)<br/>
/// &lt;/p&gt;<br/>
/// &lt;/Card&gt;<br/>
/// POST claims or refreshes presence on a (module, page). A bare heartbeat only tracks presence — it never claims the write lock. Pass `wants_to_edit` to actually claim it: the first session on a free page to ask becomes the writer, later ones stay read-only unless `takeover` is set (which itself implies `wants_to_edit`). Sessions expire 60 seconds after the last heartbeat. DELETE releases the caller's own session.
/// </summary>
/// <param name="id"></param>
/// <param name="request"></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::LabelStudio.ApiException"></exception>
global::System.Threading.Tasks.Task<global::LabelStudio.CourseEditingSessionResponse> ApiLearningResourcesEditingSessionCreateAsync(
int id,

global::LabelStudio.CourseEditingSessionHeartbeatRequest request,
global::LabelStudio.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default);
/// <summary>
/// ✨ Heartbeat or release an editing session for a learning resource<br/>
/// &lt;Card href="https://humansignal.com/goenterprise"&gt;<br/>
/// &lt;img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/&gt;<br/>
/// &lt;p style="margin-top: 10px; font-size: 14px;"&gt;<br/>
/// This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)<br/>
/// &lt;/p&gt;<br/>
/// &lt;/Card&gt;<br/>
/// POST claims or refreshes presence on a (module, page). A bare heartbeat only tracks presence — it never claims the write lock. Pass `wants_to_edit` to actually claim it: the first session on a free page to ask becomes the writer, later ones stay read-only unless `takeover` is set (which itself implies `wants_to_edit`). Sessions expire 60 seconds after the last heartbeat. DELETE releases the caller's own session.
/// </summary>
/// <param name="id"></param>
/// <param name="request"></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::LabelStudio.ApiException"></exception>
global::System.Threading.Tasks.Task<global::LabelStudio.AutoSDKHttpResponse<global::LabelStudio.CourseEditingSessionResponse>> ApiLearningResourcesEditingSessionCreateAsResponseAsync(
int id,

global::LabelStudio.CourseEditingSessionHeartbeatRequest request,
global::LabelStudio.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default);
/// <summary>
/// ✨ Heartbeat or release an editing session for a learning resource<br/>
/// &lt;Card href="https://humansignal.com/goenterprise"&gt;<br/>
/// &lt;img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/&gt;<br/>
/// &lt;p style="margin-top: 10px; font-size: 14px;"&gt;<br/>
/// This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)<br/>
/// &lt;/p&gt;<br/>
/// &lt;/Card&gt;<br/>
/// POST claims or refreshes presence on a (module, page). A bare heartbeat only tracks presence — it never claims the write lock. Pass `wants_to_edit` to actually claim it: the first session on a free page to ask becomes the writer, later ones stay read-only unless `takeover` is set (which itself implies `wants_to_edit`). Sessions expire 60 seconds after the last heartbeat. DELETE releases the caller's own session.
/// </summary>
/// <param name="id"></param>
/// <param name="moduleId"></param>
/// <param name="pageId"></param>
/// <param name="takeover">
/// Default Value: false
/// </param>
/// <param name="wantsToEdit">
/// Default Value: false
/// </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>
global::System.Threading.Tasks.Task<global::LabelStudio.CourseEditingSessionResponse> ApiLearningResourcesEditingSessionCreateAsync(
int id,
string pageId,
int? moduleId = default,
bool? takeover = default,
bool? wantsToEdit = default,
global::LabelStudio.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default);
}
}
44 changes: 44 additions & 0 deletions ...rated/LabelStudio.ILearningResourcesClient.ApiLearningResourcesEditingSessionDestroy.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
#nullable enable

namespace LabelStudio
{
public partial interface ILearningResourcesClient
{
/// <summary>
/// ✨ Heartbeat or release an editing session for a learning resource<br/>
/// &lt;Card href="https://humansignal.com/goenterprise"&gt;<br/>
/// &lt;img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/&gt;<br/>
/// &lt;p style="margin-top: 10px; font-size: 14px;"&gt;<br/>
/// This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)<br/>
/// &lt;/p&gt;<br/>
/// &lt;/Card&gt;<br/>
/// POST claims or refreshes presence on a (module, page). A bare heartbeat only tracks presence — it never claims the write lock. Pass `wants_to_edit` to actually claim it: the first session on a free page to ask becomes the writer, later ones stay read-only unless `takeover` is set (which itself implies `wants_to_edit`). Sessions expire 60 seconds after the last heartbeat. DELETE releases the caller's own session.
/// </summary>
/// <param name="id"></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::LabelStudio.ApiException"></exception>
global::System.Threading.Tasks.Task<global::LabelStudio.CourseEditingSessionResponse> ApiLearningResourcesEditingSessionDestroyAsync(
int id,
global::LabelStudio.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default);
/// <summary>
/// ✨ Heartbeat or release an editing session for a learning resource<br/>
/// &lt;Card href="https://humansignal.com/goenterprise"&gt;<br/>
/// &lt;img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/&gt;<br/>
/// &lt;p style="margin-top: 10px; font-size: 14px;"&gt;<br/>
/// This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)<br/>
/// &lt;/p&gt;<br/>
/// &lt;/Card&gt;<br/>
/// POST claims or refreshes presence on a (module, page). A bare heartbeat only tracks presence — it never claims the write lock. Pass `wants_to_edit` to actually claim it: the first session on a free page to ask becomes the writer, later ones stay read-only unless `takeover` is set (which itself implies `wants_to_edit`). Sessions expire 60 seconds after the last heartbeat. DELETE releases the caller's own session.
/// </summary>
/// <param name="id"></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::LabelStudio.ApiException"></exception>
global::System.Threading.Tasks.Task<global::LabelStudio.AutoSDKHttpResponse<global::LabelStudio.CourseEditingSessionResponse>> ApiLearningResourcesEditingSessionDestroyAsResponseAsync(
int id,
global::LabelStudio.AutoSDKRequestOptions? requestOptions = default,
global::System.Threading.CancellationToken cancellationToken = default);
}
}
6 changes: 3 additions & 3 deletions ...d/LabelStudio.ILearningResourcesClient.ApiLearningResourcesModulesPagesPartialUpdate.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ public partial interface ILearningResourcesClient
/// This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)<br/>
/// &lt;/p&gt;<br/>
/// &lt;/Card&gt;<br/>
/// Replace only the supplied keys of a single page. Rejects a stale `page_version` with 409 `page_version_conflict`, and a page that moved to another module with 410 `page_moved`.
/// Replace only the supplied keys of a single page. Rejects a write to a page another author holds the editing lock on with 409 `page_in_use`, a stale `page_version` with 409 `page_version_conflict`, and a page that moved to another module with 410 `page_moved`.
/// </summary>
/// <param name="id"></param>
/// <param name="moduleId"></param>
Expand All @@ -37,7 +37,7 @@ public partial interface ILearningResourcesClient
/// This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)<br/>
/// &lt;/p&gt;<br/>
/// &lt;/Card&gt;<br/>
/// Replace only the supplied keys of a single page. Rejects a stale `page_version` with 409 `page_version_conflict`, and a page that moved to another module with 410 `page_moved`.
/// Replace only the supplied keys of a single page. Rejects a write to a page another author holds the editing lock on with 409 `page_in_use`, a stale `page_version` with 409 `page_version_conflict`, and a page that moved to another module with 410 `page_moved`.
/// </summary>
/// <param name="id"></param>
/// <param name="moduleId"></param>
Expand All @@ -62,7 +62,7 @@ public partial interface ILearningResourcesClient
/// This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)<br/>
/// &lt;/p&gt;<br/>
/// &lt;/Card&gt;<br/>
/// Replace only the supplied keys of a single page. Rejects a stale `page_version` with 409 `page_version_conflict`, and a page that moved to another module with 410 `page_moved`.
/// Replace only the supplied keys of a single page. Rejects a write to a page another author holds the editing lock on with 409 `page_in_use`, a stale `page_version` with 409 `page_version_conflict`, and a page that moved to another module with 410 `page_moved`.
/// </summary>
/// <param name="id"></param>
/// <param name="moduleId"></param>
Expand Down
Loading