Class: Yori::Schema::V3::Link

Inherits:
Yori::SchemaBase show all
Defined in:
lib/yori/schema/v3/link.rb

Overview

Link:

The Link object 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,
rather it provides a known relationship and traversal mechanism between responses and other operations.
Unlike dynamic links (i.e. links provided in the response payload),
the OAS linking mechanism does not require link information in the runtime response.
For computing links, and providing instructions to execute them,
a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation.

Instance Attribute Summary

Attributes inherited from Yori::SchemaBase

#id

Instance Method Summary collapse

Methods inherited from Yori::SchemaBase

eval_class!, eval_hash!, eval_input!, #ref, #validator

Instance Method Details

#description ⇒ Object

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



35
 
# File 'lib/yori/schema/v3/link.rb', line 35

fields :description

#operationId ⇒ Object

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



24
 
# File 'lib/yori/schema/v3/link.rb', line 24

fields :operationRef, :operationId

#operationRef ⇒ Object

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.



24
 
# File 'lib/yori/schema/v3/link.rb', line 24

fields :operationRef, :operationId

#parameters ⇒ Object

A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the parameter location [in.]name for operations that use the same parameter name in different locations (e.g. path.id).



29
 
# File 'lib/yori/schema/v3/link.rb', line 29

hash_field_block :parameters, :parameter, Yori::Schema::Any

#requestBody ⇒ Object

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



32
 
# File 'lib/yori/schema/v3/link.rb', line 32

field_block :requestBody, Yori::Schema::Any

#server ⇒ Object

A server object to be used by the target operation.



38
 
# File 'lib/yori/schema/v3/link.rb', line 38

field_block :server, Yori::Schema::V3::Server

#validate! ⇒ Object 



40
41
42
 
# File 'lib/yori/schema/v3/link.rb', line 40

def validate!
  validate_mutually_exclusive_fields!('operationId', 'operationRef')
end