Struct HttpOptions 

pub struct HttpOptions {
    pub token: Option<String>,
    pub client_token: Option<String>,
    pub read_token: Option<String>,
    pub namespaces: Vec<(String, String)>,
    pub insecure: bool,
    pub identity_header: Option<String>,
    pub no_ui: bool,
    pub public_url: Option<String>,
    pub profile: Option<String>,
    pub codec_url: Option<String>,
}

How the API serves.

Fields

token: Option<String>

Required as Authorization: Bearer <token> on every request. A listener off loopback needs one.

client_token: Option<String>

Another full token: a client’s (the server protocol’s client scope). The HTTP API only makes calls, so it reaches all of it.

read_token: Option<String>

A second token that only reads: it is accepted for GET requests (lists, runs, results, events, metrics) and refused for anything that changes something. For dashboards and on-call read access.

namespaces: Vec<(String, String)>

Tokens that reach one namespace only, as (token, namespace). A namespace is a prefix of the workflow ID: with acme’s token, calls name only IDs under acme/, lists show only those runs, and of the rest only info, types and limits answer.

insecure: bool

Listen off loopback without a token (only behind a proxy that authenticates).

identity_header: Option<String>

The header in which a proxy in front names who signed in (X-Forwarded-User, X-Auth-Request-Email). Requests then need it or a token; it names the requester of signals, cancellations, terminations and resets in their records (audit), and the UI shows it. Trust it only behind that proxy.

no_ui: bool

Serve the web UI at / (on by default with the ui feature).

public_url: Option<String>

The address callers outside see (for callback URLs), if not the listener’s.

profile: Option<String>

Shown by /v1/info and the UI (dev under the dev profile).

codec_url: Option<String>

The operator’s codec endpoint (see serve_codec): the UI sends the payloads a codec encrypted there to show them decoded. The browser calls it directly, so this API never holds the keys or the decoded payloads.

Trait Implementations

impl Clone for HttpOptions

fn clone(&self) -> HttpOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HttpOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HttpOptions

fn default() -> HttpOptions

Returns the “default value” for a type.