Enum OpenApiMode 

pub enum OpenApiMode {
    Disabled,
    FollowPrivileges,
    IgnorePrivileges,
}

OpenAPI generation mode.

PostgREST also has a security-definer mode, where the specification comes from a user-supplied SECURITY DEFINER function. There is no configuration here for naming that function, so the variant is absent rather than present and behaving as one of the others.

Variants

Disabled

No OpenAPI document is served.

FollowPrivileges

The document describes only what the requesting role may reach, so two roles asking are answered differently.

IgnorePrivileges

The document describes the whole exposed schema, whoever is asking.

Implementations

impl OpenApiMode

pub fn parse_config(s: &str) -> Option<Self>

Parse the spelling used in configuration. Case-insensitive, and a hyphen or an underscore separates the words equally.

pub fn as_config_str(&self) -> &'static str

The inverse of parse_config.

Trait Implementations

impl Clone for OpenApiMode

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenApiMode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpenApiMode

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Eq for OpenApiMode

impl PartialEq for OpenApiMode

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for OpenApiMode

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OpenApiMode