Add helper to describe API-key authentication in OpenAPI spec#763
Add helper to describe API-key authentication in OpenAPI spec#763ushahid88 wants to merge 2 commits intoKaliumhexacyanoferrat:mainfrom
Conversation
|
Thank you very much for your contribution - will give a review the next few days! |
Thank you for taking the time to look at it, please let me know if further changes are required, I’ll be happy to update the PR. |
|
Thanks - while the changes suggested work, the users will typically expect the framework to automatically pick up the authentication and to adjust the generated OpenAPI document accordingly. For this to work, we can:
It is fine for this to work only with API keys for now (in constract to JWT, basic auth, mTLS, ...), nevertheless the logic needs to be generic (so no api key in the wording of the concepts and functions). I hope this can give you a picture how this feature is intended to work - if you would like, you can adjust this PR accordingly, otherwise I will give it a try later this month. |
This PR addresses issue #685 by adding a helper to describe API-key based authentication in the generated OpenAPI document.
Tests pass for .net8.0 and .net10.0 locally.