Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.
And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.
[Help] Clarify how to use custom apiKey security definition
See original GitHub issueHi all! I am trying to generate documentation for my API routes which require HMAC-SHA256 authentication. This means that I have to include Authorization header for every request which consists of API key and generated HMAC signature separated by colon (e.g. Authorization: API_KEY:GENERATED_SIGNATURE).
I can easily generate the needed signature with JavaScript, but I cannot figure out how to add “key” and “secret” input fields in Swagger-UI “Authorize” pop-up and how to finally add it to Authorization header in each request.
Is something like this possible with OpenAPI Specification v3 at all? Any help/tip/link is extremely appreciated!
Issue Analytics
- State:
- Created 6 years ago
- Reactions:2
- Comments:9 (5 by maintainers)
Top Results From Across the Web
Top Related Medium Post
Top Related StackOverflow Question
Troubleshoot Live Code
Top Related Reddit Thread
Top Related Hackernoon Post
Top Related Tweet
Top Related Dev.to Post
Top Related Hashnode Post
@skt44 Either tooling decides to support a commonly used but non-registered scheme, or it implements a plug-in mechanism in the case of client codegen, or it is simply a documentation hint to API consumers.
@darrelmiller thanks - in your hmac example, where would the function that calculates the hash be defined (since it isn’t a registered scheme)?