Pristine (Pristine v0.4.0)

Shared runtime substrate for first-party OpenAPI-based SDKs.

Summary

Functions

context(opts \\ [])

Build an execution context.

execute(client, operation, opts \\ [])

Execute a rendered runtime operation against a runtime client.

execute_request(request_spec, context, opts \\ [])

Execute a generic request spec without rebuilding a runtime manifest.

foundation_context(opts \\ [])

Build a Foundation-backed production context.

stream(client, operation, opts \\ [])

Open a streaming request for a rendered runtime operation.

Functions

context(opts \\ [])

@spec context(keyword()) :: Pristine.SDK.Context.t()

Build an execution context.

execute(client, operation, opts \\ [])

@spec execute(Pristine.Client.t(), Pristine.Operation.t(), keyword()) ::
  {:ok, term()} | {:error, term()}

Execute a rendered runtime operation against a runtime client.

execute_request(request_spec, context, opts \\ [])

@spec execute_request(
  Pristine.SDK.OpenAPI.Client.request_spec_t()
  | Pristine.SDK.OpenAPI.Client.request_t(),
  Pristine.SDK.Context.t(),
  keyword()
) :: {:ok, term()} | {:error, term()}

Execute a generic request spec without rebuilding a runtime manifest.

foundation_context(opts \\ [])

@spec foundation_context(keyword()) :: Pristine.SDK.Context.t()

Build a Foundation-backed production context.

stream(client, operation, opts \\ [])

@spec stream(Pristine.Client.t(), Pristine.Operation.t(), keyword()) ::
  {:ok, Pristine.Response.t()} | {:error, term()}

Open a streaming request for a rendered runtime operation.