✨ defines openapi specs for new studies resources

[pcrespov]

What do these changes do?

Drafts the openapi specs (OAS) for a new studies collections and missing operations in current resources. NOTE that this PR only addresses the OAS, i.e. all handlers will raise NotImplementeError if queried and are only active in with API_SERVER_DEV_FEATURES_ENABLED=1

The idea of this PR is to draft the interface and create tests for the issues requested so far as a starting point for its implementation.

Highlights

• ✨ OAS for studies collections
• ✨ OAS missing operations in current resources (see related issues)
• 🔨 make openapi-dev.json produces OAS with API_SERVER_DEV_FEATURES_ENABLED=1

Related issue/s

• related to PublicAPI: studies w/ computational services #4177: defines study OAS
• related to PublicAPI: Allow to delete jobs #4111: defines delete job OAS

How to test

• prepare tests for implementation
• Can render new OAS. This PR includes (temporary) openapi-dev.json so the review can explore the new definitions using https://petstore.swagger.io/?url=https://raw.githubusercontent.com/ITISFoundation/osparc-simcore/b95953661d79408f2ef88b100ed2b2a9ed3b7b97/services/api-server/openapi-dev.json

Follow up

• @bisgaard-itis can you try to create the client?
• @sanderegg I would like to check with you how to connect some of the implementations

[codecov]

Codecov Report

Merging #4250 (a0bbd5c) into master (b004ab1) will increase coverage by 2.2%.
The diff coverage is 81.0%.

@@           Coverage Diff            @@
##           master   #4250     +/-   ##
========================================
+ Coverage    83.7%   86.0%   +2.2%     
========================================
  Files         974     817    -157     
  Lines       41921   36160   -5761     
  Branches      964     551    -413     
========================================
- Hits        35112   31113   -3999     
+ Misses       6601    4915   -1686     
+ Partials      208     132     -76     

Flag	Coverage Δ
integrationtests	67.2% <ø> (+17.0%)	⬆️
unittests	82.7% <81.0%> (+<0.1%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
...c/simcore_service_api_server/api/routes/studies.py	90.0% <71.4%> (-10.0%)	⬇️
.../service-library/src/servicelib/fastapi/openapi.py	75.8% <75.0%> (ø)
...core_service_api_server/api/routes/studies_jobs.py	77.5% <77.5%> (ø)
...-server/src/simcore_service_api_server/api/root.py	100.0% <100.0%> (ø)
...c/simcore_service_api_server/api/routes/_common.py	100.0% <100.0%> (ø)
...core_service_api_server/api/routes/solvers_jobs.py	62.0% <100.0%> (+1.9%)	⬆️
...mcore_service_api_server/models/schemas/studies.py	100.0% <100.0%> (ø)

... and 217 files with indirect coverage changes

[bisgaard-itis]

Looks good to me. Just a single suggestion and a question.

[GitHK]

Maybe listen to what DK has to say about the env vars

[codeclimate]

Code Climate has analyzed commit a0bbd5c and detected 0 issues on this pull request.

View more on Code Climate.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication