OpenApiSpex.Server (open_api_spex v3.21.3)

View Source

Defines the OpenApiSpex.Server.t type.

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

Types

t()

@type t() :: %OpenApiSpex.Server{
  description: String.t() | nil,
  extensions: %{required(String.t()) => any()} | nil,
  url: String.t(),
  variables: %{required(String.t()) => OpenApiSpex.ServerVariable.t()}
}

Server Object

An object representing a Server.

Functions

from_endpoint(endpoint)

@spec from_endpoint(module()) :: t()

Builds a Server from a phoenix Endpoint module

from_endpoint(endpoint, opts)

This function is deprecated. Use from_endpoint/1 instead. 
@spec from_endpoint(module(), ignored :: any()) :: t()

Builds a Server from a phoenix Endpoint module