Struct OpenApiClassPolicy 

pub struct OpenApiClassPolicy { /* private fields */ }

The static OpenAPI policy of one server, derived from its CodeModeConfig.

Implementations

impl OpenApiClassPolicy

pub fn from_config(config: &CodeModeConfig) -> Self

Derive the policy from the OpenAPI keys of config (table in the module docs).

pub fn with_mode(self, class: UnifiedAction, mode: ClassMode) -> Self

Replace the mode of one class. Allowlist entries are normalized.

For a caller whose own config can say more than the openapi_* keys of CodeModeConfig — a read allowlist, an admin mode. Install the result with ValidationPipeline::with_openapi_class_policy.

pub fn with_blocked_operations<I, S>(self, entries: I) -> Self

where I: IntoIterator<Item = S>, S: AsRef<str>,

Replace the blocked operations. Same entry forms as openapi_blocked_writes: an HTTP method name blocks the method, any other entry names an operation. A block applies in every class.

pub fn with_blocked_paths<I, S>(self, patterns: I) -> Self

where I: IntoIterator<Item = S>, S: AsRef<str>,

Replace the blocked path patterns (same rules as openapi_blocked_paths).

pub fn mode(&self, class: UnifiedAction) -> &ClassMode

The mode governing class.

pub fn check_script( &self, info: &JavaScriptCodeInfo, registry: &OperationRegistry, ) -> Vec<PolicyViolation>

Check every API call of a parsed script. Returns one violation per refused call; an empty list means the script passes the static policy.

pub fn check_request( &self, method: &str, path: &str, registry: &OperationRegistry, ) -> Result<(), PolicyViolation>

Check one request at execution time, after its path is resolved.

The validator classifies a dynamic path conservatively; this is the check that sees where the request actually goes. Any query string is ignored for matching. Violation messages name the method and class but never the path, which carries caller-supplied values.

Errors

Returns the violation when the request is refused.

Trait Implementations

impl Clone for OpenApiClassPolicy

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 OpenApiClassPolicy

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

Formats the value using the given formatter.

impl Display for OpenApiClassPolicy

One line naming each class’s mode and the block counts, for a startup log: read=allow_all write=deny_all delete=deny_all admin=deny_all blocked_operations=0 blocked_paths=0. Lists are counted, not printed.

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

Formats the value using the given formatter.