jsonrpc

Documentation

Index

• Constants
• func NewErrorResponse(ctx context.Context, requestId *string, err error) common.Response
• func NewHandler(p *proto.Schema, api *proto.Api) common.HandlerFunc
• func NewSuccessResponse(ctx context.Context, requestId string, response any, ...) common.Response
• type JsonRpcError
• type JsonRpcErrorResponse
• type JsonRpcRequest
  • func (r JsonRpcRequest) Valid() bool
• type JsonRpcSuccessResponse

Constants

const (
	// JSON-RPC spec compliant error codes
	JsonRpcParseErrorCode     = -32700
	JsonRpcInvalidRequestCode = -32600
	JsonRpcMethodNotFoundCode = -32601
	JsonRpcInvalidParams      = -32602
	JsonRpcInternalErrorCode  = -32603
	JsonRpcUnauthorized       = -32001 // Not part of the official spec
	JsonRpcForbidden          = -32003 // Not part of the official spec
)

Functions

func NewErrorResponse

func NewErrorResponse(ctx context.Context, requestId *string, err error) common.Response

func NewHandler

func NewHandler(p *proto.Schema, api *proto.Api) common.HandlerFunc

func NewSuccessResponse

func NewSuccessResponse(ctx context.Context, requestId string, response any, meta *common.ResponseMetadata) common.Response

Types

type JsonRpcError

type JsonRpcError struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
	Detail  any    `json:"detail,omitempty"`
}

type JsonRpcErrorResponse

type JsonRpcErrorResponse struct {
	JsonRpc string       `json:"jsonrpc"`
	ID      *string      `json:"id"`
	Error   JsonRpcError `json:"error"`
}

type JsonRpcRequest

type JsonRpcRequest struct {
	JsonRpc string         `json:"jsonrpc"`
	ID      string         `json:"id"`
	Method  string         `json:"method"`
	Params  map[string]any `json:"params"`
}

func (JsonRpcRequest) Valid

func (r JsonRpcRequest) Valid() bool

type JsonRpcSuccessResponse

type JsonRpcSuccessResponse struct {
	JsonRpc string `json:"jsonrpc"`
	ID      string `json:"id"`
	Result  any    `json:"result"`
}