http-rpc-api

alltypes

@Target([AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER]) annotation class HttpRpcGET

HttpRpcGET(path: String = "", title: String = "", description: String = "", responseDescription: String = "")
val description: String
val path: String
val responseDescription: String
val title: String

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

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

@Target([AnnotationTarget.FUNCTION]) annotation class HttpRpcPOST

HttpRpcPOST(path: String = "", title: String = "", description: String = "", responseDescription: String = "")
val description: String
val path: String
val responseDescription: String
val title: String

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

HttpRpcQueryParameter(name: String = "", description: String = "", required: Boolean = true, default: String = "")
val default: String
val description: String
val name: String
val required: Boolean

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

HttpRpcRequestBodyParameter(name: String = "", description: String = "", required: Boolean = true)
val description: String
val name: String
val required: Boolean

@Target([AnnotationTarget.CLASS]) annotation class HttpRpcResource

HttpRpcResource(name: String = "", description: String = "", path: String = "")
val description: String
val name: String
val path: String

kotlin.Annotation

fun Annotation.isHttpRpcParameterAnnotation(): Boolean

package net.corda.v5.httprpc.api.annotations

@Target([AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER]) annotation class HttpRpcGET

HttpRpcGET(path: String = "", title: String = "", description: String = "", responseDescription: String = "")
val description: String
val path: String
val responseDescription: String
val title: String

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

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

@Target([AnnotationTarget.FUNCTION]) annotation class HttpRpcPOST

HttpRpcPOST(path: String = "", title: String = "", description: String = "", responseDescription: String = "")
val description: String
val path: String
val responseDescription: String
val title: String

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

HttpRpcQueryParameter(name: String = "", description: String = "", required: Boolean = true, default: String = "")
val default: String
val description: String
val name: String
val required: Boolean

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

HttpRpcRequestBodyParameter(name: String = "", description: String = "", required: Boolean = true)
val description: String
val name: String
val required: Boolean

@Target([AnnotationTarget.CLASS]) annotation class HttpRpcResource

HttpRpcResource(name: String = "", description: String = "", path: String = "")
val description: String
val name: String
val path: String

kotlin.Annotation

fun Annotation.isHttpRpcParameterAnnotation(): Boolean