Streaming API error handling/reporting improvements #5141
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
leo-da
force-pushed
the
leo-4521-error-reporting-1
branch
from
a2ddb61 to
b20bd4e
Compare
changelog_begin
[JSON API - Experimental] Change Streaming API error format to match synchronous API:
``{"status": <400 | 401 | 404 | 500>, "errors": <JSON array of strings> }``. See #4521
changelog_end
leo-da
requested review from
bame-da,
hurryabit,
nemanja-da and
S11001001
as code owners
S11001001
approved these changes
Mar 24, 2020
docs/source/json-api/index.rst
Outdated
| const ws = new WebSocket("ws://localhost:7575/v1/stream/query", [subprotocol]) | ||
|
|
||
| ws.on("open", function open() { | ||
| ws.send(`{"templateIds": ["Iou:Iou"]}`) |
There was a problem hiding this comment.
I think you would typically write the JS object as an object and then encode it to JSON, yes?
There was a problem hiding this comment.
this is Javascript, no types who cares :) but yeah JSON.stringify should do the trick. I will change it.
There was a problem hiding this comment.
ws.on("open", function open() {
ws.send(JSON.stringify({templateIds: ["Iou:Iou"]}))
})
There was a problem hiding this comment.
For sure :) you can at least catch dumb syntax typos like missing } or " this way.
|
@hurryabit I am going to merge it as is. The doc update will be in a separate PR. |
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.
Items 1 and 2 of: #4521
question about error reporting:
akka/akka-http#3023
TODO
Pull Request Checklist
CHANGELOG_BEGINandCHANGELOG_ENDtagsNOTE: CI is not automatically run on non-members pull-requests for security
reasons. The reviewer will have to comment with
/AzurePipelines runtotrigger the build.