MicroProfile 7.0 · org.eclipse.microprofile.openapi.annotations.callbacks.CallbackOperation

Method Summary

Modifier and Type	Method and Description
public String	Returns: a description of this callback operation description() A verbose description of the callback operation behavior.
public Extension[]	Returns: array of extensions extensions() List of extensions to be added to the `Operation` model corresponding to the containing annotation.
public ExternalDocumentation	Returns: external documentation associated with this callback operation instance externalDocs() Additional external documentation for this callback operation.
public String	Returns: the HTTP method of this callback operation method() The HTTP method for this callback operation.
public Parameter[]	Returns: the list of parameters for this callback operation parameters() An array of parameters applicable for this callback operation, which will be added to any automatically detected parameters in the method itself.
public RequestBody	Returns: the request body of this callback operation requestBody() The request body applicable for this callback operation.
public APIResponse[]	Returns: the list of responses for this callback operation responses() This is a REQUIRED property of an callback operation instance.
public SecurityRequirement[]	Returns: the list of security mechanisms for this callback operation security() A declaration of which security mechanisms can be used for this callback operation.
public SecurityRequirementsSet[]	Returns: the list of security mechanisms for this callback operation securitySets() A declaration of which security mechanisms can be used for this callback operation.
public String	Returns: a summary of this callback operation summary() Provides a brief description of what this callback operation does.

Inherited from java.lang.annotation.Annotation:: annotationType equals hashCode toString

Method Detail

description	back to summary
public String description() A verbose description of the callback operation behavior. CommonMark syntax MAY be used for rich text representation. Returns:String a description of this callback operation

description

back to summary

public String description()

A verbose description of the callback operation behavior. CommonMark syntax MAY be used for rich text representation.

Returns:String: a description of this callback operation

extensions back to summary

extensions	back to summary
public Extension[] extensions() List of extensions to be added to the `Operation` model corresponding to the containing annotation. Returns:Extension[] array of extensions Since 3.1

public Extension[] extensions()

List of extensions to be added to the Operation model corresponding to the containing annotation.

Returns:Extension[]: array of extensions
Since: 3.1

externalDocs	back to summary
public ExternalDocumentation externalDocs() Additional external documentation for this callback operation. Returns:ExternalDocumentation external documentation associated with this callback operation instance

externalDocs

back to summary

public ExternalDocumentation externalDocs()

Additional external documentation for this callback operation.

Returns:ExternalDocumentation: external documentation associated with this callback operation instance

method	back to summary
public String method() The HTTP method for this callback operation. Returns:String the HTTP method of this callback operation

method

back to summary

public String method()

The HTTP method for this callback operation.

Returns:String: the HTTP method of this callback operation

parameters	back to summary
public Parameter[] parameters() An array of parameters applicable for this callback operation, which will be added to any automatically detected parameters in the method itself. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. Returns:Parameter[] the list of parameters for this callback operation

parameters

back to summary

public Parameter[] parameters()

An array of parameters applicable for this callback operation, which will be added to any automatically detected parameters in the method itself.

The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location.

Returns:Parameter[]: the list of parameters for this callback operation

requestBody	back to summary
public RequestBody requestBody() The request body applicable for this callback operation. Returns:RequestBody the request body of this callback operation

requestBody

back to summary

public RequestBody requestBody()

The request body applicable for this callback operation.

Returns:RequestBody: the request body of this callback operation

responses	back to summary
public APIResponse[] responses() This is a REQUIRED property of an callback operation instance. The list of possible responses as they are returned from executing this callback operation. Returns:APIResponse[] the list of responses for this callback operation

responses

back to summary

public APIResponse[] responses()

This is a REQUIRED property of an callback operation instance.

The list of possible responses as they are returned from executing this callback operation.

Returns:APIResponse[]: the list of responses for this callback operation

security back to summary

security	back to summary
public SecurityRequirement[] security() A declaration of which security mechanisms can be used for this callback operation. Only one of the security requirement objects need to be satisfied to authorize a request. Adding a `SecurityRequirement` to this array is equivalent to adding a `SecurityRequirementsSet` containing a single `SecurityRequirement` to `securitySets()`. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used. Returns:SecurityRequirement[] the list of security mechanisms for this callback operation

public SecurityRequirement[] security()

A declaration of which security mechanisms can be used for this callback operation. Only one of the security requirement objects need to be satisfied to authorize a request.

Adding a SecurityRequirement to this array is equivalent to adding a SecurityRequirementsSet containing a single SecurityRequirement to securitySets().

This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.

Returns:SecurityRequirement[]: the list of security mechanisms for this callback operation

securitySets	back to summary
public SecurityRequirementsSet[] securitySets() A declaration of which security mechanisms can be used for this callback operation. All of the security requirements within any one of the sets needs needs to be satisfied to authorize a request. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used. Including an empty set within this list indicates that the other requirements are optional. Returns:SecurityRequirementsSet[] the list of security mechanisms for this callback operation

securitySets

back to summary

public SecurityRequirementsSet[] securitySets()

A declaration of which security mechanisms can be used for this callback operation. All of the security requirements within any one of the sets needs needs to be satisfied to authorize a request.

This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.

Including an empty set within this list indicates that the other requirements are optional.

Returns:SecurityRequirementsSet[]: the list of security mechanisms for this callback operation

summary	back to summary
public String summary() Provides a brief description of what this callback operation does. Returns:String a summary of this callback operation

summary

back to summary

public String summary()

Provides a brief description of what this callback operation does.

Returns:String: a summary of this callback operation

public @Interface CallbackOperation

Method Summary

Method Detail