Roundup Tracker - Issues


Author rouilj
Recipients rouilj
Date 2022-11-03.02:07:23
Message-id <>
Problem Details for HTTP APIs:
details the shape of a json response for an error API return value.

example return:

   HTTP/1.1 403 Forbidden
   Content-Type: application/problem+json
   Content-Language: en

    "type": "",
    "title": "You do not have enough credit.",
    "detail": "Your current balance is 30, but that costs 50.",
    "instance": "/account/12345/msgs/abc",
    "balance": 30,
    "status":  403,
    "accounts": ["/account/12345",

We already supply the status property.

We also have msg property that probably maps to the title property. The title property can be 

Type is the unique key for this type of error. The title property can be localized so
can't be used as the key. This URL could map to a document on the roundup web site
with more detailed info about the error, but as a key just needs to be unique if not

Instance probably maps the the url that triggered the error.

rfc7807 does allow extensions to the json format, so the msg property can remain
for backwards compatibility.

However we wrap the object with an error object:

    "error": {
        "status": 404,
        "msg": "Nothing matches the given URI"

so the wrapper may need to be removed at some point. Probably in v2 of the rest interface.

Further reading:
Date User Action Args
2022-11-03 02:07:24rouiljsetrecipients: + rouilj
2022-11-03 02:07:24rouiljsetmessageid: <>
2022-11-03 02:07:23rouiljlinkissue2551237 messages
2022-11-03 02:07:23rouiljcreate