🎨 public-api: cleanup openapi routes descriptions #7707
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #7707 +/- ##
===========================================
- Coverage 87.35% 69.07% -18.29%
===========================================
Files 1839 802 -1037
Lines 71084 36858 -34226
Branches 1203 174 -1029
===========================================
- Hits 62096 25459 -36637
- Misses 8660 11341 +2681
+ Partials 328 58 -270
Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
pcrespov
force-pushed
the
is7380/fix-listing-solvers
branch
from
86a2063 to
a84041e
Compare
pcrespov
changed the title
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the OpenAPI routes descriptions by refactoring inline description strings to use a consistent helper function (create_route_description) and updates the changelog versioning details for clarity.
- Refactored route descriptions in multiple endpoints to use create_route_description.
- Updated changelog version numbers and deprecation notices consistently.
- Revised documentation in the helper function to reflect its behavior.
Reviewed Changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| services/api-server/src/simcore_service_api_server/api/routes/wallets.py | Updated route descriptions with create_route_description. |
| services/api-server/src/simcore_service_api_server/api/routes/studies_jobs.py | Adjusted changelog versions and description texts for studies jobs. |
| services/api-server/src/simcore_service_api_server/api/routes/studies.py | Migrated to create_route_description and updated version numbers. |
| services/api-server/src/simcore_service_api_server/api/routes/solvers_jobs_read.py | Refactored description strings and updated version details. |
| services/api-server/src/simcore_service_api_server/api/routes/solvers_jobs.py | Updated several endpoints to use create_route_description and renamed functions for clarity. |
| services/api-server/src/simcore_service_api_server/api/routes/solvers.py | Modified route descriptions and updated changelog versioning. |
| services/api-server/src/simcore_service_api_server/api/routes/credits.py | Updated endpoint descriptions with create_route_description. |
| services/api-server/src/simcore_service_api_server/api/routes/_constants.py | Updated docstring for create_route_description; minor documentation changes. |
Files not reviewed (1)
- services/api-server/openapi.json: Language not supported
Comments suppressed due to low confidence (1)
services/api-server/src/simcore_service_api_server/api/routes/studies_jobs.py:217
- Consider correcting the grammar in the base description to 'Get a job for a given study' for clarity.
base="Gets a jobs for a given study",
services/api-server/src/simcore_service_api_server/api/routes/_constants.py
Show resolved
Hide resolved
pcrespov
changed the title
Member
Author
|
@mergify queue |
Contributor
🟠 Waiting for conditions to match
|
sanderegg
approved these changes
May 20, 2025
matusdrobuliak66
approved these changes
May 21, 2025
|
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 pull request introduces multiple updates to the API server's OpenAPI documentation and route definitions. The changes focus on improving descriptions, aligning versioning formats, and enhancing consistency in route definitions. Additionally, deprecated routes and changelog details have been updated for clarity.
Here an example. SEE badge above for details on new doc.
Related issue/s
How to test
Dev-ops
None