Comments (8)
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.
Related Issues (20)
- TypeScript errors TS4023, TS4094 HOT 11
- Multiple servers in Swagger HOT 2
- Export request/response types from generated client HOT 5
- Listening to a configurable hostname HOT 1
- Insufficient types export (TS4023) of `Metadata` HOT 1
- Task: fix NPM warning during publishing
- Cannot create multiple errors response when generate Document
- Set schema name using withMeta
- Type regression from 16.1.0 to 16.2.0 HOT 3
- incorrect pattern field for openapi HOT 4
- What tool did you use to make the handdrawn diagram?
- OpenApi yaml spec has wrong minimum value for doubles HOT 6
- Allow all express-fileupload configurations HOT 5
- winston detetction not sufficient HOT 10
- tsc error when trying to build using the getting started instructions HOT 7
- Is it possible to add custom documentation generation for my custom zod types HOT 2
- Duplicated headers in request body in generated docs (POST, PATCH, etc.) HOT 10
- Customising logger with winston erroring out in v19 HOT 17
- Default number range for `z.number()` causes `openapi-generator-cli generate` to fail HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from express-zod-api.