From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <pbs-devel-bounces@lists.proxmox.com> Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 10D2D1FF176 for <inbox@lore.proxmox.com>; Fri, 21 Feb 2025 16:06:34 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 1E233548F; Fri, 21 Feb 2025 16:06:33 +0100 (CET) Date: Fri, 21 Feb 2025 16:06:29 +0100 From: Wolfgang Bumiller <w.bumiller@proxmox.com> To: Christian Ebner <c.ebner@proxmox.com> Message-ID: <yv3cl4lmliv5pyc2asmlpvjm4osqvb5tmuhajvc6wsb4emqj2x@lvzghlcvd57y> References: <20250220155605.229679-1-c.ebner@proxmox.com> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20250220155605.229679-1-c.ebner@proxmox.com> X-SPAM-LEVEL: Spam detection results: 0 AWL 0.081 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [proxmox.com, main.rs] Subject: [pbs-devel] applied: [PATCH v2 proxmox-backup] fix #6185: client/docs: explicitly mention archive name restrictions X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion <pbs-devel.lists.proxmox.com> List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>, <mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe> List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/> List-Post: <mailto:pbs-devel@lists.proxmox.com> List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help> List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>, <mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe> Reply-To: Proxmox Backup Server development discussion <pbs-devel@lists.proxmox.com> Cc: pbs-devel@lists.proxmox.com Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pbs-devel-bounces@lists.proxmox.com Sender: "pbs-devel" <pbs-devel-bounces@lists.proxmox.com> applied, and fixed up more >100col lines while also fixing the that the entire #[api] block from the lower hunk from using *3* spaces to 4 for its first indentation level... On Thu, Feb 20, 2025 at 04:56:05PM +0100, Christian Ebner wrote: > Mention in the docs and the api parameter description the limitations > for archive name labels. They must contain alphanumerics, hyphens and > underscores only to match the regex pattern. > > By setting this in the api parameter description, it will be included > in the man page for proxmox-backup-client. > > Fixes: https://bugzilla.proxmox.com/show_bug.cgi?id=6185 > Signed-off-by: Christian Ebner <c.ebner@proxmox.com> > --- > changes since version 1: > - Avoid newline in output by formatting multi-line string with backslash. > > docs/backup-client.rst | 1 + > pbs-client/src/backup_specification.rs | 10 ++++++---- > proxmox-backup-client/src/main.rs | 3 ++- > 3 files changed, 9 insertions(+), 5 deletions(-) > > diff --git a/docs/backup-client.rst b/docs/backup-client.rst > index 1c2a98ed8..e11c0142a 100644 > --- a/docs/backup-client.rst > +++ b/docs/backup-client.rst > @@ -169,6 +169,7 @@ the client. The format is: > > <archive-name>.<type>:<source-path> > > +The ``archive-name`` must contain alphanumerics, hyphens and underscores only. > Common types are ``.pxar`` for file archives and ``.img`` for block > device images. To create a backup of a block device, run the following command: > > diff --git a/pbs-client/src/backup_specification.rs b/pbs-client/src/backup_specification.rs > index b6fbc555c..e44d23d90 100644 > --- a/pbs-client/src/backup_specification.rs > +++ b/pbs-client/src/backup_specification.rs > @@ -7,10 +7,12 @@ const_regex! { > BACKUPSPEC_REGEX = r"^([a-zA-Z0-9_-]+\.(pxar|img|conf|log)):(.+)$"; > } > > -pub const BACKUP_SOURCE_SCHEMA: Schema = > - StringSchema::new("Backup source specification ([<label>:<path>]).") > - .format(&ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)) > - .schema(); > +pub const BACKUP_SOURCE_SCHEMA: Schema = StringSchema::new( > + "Backup source specification ([<label>:<path>]), the specification \ > + 'label' must contain alphanumerics, hyphens and underscores only.", > +) > +.format(&ApiStringFormat::Pattern(&BACKUPSPEC_REGEX)) > +.schema(); > > pub enum BackupSpecificationType { > PXAR, > diff --git a/proxmox-backup-client/src/main.rs b/proxmox-backup-client/src/main.rs > index 589a097bb..9077f7bdf 100644 > --- a/proxmox-backup-client/src/main.rs > +++ b/proxmox-backup-client/src/main.rs > @@ -628,7 +628,8 @@ fn spawn_catalog_upload( > properties: { > backupspec: { > type: Array, > - description: "List of backup source specifications ([<label.ext>:<path>] ...)", > + description: "List of backup source specifications ([<label.ext>:<path>] ...), the \ > + specifications 'label' must contain alphanumerics, hyphens and underscores only.", > items: { > schema: BACKUP_SOURCE_SCHEMA, > } > -- > 2.39.5 _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel