docusaurus-openapi-docs
docusaurus-openapi-docs copied to clipboard
Missing information in the API key value in the Authorization header in all the sample codes
Describe the bug
In the code samples, we find Authorizationas <API_KEY_VALUE>.
However, when we use JWT, the <API_KEY_VALUE> requires a prefix (JWT ).
That is not clear in the code sample, and our clients are stumbling on it.
Expected behavior
Show the expected syntax for the Authorization header value.
Current behavior
The current value that is shown <API_KEY_VALUE> is not sufficient.
Possible solution
a) Add a configuration to add a prefix:
- Before the <API_KEY_VALUE>.
- In the JWT Authentication input in the REQUEST.
b) Or, add a configuration to set a text instead of the default <API_KEY_VALUE>.
Screenshots
Context
Our clients have difficulty in understanding the syntax of the authentication header due to the missing JWT .
Your Environment
Version used: Plugin version is 2.1.3 Environment name and version: Chrome 123.0.6312.124, node.js 20.12.2 Operating System and version: Mac
Hi @JaimeOVasconcelos have you tried to solve this using swizzle?
Hey @sserrata! No, I didn't try to swizzle. I've opted to add a JavaScript script that does the trick. The bug is to let you guys know about it, and maybe incorporate new configurations in future improvements.