public inbox for pdm-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Christoph Heiss <c.heiss@proxmox.com>
To: pdm-devel@lists.proxmox.com
Subject: [PATCH datacenter-manager] api: remotes: fix create and update method descriptions
Date: Mon, 22 Jun 2026 08:17:41 +0200	[thread overview]
Message-ID: <20260622061750.66530-2-c.heiss@proxmox.com> (raw)

Give them fitting descriptions instead of the copy-pasted one from the
list endpoint.

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
---
 server/src/api/remotes/mod.rs | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/server/src/api/remotes/mod.rs b/server/src/api/remotes/mod.rs
index e416f619..06189f7d 100644
--- a/server/src/api/remotes/mod.rs
+++ b/server/src/api/remotes/mod.rs
@@ -263,7 +263,11 @@ const CREATE_TOKEN_SCHEMA: Schema = pdm_api_types::PROXMOX_TOKEN_NAME_SCHEMA
         permission: &Permission::Privilege(&["resource"], PRIV_RESOURCE_MODIFY, false),
     },
 )]
-/// List all the remotes this instance is managing.
+/// Add a new remote to manage.
+///
+/// If `create-token` is specified, a new API token is generated on the target
+/// remote with the given name and used instead of the existing authentication
+/// details in the entry.
 pub async fn add_remote(mut entry: Remote, create_token: Option<String>) -> Result<(), Error> {
     let _lock = pdm_config::remotes::lock_config()?;
     let (mut remotes, _) = pdm_config::remotes::config()?;
@@ -388,7 +392,7 @@ pub enum DeletableProperty {
         permission: &Permission::Privilege(&["resource", "{id}"], PRIV_RESOURCE_MODIFY, false),
     },
 )]
-/// List all the remotes this instance is managing.
+/// Update an existing managed remote.
 pub fn update_remote(
     id: String,
     updater: RemoteUpdater,
-- 
2.54.0





             reply	other threads:[~2026-06-22  6:18 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-06-22  6:17 Christoph Heiss [this message]
2026-06-22 18:13 ` applied: [PATCH datacenter-manager] api: remotes: fix create and update method descriptions Thomas Lamprecht

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260622061750.66530-2-c.heiss@proxmox.com \
    --to=c.heiss@proxmox.com \
    --cc=pdm-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal