http-rpc-api
Module Contents
alltypes
Module Contents
@Target
(
[AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER]
)
annotation
class
HttpRpcGET
Module Contents
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
Module Contents
HttpRpcPathParameter
(
name
:
String
=
""
,
description
:
String
=
""
)
val
description
:
String
val
name
:
String
@Target
(
[AnnotationTarget.FUNCTION]
)
annotation
class
HttpRpcPOST
Module Contents
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
Module Contents
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
Module Contents
HttpRpcRequestBodyParameter
(
name
:
String
=
""
,
description
:
String
=
""
,
required
:
Boolean
=
true
)
val
description
:
String
val
name
:
String
val
required
:
Boolean
@Target
(
[AnnotationTarget.CLASS]
)
annotation
class
HttpRpcResource
Module Contents
HttpRpcResource
(
name
:
String
=
""
,
description
:
String
=
""
,
path
:
String
=
""
)
val
description
:
String
val
name
:
String
val
path
:
String
kotlin.Annotation
Module Contents
fun
Annotation
.
isHttpRpcParameterAnnotation
(
)
:
Boolean
package
net.corda.v5.httprpc.api.annotations
Module Contents
@Target
(
[AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY_GETTER]
)
annotation
class
HttpRpcGET
Module Contents
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
Module Contents
HttpRpcPathParameter
(
name
:
String
=
""
,
description
:
String
=
""
)
val
description
:
String
val
name
:
String
@Target
(
[AnnotationTarget.FUNCTION]
)
annotation
class
HttpRpcPOST
Module Contents
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
Module Contents
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
Module Contents
HttpRpcRequestBodyParameter
(
name
:
String
=
""
,
description
:
String
=
""
,
required
:
Boolean
=
true
)
val
description
:
String
val
name
:
String
val
required
:
Boolean
@Target
(
[AnnotationTarget.CLASS]
)
annotation
class
HttpRpcResource
Module Contents
HttpRpcResource
(
name
:
String
=
""
,
description
:
String
=
""
,
path
:
String
=
""
)
val
description
:
String
val
name
:
String
val
path
:
String
kotlin.Annotation
Module Contents
fun
Annotation
.
isHttpRpcParameterAnnotation
(
)
:
Boolean