Support of CancellationToken

[petrkoutnycz]

Description

Cancellation support in OpenApiClientProvider.

Repro steps

Please provide the steps required to reproduce the problem

1. Use a provider according this page: https://fsprojects.github.io/SwaggerProvider/#/OpenApiClientProvider

2. Generated client contains methods without a support for cancellation tokens

Expected behavior

Generated methods accept CancellationToken instance.

Actual behavior

It is not possible to provide my own instance of CancellationToken.

Affected Type Providers

• SwaggerClientProvider
• OpenApiClientProvider

Related information

• Operating system - macOS Ventura
• .NET Runtime, CoreCLR or Mono Version - .NET 6 SDK

[sergey-tihon]

It definitely make sense, when we generate methods that return Task<_>, but it will require emitting different code for Tasks with manual cancelation checks - https://learn.microsoft.com/en-us/dotnet/fsharp/language-reference/task-expressions#adding-cancellation-tokens-and-cancellation-checks

As workaround we can use async that automatically instrumented by cancellation token

[<Literal>]
let Schema = "https://petstore.swagger.io/v2/swagger.json"
type PetStore = OpenApiClientProvider<Schema, PreferAsync=true>


let store = PetStore.Client()
let task = Async.StartAsTask(store.GetPetById(42L), cancellationToken)

[petrkoutnycz]

Nice workaround, did not realize it. Yeah, you're right. I am mostly speaking about Task<_> and since it is natively supported in F# now, it would be nice to be able to cancel it.