Add Authorization header to OpenAPI docs #61
Conversation
flakey5
force-pushed
the
flakey5/openapi-auth
branch
2 times, most recently
from
b599fa0
to
e662307
Compare
There was a problem hiding this comment.
Hi, thank you for the PR. Adding a security schema seems like a correct idea from the spec point of view, but unfortunatelly this would not work with other platformatic openapi tools like client or composer. I think you need to add the authorization header to each route schema.
You will probably need the onRoute hook for that.
https://fastify.dev/docs/latest/Reference/Hooks/#onroute
And add the test for that, please.
Closes #43 Signed-off-by: flakey5 <[email protected]>
flakey5
force-pushed
the
flakey5/openapi-auth
branch
from
e662307
to
6c4abab
Compare
| fastify.route({ | ||
| url: '/api/v1/prompt', | ||
| method: 'POST', | ||
| schema: { | ||
| security, |
There was a problem hiding this comment.
Again, this is not enough for platformatic openapi tools. They just don't check for the security schemas now. What you need to do it to add an "Authorization" header to the route headers schema.
And I think it's better to use the onRoute hook to intercept app routes that you want to update.
Closes #43