🎨 Filter autogenerated api-keys when listing #7855
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
giancarloromeo
added
the
a:webserver
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #7855 +/- ##
==========================================
+ Coverage 87.89% 88.21% +0.32%
==========================================
Files 1836 1474 -362
Lines 71014 61242 -9772
Branches 1219 476 -743
==========================================
- Hits 62415 54025 -8390
+ Misses 8256 7096 -1160
+ Partials 343 121 -222
Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the API key management by introducing a filter for auto‐generated API keys when listing them.
- Updated the list API endpoint to accept a new query parameter ("includeAutogenerated") which controls whether auto-generated keys are returned.
- Added new tests and fixtures to verify the filter behavior.
- Updated OpenAPI specifications and related modules to reflect the changes in API behavior.
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/unit/with_dbs/01/test_api_keys.py | Added fake_auto_api_keys fixture and tests to verify filtering of autogenerated API keys |
| src/simcore_service_webserver/api_keys/_service.py | Updated list_api_keys signature to include the include_autogenerated flag |
| src/simcore_service_webserver/api_keys/_repository.py | Modified the SQL query to conditionally filter out auto-generated API keys based on the new flag |
| src/simcore_service_webserver/api_keys/_controller/rest.py | Updated the endpoint controller to handle query parameters for filtering autogenerated keys |
| src/simcore_service_webserver/api/v0/openapi.yaml | Revised OpenAPI definitions to add a POST endpoint for key creation and a GET endpoint supporting the new query parameter |
| services/director-v2/src/simcore_service_director_v2/modules/osparc_variables/_api_auth.py | Updated auto-generated API key naming scheme to use the new prefix constant |
| packages/models-library/src/models_library/auth.py | Introduced API_KEY_AUTOGENERATED_PREFIX constant for consistency |
| packages/models-library/src/models_library/api_schemas_webserver/auth.py | Added a new ApiKeyListQueryParams schema to support query parameter in API key listing |
| api/specs/web-server/_auth_api_keys.py | Updated FastAPI endpoint definitions to incorporate the new query parameter via dependency injection |
Comments suppressed due to low confidence (1)
services/web/server/src/simcore_service_webserver/api_keys/_repository.py:171
- Consider adding a brief comment here to explain that this condition filters out auto-generated API keys based on the display_name prefix.
if not include_autogenerated:
bisgaard-itis
approved these changes
Jun 10, 2025
Contributor
bisgaard-itis
left a comment
bisgaard-itis
left a comment
There was a problem hiding this comment.
Thanks a lot for the quick fix
GitHK
approved these changes
Jun 10, 2025
Contributor
GitHK
left a comment
GitHK
left a comment
There was a problem hiding this comment.
OK, but please consider my comment
services/web/server/src/simcore_service_webserver/api_keys/_repository.py
Show resolved
Hide resolved
…ncarloromeo/osparc-simcore into is7852/filter-autogenerated-api-keys
giancarloromeo
commented
Jun 10, 2025
services/web/server/src/simcore_service_webserver/api_keys/_repository.py
Show resolved
Hide resolved
sanderegg
approved these changes
Jun 10, 2025
Contributor
Author
|
@Mergifyio queue |
Contributor
🛑 The pull request has been removed from the queue
|
|
Contributor
|
This pull request has been removed from the queue for the following reason: The merge conditions cannot be satisfied due to failing checks:You may have to fix your CI before adding the pull request to the queue again. |
giancarloromeo
merged commit 1ce595e
into
ITISFoundation:master
145 of 149 checks passed
This was referenced Jun 17, 2025
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
What do these changes do?
This PR enhances the list API Keys endpoint, adding a new query parameter (
includeAutogenerated) that filters out (by default) the autogenerated ones.Related issue/s
How to test
Dev-ops