MicroProfile 7.0 · org.eclipse.microprofile.openapi.annotations.links.Link

Method Summary

Modifier and Type	Method and Description
public String	Returns: the link's description description() A description of the link.
public Extension[]	Returns: array of extensions extensions() List of extensions to be added to the `Link` model corresponding to the containing annotation.
public String	Returns: the link's name name() The name of this link.
public String	Returns: an operation ID operationId() The name of an existing, resolvable OAS operation, as defined with a unique operationId.
public String	Returns: an operation reference operationRef() A relative or absolute reference to an OAS operation.
public LinkParameter[]	Returns: the list of parameters for this link parameters() Array of parameters to pass to an operation as specified with operationId or identified via operationRef.
public String	Returns: reference to a link ref() Reference value to a Link object.
public String	Returns: the request body of this link requestBody() A literal value or {expression} to use as a request body when calling the target operation.
public Server	Returns: the server associated to this link server() An alternative server to service this operation.

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

Method Detail

description	back to summary
public String description() A description of the link. CommonMark syntax may be used for rich text representation. Returns:String the link's description

description

back to summary

public String description()

A description of the link. CommonMark syntax may be used for rich text representation.

Returns:String: the link's description

extensions back to summary

extensions	back to summary
public Extension[] extensions() List of extensions to be added to the `Link` 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 Link 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 name of this link. The name is REQUIRED when the link is defined within `org.eclipse.microprofile.openapi.annotations.Components`. The name will be used as the key to add this link to the 'links' map for reuse. Returns:String the link's name

public String name()

The name of this link.

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

Returns:String: the link's name

operationId	back to summary
public String operationId() The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field. Returns:String an operation ID

operationId

back to summary

public String operationId()

The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.

Returns:String: an operation ID

operationRef	back to summary
public String operationRef() A relative or absolute reference to an OAS operation. This field is mutually exclusive of the operationId field, and must point to an Operation Object. Relative operationRef values may be used to locate an existing Operation Object in the OpenAPI definition. Ignored if the operationId property is specified. Returns:String an operation reference

operationRef

back to summary

public String operationRef()

A relative or absolute reference to an OAS operation. This field is mutually exclusive of the operationId field, and must point to an Operation Object. Relative operationRef values may be used to locate an existing Operation Object in the OpenAPI definition. Ignored if the operationId property is specified.

Returns:String: an operation reference

parameters	back to summary
public LinkParameter[] parameters() Array of parameters to pass to an operation as specified with operationId or identified via operationRef. Returns:LinkParameter[] the list of parameters for this link

parameters

back to summary

public LinkParameter[] parameters()

Array of parameters to pass to an operation as specified with operationId or identified via operationRef.

Returns:LinkParameter[]: the list of parameters for this link

ref back to summary

ref	back to summary
public String ref() Reference value to a Link object. This property provides a reference to an object defined elsewhere. This property may be used with `description()` but is mutually exclusive with all other properties. If properties other than `description` are defined in addition to the `ref` property then the result is undefined. Returns:String reference to a link

public String ref()

Reference value to a Link object.

This property provides a reference to an object defined elsewhere. This property may be used with description() but is mutually exclusive with all other properties. If properties other than description are defined in addition to the ref property then the result is undefined.

Returns:String: reference to a link

requestBody	back to summary
public String requestBody() A literal value or {expression} to use as a request body when calling the target operation. Returns:String the request body of this link

requestBody

back to summary

public String requestBody()

A literal value or {expression} to use as a request body when calling the target operation.

Returns:String: the request body of this link

server	back to summary
public Server server() An alternative server to service this operation. Returns:Server the server associated to this link

server

back to summary

public Server server()

An alternative server to service this operation.

Returns:Server: the server associated to this link

public @Interface Link

Method Summary

Method Detail