open_api_spex

v3.4.0

open_api_spex v3.4.0 OpenApiSpex.Server View Source

Defines the OpenApiSpex.Server.t type.

Link to this section Summary

Types

t()

Server Object

Functions

from_endpoint(endpoint)

Builds a Server from a phoenix Endpoint module

from_endpoint(endpoint, opts) deprecated

Builds a Server from a phoenix Endpoint module

Link to this section Types

Link to this type

t() View Source 
t() :: %OpenApiSpex.Server{
  description: String.t() | nil,
  url: String.t(),
  variables: %{optional(String.t()) => OpenApiSpex.ServerVariable.t()}
}

Server Object

An object representing a Server.

Link to this section Functions

Link to this function

from_endpoint(endpoint) View Source 
from_endpoint(module()) :: t()

Builds a Server from a phoenix Endpoint module

Link to this function

from_endpoint(endpoint, opts) View Source 
from_endpoint(module(), ignored :: any()) :: t()

This function is deprecated. Use from_endpoint/1 instead.

Builds a Server from a phoenix Endpoint module