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

Method Summary

Modifier and Type	Method and Description
public String	Returns: the callback URL callbackUrlExpression() An absolute URL which defines the destination which will be called with the supplied operation definition.
public Extension[]	Returns: array of extensions extensions() List of extensions to be added to the `Callback` model corresponding to the containing annotation.
public String	Returns: the name of this callback name() The friendly name used to refer to this callback.
public CallbackOperation[]	Returns: the callback operations operations() The array of operations that will be called out-of band
public String	pathItemRef() Reference value to a Path Item object, to be referenced by the Callback object.
public String	Returns: reference to a callback object definition ref() Reference value to a Callback object.

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

Method Detail

callbackUrlExpression	back to summary
public String callbackUrlExpression() An absolute URL which defines the destination which will be called with the supplied operation definition. It is a REQUIRED property unless this is only a reference to a callback instance. Returns:String the callback URL

callbackUrlExpression

back to summary

public String callbackUrlExpression()

An absolute URL which defines the destination which will be called with the supplied operation definition.

It is a REQUIRED property unless this is only a reference to a callback instance.

Returns:String: the callback URL

extensions back to summary

extensions	back to summary
public Extension[] extensions() List of extensions to be added to the `Callback` 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 Callback model corresponding to the containing annotation.

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

name back to summary

name	back to summary
public String name() The friendly name used to refer to this callback. It is a REQUIRED property unless this is only a reference to a callback. The name is REQUIRED when the callback is defined within `org.eclipse.microprofile.openapi.annotations.Components`. The name will be used as the key to add this callback to the 'callbacks' map for reuse. Returns:String the name of this callback

public String name()

The friendly name used to refer to this callback. It is a REQUIRED property unless this is only a reference to a callback.

The name is REQUIRED when the callback is defined within org.eclipse.microprofile.openapi.annotations.Components. The name will be used as the key to add this callback to the 'callbacks' map for reuse.

Returns:String: the name of this callback

operations	back to summary
public CallbackOperation[] operations() The array of operations that will be called out-of band Returns:CallbackOperation[] the callback operations

operations

back to summary

public CallbackOperation[] operations()

The array of operations that will be called out-of band

Returns:CallbackOperation[]: the callback operations

pathItemRef back to summary

pathItemRef	back to summary
public String pathItemRef() Reference value to a Path Item object, to be referenced by the Callback object. This property provides a reference to a Path Item object defined elsewhere. `#callbackUrlExpression()` is REQUIRED when this property is set. The referenced Path Item will be used for the URL expression specified. Since 4.0

public String pathItemRef()

Reference value to a Path Item object, to be referenced by the Callback object.

This property provides a reference to a Path Item object defined elsewhere. #callbackUrlExpression() is REQUIRED when this property is set. The referenced Path Item will be used for the URL expression specified.

Since: 4.0

ref back to summary

ref	back to summary
public String ref() Reference value to a Callback object. This property provides a reference to an object defined elsewhere. This property and all other properties are mutually exclusive. If other properties are defined in addition to the `ref` property then the result is undefined. Returns:String reference to a callback object definition

public String ref()

Reference value to a Callback object.

This property provides a reference to an object defined elsewhere. This property and all other properties are mutually exclusive. If other properties are defined in addition to the ref property then the result is undefined.

Returns:String: reference to a callback object definition

public @Interface Callback

Method Summary

Method Detail