Declared result headers are ignored

[xperiandri]

Description

  /order:
    post:
      summary: Создает заказ-наряд
      operationId: CreateOrder
      requestBody:
        $ref: '#/components/requestBodies/CarCodeBody'
      responses:
        '201':
          description: Заказ успешно создан
          headers:
            Location:
              schema:
                $ref: '#/components/schemas/OrderId'
              description: Уникальный идентификатор заказа
        '404':
          description: Код клиента или машина не найдены

Expected behavior

A resulting model exposes a Headers property with all returned headers

Actual behavior

No way to get headers

Related information

1.0.0-Beta1

[xperiandri]

@sergey-tihon, please, point me where to apply fix I will code that today

[sergey-tihon]

A resulting model exposes a Headers property with all returned headers

I do not think that we should mess up all models with Header properties. We need to correctly identity the location of the response from server (body or header) and correctly deserialize response from there.

Current implementation of OpenApiClientProvider support only Json responses.

Here we infer response type based on the response code 200/201 and inter result type
https://github.com/fsprojects/SwaggerProvider/blob/net5/src/SwaggerProvider.DesignTime/v3/OperationCompiler.fs#L135-L153

Here (assuming that response is always json format and in the body) we deserialize response into expected type
https://github.com/fsprojects/SwaggerProvider/blob/net5/src/SwaggerProvider.DesignTime/v3/OperationCompiler.fs#L302-L303

using ProvidedApiClientBase

If you plan to fix this, we need:

• Add endpoint to Swashbuckle.WebApi.Server that generates similar schema (response in the header with 201 status code)
• Decide how we will deserialize type from header string to assume that header is formatted as json object.
• Ensure that fix is implemented for both TPs (Swagger and OpenApi)

[github-actions]

🤖 This is an automated response from Repo Assist.

Thanks for the detailed report! The maintainer's comment above lays out the path clearly. Here's a more concrete breakdown of what's needed, given the project's current state (the plan is for OpenApiClientProvider (v3) to be the primary provider going forward):

Root cause

OperationCompiler.fs infers the return type solely from the response body (lines ~426–438). It uses CallAsync to get the HttpResponseMessage but then only reads response.Content; headers on the response are never surfaced.

Implementation sketch

Step 1 — ProvidedApiClientBase / RuntimeHelpers: add a small helper to extract a named response header:

static member getResponseHeader (response: HttpResponseMessage) (name: string) : string option =
    match response.Headers.TryGetValues name with
    | true, vs -> Some (Seq.head vs)
    | _ ->
        match response.Content.Headers.TryGetValues name with
        | true, vs -> Some (Seq.head vs)
        | _ -> None

Step 2 — OperationCompiler.fs: in compileOperation, after response.Content is read, also extract the declared response headers and return them alongside the body. The return type would become a generated record/class with Body and any declared header properties. If the operation has no declared response headers, keep the current return type unchanged (no breaking change for existing users).

Step 3 — Swashbuckle.WebApi.Server: add a test endpoint that returns a Location header on 201 Created (as in the OP's YAML), so provider tests can assert the header is accessible.

Note on scope

Since SwaggerClientProvider (v2) is being deprecated, only the v3 OperationCompiler needs the change. The v2 path can be left as-is.

If anyone wants to pick this up, I'm happy to provide more detail on the specific lines to modify in OperationCompiler.fs. The key region is around line 426 in src/SwaggerProvider.DesignTime/v3/OperationCompiler.fs.

Generated by 🌈 Repo Assist, see workflow run. Learn more.

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/repo-assist.md@7ee2b60744abf71b985bead4599640f165edcd93