Skip to content
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

👽️ ✨ document status codes in api server #5386

Conversation

bisgaard-itis
Copy link
Contributor

@bisgaard-itis bisgaard-itis commented Feb 28, 2024

What do these changes do?

  • Document status codes in api-server openapi specs.
  • This documentation is probably still not perfect. But at least it documents the main types of exceptions that can happen in the api-server

Related issue/s

How to test

Dev Checklist

DevOps Checklist

@bisgaard-itis bisgaard-itis self-assigned this Feb 28, 2024
@bisgaard-itis bisgaard-itis added a:doc documentation, reporting, admin tasks a:apiserver api-server service labels Feb 28, 2024
@bisgaard-itis bisgaard-itis added this to the Schoggilebe milestone Feb 28, 2024
Copy link

codecov bot commented Feb 28, 2024

Codecov Report

Attention: Patch coverage is 96.42857% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 66.0%. Comparing base (2aa73cc) to head (4c9aff1).
Report is 11 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##           master   #5386      +/-   ##
=========================================
- Coverage    87.5%   66.0%   -21.6%     
=========================================
  Files        1322     618     -704     
  Lines       54234   30020   -24214     
  Branches     1175     204     -971     
=========================================
- Hits        47479   19814   -27665     
- Misses       6506   10154    +3648     
+ Partials      249      52     -197     
Flag Coverage Δ
integrationtests 64.1% <ø> (-1.0%) ⬇️
unittests 84.8% <96.4%> (-0.6%) ⬇️

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

Files Coverage Δ
...c/simcore_service_api_server/api/routes/_common.py 100.0% <100.0%> (ø)
...c/simcore_service_api_server/api/routes/solvers.py 62.7% <100.0%> (+2.7%) ⬆️
...core_service_api_server/api/routes/solvers_jobs.py 96.7% <100.0%> (+0.9%) ⬆️
...vice_api_server/api/routes/solvers_jobs_getters.py 93.0% <100.0%> (+0.3%) ⬆️
...core_service_api_server/api/routes/studies_jobs.py 59.2% <100.0%> (ø)
...src/simcore_service_api_server/api/routes/users.py 100.0% <100.0%> (ø)
...c/simcore_service_api_server/api/routes/wallets.py 100.0% <100.0%> (ø)
...src/simcore_service_api_server/services/catalog.py 67.0% <100.0%> (ø)
...simcore_service_api_server/services/director_v2.py 76.9% <100.0%> (ø)
..._api_server/services/service_exception_handling.py 80.8% <100.0%> (ø)
... and 3 more

... and 1056 files with indirect coverage changes

@bisgaard-itis bisgaard-itis changed the title 👽️ ✨ 5369 document status codes in api server 👽️ ✨ document status codes in api server Feb 28, 2024
@bisgaard-itis bisgaard-itis marked this pull request as ready for review February 28, 2024 10:41
Copy link
Contributor

@GitHK GitHK left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Member

@pcrespov pcrespov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, this goes in a nice direction. I will contribute later to it with automatic generation of those from error handler mapping mechanism i am creating as well

Left some suggestions

@bisgaard-itis bisgaard-itis requested a review from pcrespov March 1, 2024 14:08
Copy link
Member

@pcrespov pcrespov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All looks good but please double check the ErrorGet model issue I comment before merging.
Let me know if you want to look at it together.
thx!

@bisgaard-itis bisgaard-itis enabled auto-merge (squash) March 5, 2024 12:14
Copy link

sonarqubecloud bot commented Mar 5, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@bisgaard-itis bisgaard-itis merged commit b4d276d into ITISFoundation:master Mar 5, 2024
55 checks passed
@bisgaard-itis bisgaard-itis deleted the 5369-document-status-codes-in-api-server branch March 5, 2024 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a:apiserver api-server service a:doc documentation, reporting, admin tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add all status codes to openapi specs for api-server
5 participants