Update the index.authenticate docs (#12102)

Follow-up to #11896 

Reframes the documentation a bit.

Looking into why the `[index]` child fields aren't generate in the
reference correctly too.
This commit is contained in:
Zanie Blue
2025-03-11 15:01:42 -05:00
committed by GitHub
parent c48af312ae
commit a59778fca3
5 changed files with 67 additions and 44 deletions
+11 -1
View File
@@ -1,18 +1,28 @@
use rustc_hash::FxHashMap;
use url::Url;
/// When to use authentication.
#[derive(
Copy, Clone, Debug, Default, Hash, Eq, PartialEq, serde::Serialize, serde::Deserialize,
)]
#[serde(rename_all = "kebab-case")]
#[cfg_attr(feature = "schemars", derive(schemars::JsonSchema))]
pub enum AuthPolicy {
/// Try unauthenticated request. Fallback to authenticated request.
/// Authenticate when necessary.
///
/// If credentials are provided, they will be used. Otherwise, an unauthenticated request will
/// be attempted first. If the request fails, uv will search for credentials. If credentials are
/// found, an authenticated request will be attempted.
#[default]
Auto,
/// Always authenticate.
///
/// If credentials are not provided, uv will eagerly search for credentials. If credentials
/// cannot be found, uv will error instead of attempting an unauthenticated request.
Always,
/// Never authenticate.
///
/// If credentials are provided, uv will error. uv will not search for credentials.
Never,
}