DockerEngineAPI.Connection (ex_docker_api v1.48.0)

View Source

Handle Tesla connections for DockerEngineAPI.

Additional middleware can be set in the compile-time or runtime configuration:

config :tesla, DockerEngineAPI.Connection,
  base_url: "http://localhost/v1.48",
  adapter: Tesla.Adapter.Hackney

The default base URL can also be set as:

config :ex_docker_api,
  :base_url, "http://localhost/v1.48"

Summary

Types

options()

The list of options that can be passed to new/1.

Functions

adapter()

Returns the default adapter for this API.

middleware(options \\ [])

Returns fully configured middleware for passing to Tesla.client/2.

new()

Configure a client with no authentication.

new(options)

Configure a client that may have authentication.

request(client, options)

Forward requests to Tesla.

Types

options()

@type options() :: [
  base_url: String.t(),
  user_agent: String.t(),
  timeout: non_neg_integer()
]

The list of options that can be passed to new/1.

  • base_url: Overrides the base URL on a per-client basis.
  • user_agent: Overrides the User-Agent header.

Functions

adapter()

Returns the default adapter for this API.

middleware(options \\ [])

@spec middleware(options()) :: [Tesla.Client.middleware()]

Returns fully configured middleware for passing to Tesla.client/2.

new()

@spec new() :: Tesla.Env.client()

Configure a client with no authentication.

Returns

Tesla.Env.client

new(options)

@spec new(options()) :: Tesla.Env.client()

Configure a client that may have authentication.

Parameters

  • options: a keyword list of OpenAPIPetstore.Connection.options.

Returns

Tesla.Env.client

request(client, options)

@spec request(Tesla.Client.t(), [Tesla.option()]) :: Tesla.Env.result()

Forward requests to Tesla.