Struct SwaggerConfig 

pub struct SwaggerConfig {
    pub enabled: bool,
    pub path: String,
    pub oauth2: Option<SwaggerOAuth2Config>,
}

Swagger UI + embedded OpenAPI spec ([swagger] block).

Enabled by default — when the binary was built with the swagger cargo feature, an interactive Swagger UI is served at SwaggerConfig::path (default /docs) and the raw OpenAPI JSON at <path>/openapi.json. Set enabled = false in datasets.toml to suppress it (e.g. in prod). When the binary was built without the feature, enabled = true is harmless: the server logs a warning at startup and skips the mount.

To let users sign in to the UI itself (Authorization Code + PKCE against any OIDC provider), populate the optional [swagger.oauth2] sub-block. Acquired tokens are attached as Authorization: Bearer … to every “Try it out” request — useful for exercising auth-protected endpoints from the docs page. This drives the UI only; it does not turn on server-side token validation.

Fields

enabled: bool

path: String

oauth2: Option<SwaggerOAuth2Config>

Trait Implementations

impl Clone for SwaggerConfig

fn clone(&self) -> SwaggerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SwaggerConfig

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

Formats the value using the given formatter.

impl Default for SwaggerConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SwaggerConfig

where SwaggerConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.