@Target(value={}) @Retention(value=RUNTIME) @Inherited public @interface CallbackOperation
Modifier and Type | Optional Element and Description |
---|---|
String |
description
A verbose description of the callback operation behavior.
|
Extension[] |
extensions
The list of optional extensions.
|
ExternalDocumentation |
externalDocs
Additional external documentation for this callback operation.
|
String |
method
The HTTP method for this callback operation.
|
Parameter[] |
parameters
An array of parameters applicable for this callback operation,
which will be added to any automatically detected parameters in the method itself.
|
RequestBody |
requestBody
The request body applicable for this callback operation.
|
APIResponse[] |
responses
This is a REQUIRED property of an callback operation instance.
|
SecurityRequirement[] |
security
A declaration of which security mechanisms can be used for this callback operation.
|
String |
summary
Provides a brief description of what this callback operation does.
|
public abstract String method
public abstract String summary
public abstract String description
public abstract ExternalDocumentation externalDocs
public abstract Parameter[] parameters
The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location.
public abstract RequestBody requestBody
public abstract APIResponse[] responses
The list of possible responses as they are returned from executing this callback operation.
public abstract SecurityRequirement[] security
This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.
public abstract Extension[] extensions
Copyright © 2017–2018 Eclipse MicroProfile. All rights reserved.