🎨 web-api: Simpler error models and auto-generated errors in OAS

[pcrespov]

What do these changes do?

This PR implements various enhancements on error models

• 🎨 Auto document error responses in openapi specs using error handling maps (_TO_HTTP_ERROR_MAP) :

  from simcore_service_webserver.folders._exceptions_handlers import _TO_HTTP_ERROR_MAP
  
  router = APIRouter(
      prefix=f"/{API_VTAG}",
      tags=[
          "folders",
      ],
      responses={
          i.status_code: {"model": EnvelopedError} for i in _TO_HTTP_ERROR_MAP.values() # <---
      },
  )

  • Here we apply it in for folders and worskspace resources
  • A preview of the reDoc
    
• 🎨 Simplified model for errors .
  • New models_library.rest_error
  • Old fields have been marked as deprecated (i.e. still usable) and will be retired when the front-end adapts to the new model
  • Example

  {
    "data": null,
    "error": {
      "msg": "OOps this error was unexpected. we are working on that!",
      "supportId": "OEC:12346789",
    }
  }

• 🎨 update logging default formatting to include log_oec capture.

Related issue/s

• Preparation for 🎨 web-server: exception handling framework #6655

How to test

Dev-ops checklist

[codecov]

Codecov Report

Attention: Patch coverage is 91.93548% with 5 lines in your changes missing coverage. Please review.

Project coverage is 88.37%. Comparing base (573b7c3) to head (1f1770a).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6855      +/-   ##
==========================================
- Coverage   88.39%   88.37%   -0.02%     
==========================================
  Files        1550     1550              
  Lines       61764    61777      +13     
  Branches     2112     2165      +53     
==========================================
+ Hits        54597    54598       +1     
- Misses       6837     6848      +11     
- Partials      330      331       +1     

Flag	Coverage Δ
integrationtests	64.76% <100.00%> (-0.01%)	⬇️
unittests	86.30% <91.93%> (-0.02%)	⬇️

Components	Coverage Δ
api	78.42% <ø> (ø)
pkg_aws_library	93.28% <ø> (ø)
pkg_dask_task_models_library	96.57% <ø> (ø)
pkg_models_library	91.22% <97.43%> (+0.05%)	⬆️
pkg_notifications_library	84.57% <ø> (ø)
pkg_postgres_database	87.52% <ø> (ø)
pkg_service_integration	70.00% <ø> (ø)
pkg_service_library	75.91% <81.81%> (-0.21%)	⬇️
pkg_settings_library	90.62% <ø> (ø)
pkg_simcore_sdk	85.36% <ø> (ø)
agent	97.00% <ø> (ø)
api_server	89.72% <ø> (ø)
autoscaling	95.21% <ø> (ø)
catalog	90.57% <ø> (ø)
clusters_keeper	98.73% <ø> (ø)
dask_sidecar	91.26% <ø> (ø)
datcore_adapter	93.17% <ø> (ø)
director	76.49% <ø> (ø)
director_v2	91.04% <ø> (-0.10%)	⬇️
dynamic_scheduler	96.59% <ø> (ø)
dynamic_sidecar	89.75% <ø> (ø)
efs_guardian	90.12% <ø> (ø)
invitations	93.44% <ø> (ø)
osparc_gateway_server	85.49% <ø> (ø)
payments	92.76% <ø> (ø)
resource_usage_tracker	90.64% <ø> (ø)
storage	89.66% <ø> (ø)
webclient	∅ <ø> (∅)
webserver	88.68% <100.00%> (ø)

---

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 573b7c3...1f1770a. Read the comment docs.

[odeimaiz]

👌

[sonarqubecloud]

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