@Target(value={}) @Retention(value=RUNTIME) @Inherited public @interface Link
Modifier and Type | Optional Element and Description |
---|---|
String |
description
A description of the link.
|
String |
name
The name of this link.
|
String |
operationId
The name of an existing, resolvable OAS operation, as defined with a unique operationId.
|
String |
operationRef
A relative or absolute reference to an OAS operation.
|
LinkParameter[] |
parameters
Array of parameters to pass to an operation as specified with operationId or identified via operationRef.
|
String |
ref
Reference value to a Link object.
|
String |
requestBody
A literal value or {expression} to use as a request body when calling the target operation.
|
Server |
server
An alternative server to service this operation.
|
public abstract String name
The name is REQUIRED when the link is defined within Components
. The
name will be used as the key to add this link to the 'links' map for reuse.
public abstract String operationRef
public abstract String operationId
public abstract LinkParameter[] parameters
public abstract String description
public abstract String requestBody
public abstract Server server
public abstract String ref
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.
Copyright © 2017 – 2020 Eclipse Foundation. All rights reserved.
Use is subject to license terms.