View Source OpenApiSpex.Link (open_api_spex v3.16.0)

Defines the OpenApiSpex.Link.t type.

Link to this section Summary

Link to this section Types

@type t() :: %OpenApiSpex.Link{
  description: String.t() | nil,
  extensions: %{required(String.t()) => any()} | nil,
  operationId: String.t() | nil,
  operationRef: String.t() | nil,
  parameters: %{required(String.t()) => any()} | nil,
  requestBody: any(),
  server: OpenApiSpex.Server.t() | nil
}

Link Object

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.