♻️ Enhanced groups/organizations web-api specs and validation 🚨

[pcrespov]

What do these changes do?

During a debugging session with @odeimaiz, we observed that the Swagger site was displaying an incorrect interface for the /groups endpoints. The web API lacked properly defined OpenAPI Specifications (OAS) since this plugin hadn’t yet been updated to use Pydantic models.

This PR addresses the problem by updating the OAS generator code and models in api/webserver, ensuring the new OAS correctly represent the interface and is better documented. Additionally, it now introduces input validation in the handler functions through these models, which wasn’t in place before. For now, output validation is enabled only in debug mode.

We also manually verified all client calls to this resource in order to ensure compatibility with the frontend.

Related issue/s

• Closes Maintenance: update the schemas for group resources #3499
• Part of Use new models in groups plugin #3361

How to test

• Driving test

cd services/web/server
make install-dev
pytest -vv tests/unit/with_dbs/*/test_*group*.py

• 🚨 Review manually front-end using functionality that calls GET /me and GET /group/*** (with @odeimaiz )

Dev-ops

None

[codecov]

Codecov Report

Attention: Patch coverage is 88.50575% with 10 lines in your changes missing coverage. Please review.

Project coverage is 87.80%. Comparing base (2f0cfb0) to head (3977a66).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6640      +/-   ##
==========================================
- Coverage   87.93%   87.80%   -0.14%     
==========================================
  Files        1564     1405     -159     
  Lines       62950    59373    -3577     
  Branches     2104     1599     -505     
==========================================
- Hits        55358    52135    -3223     
+ Misses       7267     6979     -288     
+ Partials      325      259      -66     

Flag	Coverage Δ
integrationtests	64.81% <25.53%> (-0.04%)	⬇️
unittests	85.65% <88.50%> (-0.26%)	⬇️

Components	Coverage Δ
api	79.60% <ø> (ø)
pkg_aws_library	∅ <ø> (∅)
pkg_dask_task_models_library	∅ <ø> (∅)
pkg_models_library	92.19% <100.00%> (+0.05%)	⬆️
pkg_notifications_library	∅ <ø> (∅)
pkg_postgres_database	∅ <ø> (∅)
pkg_service_integration	71.44% <ø> (ø)
pkg_service_library	76.53% <ø> (ø)
pkg_settings_library	∅ <ø> (∅)
pkg_simcore_sdk	85.27% <ø> (ø)
agent	97.17% <ø> (ø)
api_server	89.82% <ø> (ø)
autoscaling	95.26% <ø> (ø)
catalog	89.52% <ø> (ø)
clusters_keeper	98.85% <ø> (ø)
dask_sidecar	91.32% <ø> (ø)
datcore_adapter	94.05% <ø> (ø)
director	58.43% <ø> (+0.04%)	⬆️
director_v2	90.81% <ø> (-0.10%)	⬇️
dynamic_scheduler	96.72% <ø> (ø)
dynamic_sidecar	89.79% <ø> (ø)
efs_guardian	90.00% <ø> (ø)
invitations	93.51% <ø> (ø)
osparc_gateway_server	85.15% <ø> (ø)
payments	93.09% <ø> (ø)
resource_usage_tracker	90.75% <ø> (ø)
storage	89.75% <ø> (ø)
webclient	∅ <ø> (∅)
webserver	89.28% <78.72%> (-0.03%)	⬇️

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2f0cfb0...3977a66. Read the comment docs.

[sanderegg]

thanks

[bisgaard-itis]

Very nice! Thanks a lot for the effort

[GitHK]

commented above

[GitHK]

All good cleared in person

[sonarcloud]

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 SonarCloud