http-rpc-api / net.corda.v5.httprpc.api.annotations / HttpRpcPathParameter

HttpRpcPathParameter

@Target([AnnotationTarget.VALUE_PARAMETER]) annotation class HttpRpcPathParameter

Marks a function parameter of a function annotated with @HttpRpcGET or @HttpRpcPOST as a path parameter.

Path parameters need to also be defined in the endpoint's path, in the form of "/:parameter/".

Constructors

<init>

Marks a function parameter of a function annotated with @HttpRpcGET or @HttpRpcPOST as a path parameter.

HttpRpcPathParameter(name: String = "", description: String = "")

Properties

description

The description of the path parameter, used for documentation. Defaults to empty string.

val description: String

name

The name of the path parameter within the endpoint's path. Should be specified in lower case. Defaults to the parameter's name in the function signature.

val name: String