Struct CredentialFormSchema 

pub struct CredentialFormSchema {
    pub fields: Vec<FormField>,
    pub instructions_markdown: String,
}

Describes the form fields and instructions for entering a credential.

Fields

fields: Vec<FormField>

Input fields to render.

instructions_markdown: String

Markdown instructions shown above the form (how to get the key, etc.).

Implementations

impl CredentialFormSchema

pub fn empty() -> Self

Schema with no fields (keyless integrations, e.g. test simulators).

pub fn api_key(instructions_markdown: impl Into<String>) -> Self

The common single-field API key schema.

pub fn has_groups(&self) -> bool

Whether the schema declares any mutually-exclusive credential groups (e.g. “API key” or “OAuth”). When it does, at least one complete group is required by CredentialFormSchema::validate.

pub fn validate(&self, fields: &BTreeMap<String, String>) -> Vec<String>

Validate a submitted field map against this schema.

Rules:

• Every ungrouped required field must be present and non-empty.
• Fields sharing a group label form a mutually-exclusive alternative (e.g. MAI’s “API key” group vs its “Entra ID OAuth” group). A group is touched when any of its fields has a value; a touched group must have all of its required fields filled (no partially-entered OAuth blocks).
• When the schema declares any groups, at least one group must be complete, so a provider cannot be saved with no credential at all.

Returns the list of human-readable validation errors; empty means valid. Unknown keys are ignored — drivers read only the fields they declare.

Trait Implementations

impl Clone for CredentialFormSchema

fn clone(&self) -> CredentialFormSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CredentialFormSchema

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

Formats the value using the given formatter.

impl Serialize for CredentialFormSchema

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.