Parameters¶

JSON-RPC supports both positional and named parameters. Flask-JSONRPC maps these directly to Python function arguments.

Positional Parameters¶

Consider:

@jsonrpc.method("math.pow")
def power(a: int, b: int) -> int:
    return a ** b

Call using a positional array:

{"method": "math.pow", "params": [2, 8]}

Keyword arguments require a JSON object:

@jsonrpc.method("greeting.welcome")
def welcome(*, name: str) -> str:
    return f"Welcome, {name}!"

Call:

{"method": "greeting.welcome", "params": {"name": "Alice"}}

Default parameter values work normally:

@jsonrpc.method("math.inc")
def inc(x: int, *, amount: int = 1):
    return x + amount

You may accept variable positional arguments:

@jsonrpc.method("math.sum")
def total(*values: int) -> int:
    return sum(values)