✨ public-api 0.7.1: adds version_display field in the Solver response model
#7694
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
pcrespov
added
a:api
pcrespov
requested review from
GitHK,
bisgaard-itis,
Copilot,
matusdrobuliak66,
mguidon and
sanderegg
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new field, version_display, into the Solver response model and updates API route descriptions and tests accordingly. The key changes include:
- Adding the version_display field to the Solver model with corresponding updates in factory methods.
- Updating API routes to include changelog entries documenting the introduction of version_display.
- Refactoring and extending API tests to cover the new endpoints and behavior.
Reviewed Changes
Copilot reviewed 3 out of 6 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| services/api-server/tests/unit/api_solvers/test_api_routers_solvers.py | Renamed and added tests for improved clarity on solver endpoints, including pagination and release-fetching functionality. |
| services/api-server/src/simcore_service_api_server/models/schemas/solvers.py | Added the version_display field with type annotations and updated factory methods to assign its value. |
| services/api-server/src/simcore_service_api_server/api/routes/solvers.py | Updated endpoint descriptions with changelog entries to document version_display changes and refined route implementations. |
Files not reviewed (3)
- services/api-server/VERSION: Language not supported
- services/api-server/openapi.json: Language not supported
- services/api-server/setup.cfg: Language not supported
Comments suppressed due to low confidence (2)
services/api-server/src/simcore_service_api_server/models/schemas/solvers.py:44
- [nitpick] Consider expanding the documentation for the 'version_display' field to clarify its intended format and use case for future maintainers.
version_display: Annotated[str | None, Field(description="A user-friendly or marketing name for the release.")] = None
services/api-server/tests/unit/api_solvers/test_api_routers_solvers.py:123
- [nitpick] Consider renaming 'test_list_solver_ports_again' to a more descriptive name that clearly indicates its specific purpose, to avoid potential confusion with similar tests.
async def test_list_solver_ports_again(
matusdrobuliak66
approved these changes
May 16, 2025
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #7694 +/- ##
===========================================
- Coverage 87.55% 69.10% -18.46%
===========================================
Files 1804 794 -1010
Lines 70198 36709 -33489
Branches 1137 170 -967
===========================================
- Hits 61465 25368 -36097
- Misses 8423 11283 +2860
+ Partials 310 58 -252
Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
giancarloromeo
approved these changes
May 16, 2025
|
@mergify queue |
🟠 Waiting for conditions to match
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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?
version_displayinSolverresponse model (version bump 0.7.0 → 0.7.1)Related issue/s
How to test
Dev-ops
None