Specifying input headers about express-zod-api HOT 8 CLOSED

very impressive :D

from express-zod-api.

To be more clear, I´m looking for a way to specify input like this x-header-param open-api snippet:

/path:
    get:
      parameters:
        - name: x-header-param
          in: header
          required: true
          schema:
            type: string
        - name: otherProp
          in: query
          required: false
          schema:
            type: boolean
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponeDefinition'

from express-zod-api.

You'd need to make a middleware, that inspects the request headers. The middleware should return an object that becomes "options" parameter for the endpoint's handler. This way you can provide the data acquired from headers to the endpoints, in case the headers carry out more than authentication. @andnilsson

from express-zod-api.

To be more clear, I´m looking for a way to specify input like this x-header-param open-api snippet

parameters:

• name: x-header-param
  in: header

Currently headers are not considered as an input source for request parameters, but only as a way of authentication, that's why they are only available for describing as a part of security schemas in OpenAPI.
I understand your need, though I never experienced such a requirement. I need to check if OpenAPI even allows such ways of describing parameter location as header. @andnilsson

from express-zod-api.

yeah, @andnilsson , I found it in the specification.
OpenAPI definitely has in: header.
I'd consider this as a feature request in this regard.

from express-zod-api.

If implementing this feature, it's going to be limited to the custom headers only (those beginning with X-).
I hope it suits your needs.
And most likely they will be converted to the lower case, @andnilsson

https://swagger.io/docs/specification/describing-parameters/#header-parameters

from express-zod-api.

It sure does, awesome!

from express-zod-api.

@andnilsson , the feature released in version 12.2.0 🚀

from express-zod-api.