[API] Add Swagger UI authorization header support #9110
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit introduces a new method to enhance the Swagger UI by allowing users to add a custom authorization header.
TomerShor
reviewed
Dec 23, 2025
Comment on lines
+186
to
+191
| openapi_schema["components"]["securitySchemes"]["Authorization"] = { | ||
| "type": "apiKey", | ||
| "in": "header", | ||
| "name": "Authorization", | ||
| "description": "Enter your authorization header token. Example: Bearer <token>", | ||
| } |
Member
There was a problem hiding this comment.
While this will work, OpenAPI has a specific bearer security schema type. see https://swagger.io/docs/specification/v3_0/authentication/bearer-authentication/
Member
Author
There was a problem hiding this comment.
yes, but mlrun supports basic auth as well, and etc. so .. kept this one generic enough
TomerShor
approved these changes
Dec 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Description
This change improves the usability of the API documentation by facilitating token-based authentication for users.
🛠️ Changes Made
Added
_add_swagger_authorizationmethod which modifies the OpenAPI schema to include a security scheme for the "Authorization" header, making it available globally in the Swagger UI.✅ Checklist
🧪 Testing
Manual testings on igz3/4
🔗 References
🚨 Breaking Changes?
🔍️ Additional Notes