Exposing response headers through a generated C# client

Preface: I want to implement the ETag header for some of my resources. My initial plan is to use [SwaggerResponse(HttpStatusCode.NotModified, typeof(void))] and handle ETag logic inside the action.

For the above to work, I need to be able to read the response headers with my generated clients, to extract the current ETag. I’m not quite sure how this can be achieved without breaking existing code. Perhaps a new generator setting can be added, to have methods return value tuples containing the response headers. So instead of

Task<Foo> Foos_GetFooAsync(int id)

it generates

Task<(Foo value, HttpResponseHeaders responseHeaders)> Foos_GetFooAsync(int id)

Then you can either use the headers

(var foo, var headers) = await Foos_GetFooAsync(id)

or discard them

(var foo, _) = await Foos_GetFooAsync(id)

Do you think this is a path worth exploring? Or do you have something else in mind? I can help out with implementing this if you like.

[stijnherreman]

Ah, thank you. The client name is Client in this case, so Client.Workspaces_Head made it work.

[RicoSuter]

I think it’s clientName.methodName