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.
A linked operation MUST be identified using either an operationRef or
operationId. In the case of an operationId, it MUST be unique and
resolved in the scope of the OAS document. Because of the potential
for name clashes, the operationRef syntax is preferred for specifications
with external references.
A relative or absolute URI 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.
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).
Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.
For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl,
then mod1.relativePathTo(mod2) will return List("dir2", "dir3").
A common use case is to compute the directory path between a template located at the root of a hierarchy
(say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
The Link object represents a possible design-time link for a response.