API: Modify error and log responses in webserver rest API

[pcrespov]

Simplify by removing logger and adding a single message

• design format: check fastapi handlers
  • look for minimal footprint but maximal info
  • info depends on the application, check how can be used in front end
• front-end
  • user friendly message: what happened? why? tip on how to solve it.
• Related to Dump and review automatically all user messages (info, warnings, errors) following Z43 standards #6673

[pcrespov]

        details = [
            {
                "loc": ".".join(map(str, e["loc"])),
                "msg": e["msg"],
                "type": e["type"],
            }
            for e in err.errors()
        ]

        resp_payload= {
                    "error": {
                        "msg": reason_msg,
                        "resource": f"{resource}", # optional
                        "details": details, # optional
                    }
                }

[pcrespov]

class OneError(BaseModel):
    msg: str
    type_: str | None = Field(None, alias="type")
    loc: str | None = None


class ManyErrors(BaseModel):
    msg: str
    details: list[OneError] = []

[odeimaiz]

Current error model

{
  "data": null,
  "error": {
    "logs": [
      {
        "message": "Not sufficient access rights for product",
        "level": "ERROR",
        "logger": "user"
      }
    ],
    "errors": [
      {
        "code": "HTTPForbidden",
        "message": "Not sufficient access rights for product",
        "resource": null,
        "field": null
      }
    ],
    "status": 403,
    "message": "Not sufficient access rights for product"
  }
}

Most of the time it will be

{
  "data": null,
  "error": {
    "msg": "Sorry you do not have sufficient access rights for product"
  }
}

or simply (i.e. w/o data)

{
  "error": {
    "msg": "Sorry you do not have sufficient access rights for product"
  }
}

When the backend has an OEC it will be added as an supportId tag that the front end could present hidden as in

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

[matusdrobuliak66]

Odei would find it useful on the frontend if the 402 Payment Required error is raised also included additional fields, such as the current amount of credits in the wallet. For example:

{
  "data": null,
  "error": {
    "msg": "Sorry you do not have sufficient number of credits to perform this operation",
    "code": "HTTPPaymentRequired",
    "resource": "wallet",
    "amount": "-80.2",
    "wallet_name": "My Cool Wallet",
  }
}