search

casper-network / casper-sidecar

Apache License 2.0
2 stars 8 forks source link

[SIDECAR] Api version response header #237

Closed zajko closed 6 months ago

zajko commented 8 months ago

AC: Data returned from the REST API of sidecar should be wrapped in an envelope. Header of that envelope shoudl contain network_name and api_version that were recorder for the sse event returned in payload field. An example would be:

{
    "header": {
        "api_version": "2.0.0",
        "network_name": "casper"
    },
    "payload": <JSON OF SSE EVENT>
}

Also, endpoints that return lists should return elements wrapped in the envelope:

[{
    "header": {
        "api_version": "2.0.0",
        "network_name": "casper"
    },
    "payload": <JSON OF SSE EVENT_1>
 },
{
    "header": {
        "api_version": "2.0.1",
        "network_name": "casper"
    },
    "payload": <JSON OF SSE EVENT_2>
}
]