Skip to content

Commit d073176

Browse files
authored
Remove "experimental" tag from workflow update (#380)
1 parent 301062a commit d073176

File tree

7 files changed

+0
-37
lines changed

7 files changed

+0
-37
lines changed

src/Temporalio/Client/WorkflowHandle.cs

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,6 @@ public Task<TQueryResult> QueryAsync<TQueryResult>(
309309
/// <param name="updateCall">Invocation of workflow update method.</param>
310310
/// <param name="options">Update options. Currently <c>WaitForStage</c> is required.</param>
311311
/// <returns>Workflow update handle.</returns>
312-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
313312
public Task<WorkflowUpdateHandle> StartUpdateAsync<TWorkflow>(
314313
Expression<Func<TWorkflow, Task>> updateCall, WorkflowUpdateStartOptions options)
315314
{
@@ -328,7 +327,6 @@ public Task<WorkflowUpdateHandle> StartUpdateAsync<TWorkflow>(
328327
/// <param name="updateCall">Invocation of workflow update method.</param>
329328
/// <param name="options">Update options. Currently <c>WaitForStage</c> is required.</param>
330329
/// <returns>Workflow update handle.</returns>
331-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
332330
public Task<WorkflowUpdateHandle<TUpdateResult>> StartUpdateAsync<TWorkflow, TUpdateResult>(
333331
Expression<Func<TWorkflow, Task<TUpdateResult>>> updateCall,
334332
WorkflowUpdateStartOptions options)
@@ -347,7 +345,6 @@ public Task<WorkflowUpdateHandle<TUpdateResult>> StartUpdateAsync<TWorkflow, TUp
347345
/// <param name="args">Arguments for the update.</param>
348346
/// <param name="options">Update options. Currently <c>WaitForStage</c> is required.</param>
349347
/// <returns>Workflow update handle.</returns>
350-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
351348
public async Task<WorkflowUpdateHandle> StartUpdateAsync(
352349
string update, IReadOnlyCollection<object?> args, WorkflowUpdateStartOptions options) =>
353350
await StartUpdateAsync<ValueTuple>(update, args, options).ConfigureAwait(false);
@@ -360,7 +357,6 @@ public async Task<WorkflowUpdateHandle> StartUpdateAsync(
360357
/// <param name="args">Arguments for the update.</param>
361358
/// <param name="options">Update options. Currently <c>WaitForStage</c> is required.</param>
362359
/// <returns>Workflow update handle.</returns>
363-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
364360
public Task<WorkflowUpdateHandle<TUpdateResult>> StartUpdateAsync<TUpdateResult>(
365361
string update, IReadOnlyCollection<object?> args, WorkflowUpdateStartOptions options) =>
366362
Client.OutboundInterceptor.StartWorkflowUpdateAsync<TUpdateResult>(new(
@@ -378,9 +374,6 @@ public Task<WorkflowUpdateHandle<TUpdateResult>> StartUpdateAsync<TUpdateResult>
378374
/// +
379375
/// <see cref="WorkflowUpdateHandle.GetResultAsync(RpcOptions?)" />.
380376
/// </summary>
381-
/// <remarks>WARNING: Workflow update is experimental and APIs may change. Currently this
382-
/// API will timeout on long update requests instead of properly polling for their
383-
/// completion.</remarks>
384377
/// <typeparam name="TWorkflow">Workflow class type.</typeparam>
385378
/// <param name="updateCall">Invocation of workflow update method.</param>
386379
/// <param name="options">Extra options.</param>
@@ -401,9 +394,6 @@ public async Task ExecuteUpdateAsync<TWorkflow>(
401394
/// +
402395
/// <see cref="WorkflowUpdateHandle{TResult}.GetResultAsync(RpcOptions?)" />.
403396
/// </summary>
404-
/// <remarks>WARNING: Workflow update is experimental and APIs may change. Currently this
405-
/// API will timeout on long update requests instead of properly polling for their
406-
/// completion.</remarks>
407397
/// <typeparam name="TWorkflow">Workflow class type.</typeparam>
408398
/// <typeparam name="TUpdateResult">Update result type.</typeparam>
409399
/// <param name="updateCall">Invocation of workflow update method.</param>
@@ -424,9 +414,6 @@ public async Task<TUpdateResult> ExecuteUpdateAsync<TWorkflow, TUpdateResult>(
424414
/// +
425415
/// <see cref="WorkflowUpdateHandle.GetResultAsync(RpcOptions?)" />.
426416
/// </summary>
427-
/// <remarks>WARNING: Workflow update is experimental and APIs may change. Currently this
428-
/// API will timeout on long update requests instead of properly polling for their
429-
/// completion.</remarks>
430417
/// <param name="update">Update name.</param>
431418
/// <param name="args">Update args.</param>
432419
/// <param name="options">Extra options.</param>
@@ -447,9 +434,6 @@ public async Task ExecuteUpdateAsync(
447434
/// +
448435
/// <see cref="WorkflowUpdateHandle.GetResultAsync(RpcOptions?)" />.
449436
/// </summary>
450-
/// <remarks>WARNING: Workflow update is experimental and APIs may change. Currently this
451-
/// API will timeout on long update requests instead of properly polling for their
452-
/// completion.</remarks>
453437
/// <typeparam name="TUpdateResult">Update result type.</typeparam>
454438
/// <param name="update">Update name.</param>
455439
/// <param name="args">Update args.</param>
@@ -470,7 +454,6 @@ public async Task<TUpdateResult> ExecuteUpdateAsync<TUpdateResult>(
470454
/// </summary>
471455
/// <param name="id">ID of the update.</param>
472456
/// <returns>Workflow update handle.</returns>
473-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
474457
public WorkflowUpdateHandle GetUpdateHandle(string id) =>
475458
new(Client: Client, Id: id, WorkflowId: Id, WorkflowRunId: RunId);
476459

@@ -480,7 +463,6 @@ public WorkflowUpdateHandle GetUpdateHandle(string id) =>
480463
/// <typeparam name="TUpdateResult">Update result type.</typeparam>
481464
/// <param name="id">ID of the update.</param>
482465
/// <returns>Workflow update handle.</returns>
483-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
484466
public WorkflowUpdateHandle<TUpdateResult> GetUpdateHandle<TUpdateResult>(string id) =>
485467
new(Client: Client, Id: id, WorkflowId: Id, WorkflowRunId: RunId);
486468

@@ -679,7 +661,6 @@ public Task<TQueryResult> QueryAsync<TQueryResult>(
679661
/// <param name="updateCall">Invocation of workflow update method.</param>
680662
/// <param name="options">Update options. Currently <c>WaitForStage</c> is required.</param>
681663
/// <returns>Workflow update handle.</returns>
682-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
683664
public Task<WorkflowUpdateHandle> StartUpdateAsync(
684665
Expression<Func<TWorkflow, Task>> updateCall, WorkflowUpdateStartOptions options) =>
685666
StartUpdateAsync<TWorkflow>(updateCall, options);
@@ -691,7 +672,6 @@ public Task<WorkflowUpdateHandle> StartUpdateAsync(
691672
/// <param name="updateCall">Invocation of workflow update method.</param>
692673
/// <param name="options">Update options. Currently <c>WaitForStage</c> is required.</param>
693674
/// <returns>Workflow update handle.</returns>
694-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
695675
public Task<WorkflowUpdateHandle<TUpdateResult>> StartUpdateAsync<TUpdateResult>(
696676
Expression<Func<TWorkflow, Task<TUpdateResult>>> updateCall,
697677
WorkflowUpdateStartOptions options) =>
@@ -703,9 +683,6 @@ public Task<WorkflowUpdateHandle<TUpdateResult>> StartUpdateAsync<TUpdateResult>
703683
/// +
704684
/// <see cref="WorkflowUpdateHandle.GetResultAsync(RpcOptions?)" />.
705685
/// </summary>
706-
/// <remarks>WARNING: Workflow update is experimental and APIs may change. Currently this
707-
/// API will timeout on long update requests instead of properly polling for their
708-
/// completion.</remarks>
709686
/// <param name="updateCall">Invocation of workflow update method.</param>
710687
/// <param name="options">Extra options.</param>
711688
/// <returns>Completed update task.</returns>
@@ -724,9 +701,6 @@ public async Task ExecuteUpdateAsync(
724701
/// +
725702
/// <see cref="WorkflowUpdateHandle{TResult}.GetResultAsync(RpcOptions?)" />.
726703
/// </summary>
727-
/// <remarks>WARNING: Workflow update is experimental and APIs may change. Currently this
728-
/// API will timeout on long update requests instead of properly polling for their
729-
/// completion.</remarks>
730704
/// <typeparam name="TUpdateResult">Update result type.</typeparam>
731705
/// <param name="updateCall">Invocation of workflow update method.</param>
732706
/// <param name="options">Extra options.</param>

src/Temporalio/Client/WorkflowUpdateHandle.cs

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ namespace Temporalio.Client
1515
/// <param name="Id">Update ID.</param>
1616
/// <param name="WorkflowId">Workflow ID.</param>
1717
/// <param name="WorkflowRunId">Run ID if any.</param>
18-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
1918
public record WorkflowUpdateHandle(
2019
ITemporalClient Client,
2120
string Id,
@@ -32,7 +31,6 @@ public record WorkflowUpdateHandle(
3231
/// </summary>
3332
/// <param name="rpcOptions">Extra RPC options.</param>
3433
/// <returns>Completed update task.</returns>
35-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
3634
public Task GetResultAsync(RpcOptions? rpcOptions = null) =>
3735
GetResultAsync<ValueTuple>(rpcOptions);
3836

@@ -42,7 +40,6 @@ public Task GetResultAsync(RpcOptions? rpcOptions = null) =>
4240
/// <typeparam name="TResult">Update result type.</typeparam>
4341
/// <param name="rpcOptions">Extra RPC options.</param>
4442
/// <returns>Completed update result.</returns>
45-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
4643
public virtual async Task<TResult> GetResultAsync<TResult>(RpcOptions? rpcOptions = null)
4744
{
4845
await PollUntilOutcomeAsync(rpcOptions).ConfigureAwait(false);
@@ -131,7 +128,6 @@ internal async Task PollUntilOutcomeAsync(RpcOptions? rpcOptions = null)
131128
/// <param name="Id">Update ID.</param>
132129
/// <param name="WorkflowId">Workflow ID.</param>
133130
/// <param name="WorkflowRunId">Run ID if any.</param>
134-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
135131
public record WorkflowUpdateHandle<TResult>(
136132
ITemporalClient Client,
137133
string Id,
@@ -144,7 +140,6 @@ public record WorkflowUpdateHandle<TResult>(
144140
/// </summary>
145141
/// <param name="rpcOptions">Extra RPC options.</param>
146142
/// <returns>Completed update result.</returns>
147-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
148143
public new Task<TResult> GetResultAsync(RpcOptions? rpcOptions = null) =>
149144
GetResultAsync<TResult>(rpcOptions);
150145
}

src/Temporalio/Client/WorkflowUpdateOptions.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ namespace Temporalio.Client
55
/// <summary>
66
/// Options for executing an update on a <see cref="WorkflowHandle" />.
77
/// </summary>
8-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
98
public class WorkflowUpdateOptions : ICloneable
109
{
1110
/// <summary>

src/Temporalio/Client/WorkflowUpdateStartOptions.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ namespace Temporalio.Client
33
/// <summary>
44
/// Options for starting an update on a <see cref="WorkflowHandle" />.
55
/// </summary>
6-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
76
public class WorkflowUpdateStartOptions : WorkflowUpdateOptions
87
{
98
/// <summary>

src/Temporalio/Workflows/Workflow.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,6 @@ public static string CurrentDetails
9696
/// This set via a <see cref="AsyncLocal{T}" /> and therefore only visible inside the
9797
/// handler and tasks it creates.
9898
/// </remarks>
99-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
10099
public static WorkflowUpdateInfo? CurrentUpdateInfo => Context.CurrentUpdateInfo;
101100

102101
/// <summary>

src/Temporalio/Workflows/WorkflowUpdateAttribute.cs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ namespace Temporalio.Workflows
1515
/// <see cref="Worker.TemporalWorkerOptions.WorkflowFailureExceptionTypes"/> to change the
1616
/// default behavior.
1717
/// </remarks>
18-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
1918
[AttributeUsage(AttributeTargets.Method, Inherited = false)]
2019
public sealed class WorkflowUpdateAttribute : Attribute
2120
{
@@ -45,7 +44,6 @@ public WorkflowUpdateAttribute()
4544
/// Gets or sets a short description for this update that may appear in UI/CLI when workflow
4645
/// is asked for which updates it supports.
4746
/// </summary>
48-
/// <remarks>WARNING: This setting is experimental.</remarks>
4947
public string? Description { get; set; }
5048

5149
/// <summary>

src/Temporalio/Workflows/WorkflowUpdateInfo.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ namespace Temporalio.Workflows
99
/// </summary>
1010
/// <param name="Id">Current update ID.</param>
1111
/// <param name="Name">Current update name.</param>
12-
/// <remarks>WARNING: Workflow update is experimental and APIs may change.</remarks>
1312
public record WorkflowUpdateInfo(
1413
string Id,
1514
string Name)

0 commit comments

Comments
 (0)