Entity envelope in rest api #252
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zajko
force-pushed
the
entity_envelope_in_rest_api
branch
4 times, most recently
from
e500033 to
bedeb9e
Compare
|
LGTM |
… event. Instead we wrap the sse events in an envelope which looks like:
```
{
"header": {
"api_version": "2.0.0",
"network_name": "casper"
},
"payload": {(...)}
}
```
Events in endpoints that return lists (like signatures for block) will also have each individual element of the list wrapped in such envelope.
In the above the header fields:
* "api_version" is the api version which was reported in the ApiVersion message for the node that we fetched the event from.
* "network_name" is the "chainspec_name" field that was returned in the "/status" endpoint for the node that we fetched the event from.
zajko
force-pushed
the
entity_envelope_in_rest_api
branch
from
bedeb9e to
e544f78
Compare
jacek-casper
approved these changes
Mar 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changed REST API endpoint so that they don't return simply the stored event. Instead we wrap the sse events in an envelope which looks like:
{ "header": { "api_version": "2.0.0", "network_name": "casper" }, "payload": {(...)} }