All endpoints (except the paginated ones) have been checked to be backwards compatible on the commit c72f500. This was done my running the following script from services/api-server

make openapi.json
../../scripts/openapi-diff.bash breaking https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/4abb9f23e99c5cd854e348a81f8e8e4e4c88c691/services/api-server/openapi.json \
    /specs/openapi.json  \
    --flatten-allof \
    --unmatch-path "^/v0/credits/price$|^/v0/files$|^/v0/files/content$|^/v0/me$|^/v0/solvers$|^/v0/solvers/releases$|^/v0/files/{file_id}$|^/v0/files/{file_id}:complete$|^/v0/solvers/{solver_key}/latest$|^/v0/solvers/{solver_key}/releases$|^/v0/solvers/{solver_key}/releases/{version}$|^/v0/solvers/{solver_key}/releases/{version}/jobs$|^/v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}$|^/v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}/metadata$|^/v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}/outputs$|^/v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}/wallet$|^/v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}:start$|^/v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}:inspect$|^/v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}:stop$|^/v0/studies/{study_id}$|^/v0/studies/{study_id}/jobs$|^/v0/studies/{study_id}/jobs/{job_id}/metadata$|^/v0/studies/{study_id}/jobs/{job_id}/outputs$|^/v0/studies/{study_id}/jobs/{job_id}:inspect$|^/v0/studies/{study_id}/jobs/{job_id}:start$|^/v0/studies/{study_id}/jobs/{job_id}:stop$|^/v0/studies/{study_id}:clone$|^/v0/wallets/default$|^/v0/wallets/{wallet_id}$"

The unmatched paths in this command are there due to a bug in pydantic v1 or an earlier version of openapi. The point is that the openapi specs changed for all these endpoints, but the actual endpoints didn't. I.e. previously the specs didn't match the actual API 💩. I checked manually that these endpoints did not actually break backwards compatibility. The endpoints which are still to be checked are the following paginated endpoints:

• GET /v0/files:search
• GET /v0/solvers/{solver_key}/releases/{version}/jobs/page
• GET /v0/solvers/{solver_key}/releases/{version}/ports
• GET /v0/studies
• GET /v0/studies/{study_id}/ports
  In order to check these I will need your help @pcrespov because I still don't fully understand how the pagination works.

Conclusion: In order to ensure backwards compatibility of further changes can be done against commit c72f500

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.35%. Comparing base (1f9c110) to head (62955cd).
Report is 1 commits behind head on master.

@@            Coverage Diff             @@
##           master    #6866      +/-   ##
==========================================
- Coverage   88.34%   86.35%   -1.99%     
==========================================
  Files        1568      902     -666     
  Lines       61498    40074   -21424     
  Branches     2001      262    -1739     
==========================================
- Hits        54331    34607   -19724     
+ Misses       6832     5407    -1425     
+ Partials      335       60     -275     

All endpoints (except the paginated ones) have been checked to be backwards compatible on the commit c72f500. This was done my running the following script from services/api-server

make openapi.json
../../scripts/openapi-diff.bash breaking https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/4abb9f23e99c5cd854e348a81f8e8e4e4c88c691/services/api-server/openapi.json \
    /specs/openapi.json  \
    --flatten-allof \
    --unmatch-path "^/v0/credits/price$|^/v0/files$|^/v0/files/content$|^/v0/me$|^/v0/solvers$|^/v0/solvers/releases$|^/v0/files/{file_id}$|^/v0/files/{file_id}:complete$|^/v0/solvers/{solver_key}/latest$|^/v0/solvers/{solver_key}/releases$|^/v0/solvers/{solver_key}/releases/{version}$|^/v0/solvers/{solver_key}/releases/{version}/jobs$|^/v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}$|^/v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}/metadata$|^/v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}/outputs$|^/v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}/wallet$|^/v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}:start$|^/v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}:inspect$|^/v0/solvers/{solver_key}/releases/{version}/jobs/{job_id}:stop$|^/v0/studies/{study_id}$|^/v0/studies/{study_id}/jobs$|^/v0/studies/{study_id}/jobs/{job_id}/metadata$|^/v0/studies/{study_id}/jobs/{job_id}/outputs$|^/v0/studies/{study_id}/jobs/{job_id}:inspect$|^/v0/studies/{study_id}/jobs/{job_id}:start$|^/v0/studies/{study_id}/jobs/{job_id}:stop$|^/v0/studies/{study_id}:clone$|^/v0/wallets/default$|^/v0/wallets/{wallet_id}$"

The unmatched paths in this command are there due to a bug in pydantic v1 or an earlier version of openapi. The point is that the openapi specs changed for all these endpoints, but the actual endpoints didn't. I.e. previously the specs didn't match the actual API 💩. I checked manually that these endpoints did not actually break backwards compatibility. The endpoints which are still to be checked are the following paginated endpoints:

* [x]  GET /v0/files:search

* [x]  GET /v0/solvers/{solver_key}/releases/{version}/jobs/page

* [x]  GET /v0/solvers/{solver_key}/releases/{version}/ports

* [x]  GET /v0/studies

* [x]  GET /v0/studies/{study_id}/ports
  In order to check these I will need your help @pcrespov because I still don't fully understand how the pagination works.

Conclusion: In order to ensure backwards compatibility of further changes can be done against commit c72f500

Update: These last remaining endpoints were checked together with Pedro.

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud