Uncertainty about WebRTC Error definition

[helu-milestone]

In the WebRTC specification the following is written about an error:

This message is a [JSON-RPC] "Request notification" and shall include [JSON-RPC] "Error object" in its params field.

According to JSON-RPC specification (https://www.jsonrpc.org/specification), an "Error object" should contain an error member with the same members as defined by in ONVIF WebRTC. But does that mean that the Error should look like this:

{"jsonrpc": "2.0", "params": {"error": {"code": -32700, "message": "Parse error"}}} or simply
{"jsonrpc": "2.0", "params": {"code": -32700, "message": "Parse error"}}

Or is the ONVIF specification a bit of when talking about the params field in an error? Should the error object follow the JSON-RPC describtion of an Error(without id), as the ONVIF Spec writes that it shuld be a notification:

{"jsonrpc": "2.0", "error": {"code": -32700, "message": "Parse error"}}

[jflevesque-genetec]

Hi Henrik,

I can confirm that we follow the jsonrpc spec for the error. Here is an example with a fictious error code and error message:

{
  "id": "some id",
  "error":
  {
    "code": 1004,
    "message": "Unknown session"
  },
  "jsonrpc": "2.0"
}

[helu-milestone]

Great, this is what I would prefer. In the specification it states:

This message is a [JSON-RPC] "Request notification" and shall include [JSON-RPC] "Error object" in its params
field.

The confusion part here is that a "Request Notification" does not exists in the JSON-RPC spec. The closest is a Notification which states that the message should not include an Id (https://www.jsonrpc.org/specification#notification).

To make it clear that we want a JSON-RPC error, I would like to change the specification to:

This message is a [JSON-RPC] "Response" and shall include [JSON-RPC] "Error object". If the error is not connected to a request, but sent a a notification, the id should be set to null

In the examples I'll add these two errors to remove any uncertainties:
{"jsonrpc": "2.0", "error": {"code": -32601, "message": "Method not found"}, "id": "1"}
{"jsonrpc": "2.0", "error": {"code": 1001, "message": "Insufficient resources"}, "id": null}

I'll add you to the code review, so you can see it all put together, but let me know if you would prefer it to be different.

[bsriramprasad]

Ref: https://www.onvif.org/specs/stream/ONVIF-WebRTC-Spec.pdf, Section 5.2.5

• This message is a [JSON-RPC] "Request notification" and shall include [JSON-RPC] "Error object" in its params field.
  • This text may need clarification/update based on discussion.

[helu-milestone]

To summarize the talk, the message should be as jflevesque-genetec writes. The text in the specification will be updated to remove any misunderstanding and add examples of errors.