@Target([AnnotationTarget.VALUE_PARAMETER]) annotation class HttpRpcRequestBodyParameter
Marks a function parameter of an @HttpRpcPOST annotated function as a nested body parameter of the top-level json object.
<init> |
Marks a function parameter of an @HttpRpcPOST annotated function as a nested body parameter of the top-level json object. HttpRpcRequestBodyParameter(name: String = "", description: String = "", required: Boolean = true) |
description |
The description of the parameter, used for documentation. Defaults to empty string. val description: String |
name |
The name of the body parameter in the call. Defaults to the parameter's name in the function signature. val name: String |
required |
Whether the body is required when making an http call. Defaults to true. val required: Boolean |