Skip to content

♻️ api-server: openapi docs and versioning #6264

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

Merged
merged 17 commits into from
Aug 30, 2024

Conversation

pcrespov
Copy link
Member

@pcrespov pcrespov commented Aug 28, 2024

What do these changes do?

None critical changes for the api-server to align with the new release strategy developed for the client in ITISFoundation/osparc-simcore-clients#180

  • 📝 new formatted messages for changelog
  • ♻️ new version identifier if API_SERVER_DEV_FEATURES_ENABLED=1
    - the OAS exposes all entrypoint (some are hidden in production)
    - Changes to a development version M.m.p.post0.dev
    - The resulting OAS can be obtained also using make openapi-dev.json
  • 📝 makefile recipes to produce OAS diffs between different versions

Related issue/s

How to test

Dev-ops checklist

None

@pcrespov pcrespov self-assigned this Aug 28, 2024
Copy link

codecov bot commented Aug 28, 2024

Codecov Report

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

Project coverage is 67.0%. Comparing base (cafbf96) to head (4ac262a).
Report is 485 commits behind head on master.

Files with missing lines Patch % Lines
...src/simcore_service_api_server/core/application.py 83.3% 2 Missing ⚠️
Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff            @@
##           master   #6264      +/-   ##
=========================================
- Coverage    84.5%   67.0%   -17.6%     
=========================================
  Files          10     657     +647     
  Lines         214   32230   +32016     
  Branches       25     260     +235     
=========================================
+ Hits          181   21600   +21419     
- Misses         23   10570   +10547     
- Partials       10      60      +50     
Flag Coverage Δ
integrationtests 64.8% <ø> (?)
unittests 89.8% <92.0%> (+5.2%) ⬆️

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

Files with missing lines Coverage Δ
...imcore_service_api_server/api/routes/_constants.py 100.0% <100.0%> (ø)
...c/simcore_service_api_server/api/routes/credits.py 100.0% <100.0%> (ø)
...src/simcore_service_api_server/api/routes/files.py 78.5% <ø> (ø)
...c/simcore_service_api_server/api/routes/solvers.py 65.4% <100.0%> (ø)
...core_service_api_server/api/routes/solvers_jobs.py 100.0% <100.0%> (ø)
...vice_api_server/api/routes/solvers_jobs_getters.py 93.3% <100.0%> (ø)
...c/simcore_service_api_server/api/routes/studies.py 100.0% <100.0%> (ø)
...core_service_api_server/api/routes/studies_jobs.py 94.1% <100.0%> (ø)
...src/simcore_service_api_server/core/application.py 94.1% <83.3%> (ø)

... and 658 files with indirect coverage changes

@pcrespov pcrespov added the a:apiserver api-server service label Aug 28, 2024
@pcrespov pcrespov added this to the Eisbock milestone Aug 28, 2024
@pcrespov pcrespov force-pushed the is1611/iter-pages-api-server branch from 94d1e99 to 9e554b0 Compare August 29, 2024 16:19
@pcrespov pcrespov changed the title WIP: ✨ Is1611/iter pages api server ♻️ api-server: openapi docs and versioning Aug 29, 2024
@pcrespov pcrespov marked this pull request as ready for review August 29, 2024 16:50
@pcrespov pcrespov enabled auto-merge (squash) August 29, 2024 16:50
Copy link
Collaborator

@matusdrobuliak66 matusdrobuliak66 left a comment

Choose a reason for hiding this comment

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

Thanks!

Copy link
Member

@sanderegg sanderegg left a comment

Choose a reason for hiding this comment

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

thanks

@pcrespov pcrespov force-pushed the is1611/iter-pages-api-server branch from 112acbe to 4ac262a Compare August 30, 2024 08:39
Copy link

@pcrespov pcrespov merged commit 4bcaaed into ITISFoundation:master Aug 30, 2024
56 checks passed
@pcrespov pcrespov deleted the is1611/iter-pages-api-server branch August 30, 2024 09: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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants