[pbs-devel] [PATCH proxmox-backup 09/14] api-types: introduce proper types for PAM and PBS realms

[Lukas Wagner]

On  2024-07-16 15:45, Christoph Heiss wrote:
> Signed-off-by: Christoph Heiss <c.heiss at proxmox.com>
> ---
>  pbs-api-types/src/lib.rs | 76 ++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 76 insertions(+)
> 
> diff --git a/pbs-api-types/src/lib.rs b/pbs-api-types/src/lib.rs
> index 40bcd8f1..01f8eb74 100644
> --- a/pbs-api-types/src/lib.rs
> +++ b/pbs-api-types/src/lib.rs
> @@ -1,6 +1,8 @@
>  //! Basic API types used by most of the PBS code.
>  
>  use const_format::concatcp;
> +use proxmox_schema::EnumEntry;
> +use proxmox_schema::Updater;

Nit: proxmox_* imports should be separate from third-party imports

>  use serde::{Deserialize, Serialize};
>  
>  pub mod percent_encoding;
> @@ -218,6 +220,20 @@ pub const REALM_ID_SCHEMA: Schema = StringSchema::new("Realm name.")
>      .max_length(32)
>      .schema();
>  
> +const PAM_REALM_ID_SCHEMA: Schema = StringSchema::new("Realm name.")
> +    .format(&ApiStringFormat::Enum(&[EnumEntry::new(
> +        "pam",
> +        "Default PAM realm.",
> +    )]))
> +    .schema();
> +
> +const PBS_REALM_ID_SCHEMA: Schema = StringSchema::new("Realm name.")
> +    .format(&ApiStringFormat::Enum(&[EnumEntry::new(
> +        "pbs",
> +        "Default PBS realm.",
> +    )]))
> +    .schema();
> +
>  pub const SUBSCRIPTION_KEY_SCHEMA: Schema =
>      StringSchema::new("Proxmox Backup Server subscription key.")
>          .format(&SUBSCRIPTION_KEY_FORMAT)
> @@ -394,3 +410,63 @@ pub struct BasicRealmInfo {
>      #[serde(skip_serializing_if = "Option::is_none")]
>      pub comment: Option<String>,
>  }
> +
> +#[api(
> +    properties: {
> +        "realm": {
> +            schema: PAM_REALM_ID_SCHEMA,
> +        },
> +        "comment": {
> +            optional: true,
> +            schema: SINGLE_LINE_COMMENT_SCHEMA,
> +        },
> +        "default": {
> +            optional: true,
> +            default: false,
> +        },
> +    }
> +)]
> +#[derive(Serialize, Deserialize, Updater, Clone)]
> +#[serde(rename_all = "kebab-case")]
> +/// Built-in PAM realm configuration properties.
> +pub struct PamRealmConfig {
> +    /// Realm name. Always "pam".
> +    #[updater(skip)]
> +    pub realm: String,
> +    /// Comment for this realm
> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub comment: Option<String>,
> +    /// True if it should be the default realm to login in
> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub default: Option<bool>,
> +}
> +
> +#[api(
> +    properties: {
> +        "realm": {
> +            schema: PBS_REALM_ID_SCHEMA,
> +        },
> +        "comment": {
> +            optional: true,
> +            schema: SINGLE_LINE_COMMENT_SCHEMA,
> +        },
> +        "default": {
> +            optional: true,
> +            default: false,
> +        },
> +    }
> +)]
> +#[derive(Serialize, Deserialize, Updater, Clone)]
> +#[serde(rename_all = "kebab-case")]
> +/// Built-in Proxmox Backup Server realm configuration properties.
> +pub struct PbsRealmConfig {
> +    /// Realm name. Always "pbs".
> +    #[updater(skip)]
> +    pub realm: String,
> +    /// Comment for this realm
> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub comment: Option<String>,
> +    /// True if it should be the default realm to login in
> +    #[serde(skip_serializing_if = "Option::is_none")]
> +    pub default: Option<bool>,
> +}

-- 
- Lukas