Swagger decorator @ApiHeader is not including header on request

[douglasjunior]

Is there an existing issue for this?

• I have searched the existing issues

Current behavior

Swagger decorator @ApiHeader is not including header on request

Code

@Controller('template')
export class TemplateController {

  @Get('test')
  @ApiHeader({
    name: 'accept',
  })
  async test(@Headers('accept') acceptHeader: string) {

    return `ok: ${acceptHeader}`;
  }

}

Result

Minimum reproduction code

https://codesandbox.io/p/devbox/green-cache-5xjgvc

Steps to reproduce

Just create a new NestJS project and add a new Controller like TemplateController above.

Expected behavior

Expect that Swagger UI to include the proper accept value on request.

Package

• I don't know. Or some 3rd-party package
• @nestjs/common
• @nestjs/core
• @nestjs/microservices
• @nestjs/platform-express
• @nestjs/platform-fastify
• @nestjs/platform-socket.io
• @nestjs/platform-ws
• @nestjs/testing
• @nestjs/websockets
• Other (see below)

Other package

@nestjs/swagger

NestJS version

10.3.3

Packages versions

    "@nestjs/common": "10.3.3",
    "@nestjs/config": "3.2.0",
    "@nestjs/core": "10.3.3",
    "@nestjs/platform-express": "10.3.3",
    "@nestjs/swagger": "7.3.0",
    "class-transformer": "0.5.1",
    "class-validator": "0.14.1",

Node.js version

18.12.0

In which operating systems have you tested?

• macOS
• Windows
• Linux

Other

No response

[letsaguiar]

this problem is specifically related to the 'accept' header. It works fine with other headers, but it doesn't with the accept header

[douglasjunior]

Confirmed in the provided example: https://codesandbox.io/p/devbox/green-cache-5xjgvc

[micalevisk]

the OpenAPI spec generated looks like this:

openapi: 3.0.0
paths:
  /test:
    get:
      operationId: AppController_test
      parameters:
        - name: accept
          required: true
          in: header
          schema:
            type: string
      responses:
        '200':
          description: ''
info:
  title: Cats example
  description: The cats API description
  version: '1.0'
  contact: {}
tags:
  - name: cats
    description: ''
servers: []
components:
  schemas: {}

And this is related with swagger-api/swagger-ui#5567

[micalevisk]

so according with the spec, we are not supposed to define "Accept" ourselves. So I'd say that this is more a misuse of @ApiHeader() than a bug on @nestjs/swagger