Link
data class Link(val operationRef: String? = null, val operationId: String? = null, val parameters: ExtensionProperties? = null, val requestBody: GenericElement? = null, val description: String? = null, val server: Server? = null, val extensions: ExtensionProperties? = null) : Extensible(source)
Represents a possible design-time link for a response. The presence of a link does not guarantee the caller's ability to successfully invoke it, but it does provide a known relationship and traversal mechanism between responses and other operations.
Constructors
Link copied to clipboard
constructor(operationRef: String? = null, operationId: String? = null, parameters: ExtensionProperties? = null, requestBody: GenericElement? = null, description: String? = null, server: Server? = null, extensions: ExtensionProperties? = null)
Types
Properties
Link copied to clipboard
A description of the link.
Link copied to clipboard
Specification-extensions for this link (keys must start with x-).
Link copied to clipboard
The name of an existing, resolvable OAS operation, as defined with a unique operationId.
Link copied to clipboard
A relative or absolute URI reference to an OAS operation.
Link copied to clipboard
A map of parameters to pass to the operation as specified with operationId or identified via operationRef.
Link copied to clipboard
A literal value or expression to use as a request body when calling the target operation.