open_api_spex v1.1.0 OpenApiSpex.Server View Source

Defines the OpenApiSpex.Server.t type.

Link to this section Summary

Functions

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, opts) View Source
from_endpoint(module, [{:otp_app, atom}]) :: t

Builds a Server from a phoenix Endpoint module