JSONRPC Schemas

[Jack-Above]

Hello all,

I was looking for JSONRPC response schemas and found them in yaml in openapi.yaml. However, these appear to be incorrect. For instance, on BroadcastTxResponse, both result and error are required, but the API returns one or the other exclusively. Also, error is declared as type: string, but an object is returned in testing.

We are using v0.34.16; anything I am missing here? Thanks in advance.

[thanethomson]

You are correct - the OpenAPI spec is incorrect in a couple of places.

I think the original authors meant that either result or error are required. I'm not sure how to represent that according to the OpenAPI spec. I assume we could simply just make both of them not required?

With regard to the ErrorResponse type, while the OpenAPI spec claims that the error is a string, this is actually the object that is returned:

tendermint/rpc/jsonrpc/types/types.go

Lines 154 to 159 in cceea4d

	type RPCResponse struct {
	JSONRPC string `json:"jsonrpc"`
	ID jsonrpcid `json:"id,omitempty"`
	Result json.RawMessage `json:"result,omitempty"`
	Error *RPCError `json:"error,omitempty"`
	}

And the error part is actually this object:

tendermint/rpc/jsonrpc/types/types.go

Lines 140 to 144 in cceea4d

	type RPCError struct {
	Code int `json:"code"`
	Message string `json:"message"`
	Data string `json:"data,omitempty"`
	}

I'll convert this discussion into an issue so we can fix this.