[pbs-devel] [PATCH proxmox-backup] api: token: make comment deletable

Hannes Laimer h.laimer at proxmox.com
Tue Mar 25 14:04:06 CET 2025


Currently, the only way to delete a comment on a token is to set it to
just spaces. Since we trim it in the endpoint, it gets deleted as a
side effect. This allows the comment to be deleted properly.

Signed-off-by: Hannes Laimer <h.laimer at proxmox.com>
---
just stumbled upon this randomly, I don't think there is a reason
to not have it deletable

 src/api2/access/user.rs | 26 ++++++++++++++++++++++++++
 www/window/TokenEdit.js |  1 +
 2 files changed, 27 insertions(+)

diff --git a/src/api2/access/user.rs b/src/api2/access/user.rs
index 4821551c3..031f84caa 100644
--- a/src/api2/access/user.rs
+++ b/src/api2/access/user.rs
@@ -515,6 +515,15 @@ pub fn generate_token(
     }))
 }
 
+#[api()]
+#[derive(Serialize, Deserialize)]
+#[serde(rename_all = "kebab-case")]
+/// The set of properties that can be deleted from a token.
+pub enum DeletableTokenProperty {
+    /// Delete the comment property.
+    Comment,
+}
+
 #[api(
     protected: true,
     input: {
@@ -537,6 +546,14 @@ pub fn generate_token(
                 schema: EXPIRE_USER_SCHEMA,
                 optional: true,
             },
+            delete: {
+                description: "List of properties to delete.",
+                type: Array,
+                optional: true,
+                items: {
+                    type: DeletableTokenProperty,
+                }
+            },
             digest: {
                 optional: true,
                 schema: PROXMOX_CONFIG_DIGEST_SCHEMA,
@@ -557,6 +574,7 @@ pub fn update_token(
     comment: Option<String>,
     enable: Option<bool>,
     expire: Option<i64>,
+    delete: Option<Vec<DeletableTokenProperty>>,
     digest: Option<String>,
 ) -> Result<(), Error> {
     let _lock = pbs_config::user::lock_config()?;
@@ -573,6 +591,14 @@ pub fn update_token(
 
     let mut data: ApiToken = config.lookup("token", &tokenid_string)?;
 
+    if let Some(delete) = delete {
+        for delete_prop in delete {
+            match delete_prop {
+                DeletableTokenProperty::Comment => data.comment = None,
+            }
+        }
+    }
+
     if let Some(comment) = comment {
         let comment = comment.trim().to_string();
         if comment.is_empty() {
diff --git a/www/window/TokenEdit.js b/www/window/TokenEdit.js
index c1856be87..d1c5555bc 100644
--- a/www/window/TokenEdit.js
+++ b/www/window/TokenEdit.js
@@ -68,6 +68,7 @@ Ext.define('PBS.window.TokenEdit', {
 	    {
 		xtype: 'proxmoxtextfield',
 		name: 'comment',
+		deleteEmpty: true,
 		fieldLabel: gettext('Comment'),
 	    },
 	],
-- 
2.39.5





More information about the pbs-devel mailing list