-
Notifications
You must be signed in to change notification settings - Fork 30
♻️ Updates public API openapi specs (under dev) and cleanup #4437
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
♻️ Updates public API openapi specs (under dev) and cleanup #4437
Conversation
0d48e79
to
a0b1e82
Compare
Codecov Report
@@ Coverage Diff @@
## master #4437 +/- ##
========================================
- Coverage 83.8% 81.0% -2.8%
========================================
Files 999 861 -138
Lines 42792 37331 -5461
Branches 1016 634 -382
========================================
- Hits 35871 30259 -5612
- Misses 6700 6923 +223
+ Partials 221 149 -72
Flags with carried forward coverage won't be shown. Click here to find out more.
|
d212008
to
4d5b2a9
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Please check out my comments.
services/api-server/src/simcore_service_api_server/api/routes/files.py
Outdated
Show resolved
Hide resolved
services/api-server/src/simcore_service_api_server/core/redoc.py
Outdated
Show resolved
Hide resolved
services/api-server/src/simcore_service_api_server/models/schemas/jobs.py
Show resolved
Hide resolved
67de386
to
6b862b2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please check the storage settings.
Also feel free to change the ruff settings, see https://github.com/ITISFoundation/osparc-simcore/pull/4429/files#diff-b3236d4cb260ca6acce083493fcdc42816f732fc3d5aefb263a3c3fe9db4f81f
otherwise all good!
services/api-server/src/simcore_service_api_server/api/routes/_common.py
Show resolved
Hide resolved
services/api-server/src/simcore_service_api_server/api/routes/files.py
Outdated
Show resolved
Hide resolved
services/api-server/src/simcore_service_api_server/api/routes/solvers.py
Outdated
Show resolved
Hide resolved
services/api-server/src/simcore_service_api_server/api/routes/solvers.py
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
Code Climate has analyzed commit 5af8004 and detected 0 issues on this pull request. View more on Code Climate. |
Kudos, SonarCloud Quality Gate passed!
|
What do these changes do?
This PR updates the openapi specs (OAS) with changes planned for the api-server. In addition, I increased the code-coverage by improving the fixtures and dropping unused code modules/scripts.
GET /v0/files/page
GET /v0/solvers/page
GET /v0/solversreleases/page
GET /v0/solvers/{solver_key}/releases/page
GET /v0/solvers/{solver_key}/releases/{version}/ports
GET /v0/solvers/{solver_key}/releases/{version}/jobs/page
GET /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}/metadata
POST /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}/metadata
GET /v0/studies/
GET /v0/studies/{study_id}
GET /v0/studies/{study_id}/ports
GET /v0/studies/{study_id}/jobs
POST /v0/studies/{study_id}/jobs
GET /v0/studies/{study_id}/jobs/{job_id}
DELETE /v0/studies/{study_id}/jobs/{job_id}
POST /v0/studies/{study_id}/jobs/{job_id}:start
POST /v0/studies/{study_id}/jobs/{job_id}:stop
POST /v0/studies/{study_id}/jobs/{job_id}:inspect
POST /v0/studies/{study_id}/jobs/{job_id}/outputs
POST /v0/studies/{study_id}/jobs/{job_id}/outputs/logfile
GET /v0/studies/{study_id}/jobs/{job_id}/metadata
POST /v0/studies/{study_id}/jobs/{job_id}/metadata
DELETE /v0/files/{file_id}
DELETE /v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}
- existing listings are complemented with
/page
- new listings incorporate pagination from the start
- listings with small number of elements, incorporate
OnePage
. Makes sense? Perhaps we should include pagination to everything by default?fastapi-pagination
services/api-server/tests/unit/test__mocks_captures.py
mocked_webserver_service_api_base
mocked_catalog_service_api_base
mocked_directorv2_service_api_base
mocked_storage_service_api_base
model_library.api_schema_*
Annotated
Related issue/s
How to test
cd services/api-server make install-dev make test-dev
DevOps
None