@GitHK review: rm note and example

Author: pcrespov

services/api-server/src/simcore_service_api_server/exceptions/handlers/_utils.py

@@ -18,8 +18,6 @@ def create_error_json_response(
     Converts errors to Error response model defined in the OAS
     """
 
-    # NOTE: do not forget to add in the decorator `responses={ ???: {"model": ErrorGet} }`
-    # SEE https://fastapi.tiangolo.com/advanced/additional-responses/#additional-response-with-model
     error_model = ErrorGet(errors=list(errors))
     return JSONResponse(
         content=jsonable_encoder(error_model),

services/api-server/src/simcore_service_api_server/models/schemas/errors.py

@@ -1,4 +1,4 @@
-from typing import Any
+from typing import Any, ClassVar
 
 from pydantic import BaseModel
 
@@ -10,3 +10,8 @@ class ErrorGet(BaseModel):
     #   - https://github.com/ITISFoundation/osparc-simcore/issues/2520
     #   - https://github.com/ITISFoundation/osparc-simcore/issues/2446
     errors: list[Any]
+
+    class Config:
+        schema_extra: ClassVar[dict[str, Any]] = {
+            "example": ["some error message", "another error message"]
+        }