From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from gate001.proxmox.com (gate001.proxmox.com [45.144.208.40]) by lore.proxmox.com (Postfix) with ESMTPS id 361521FF0B4 for ; Tue, 10 Nov 2026 14:39:26 +0100 (CET) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id 4C04A215C2; Tue, 10 Nov 2026 14:39:21 +0100 (CET) Date: Tue, 10 Nov 2026 14:39:15 +0100 From: Wolfgang Bumiller To: "Max R. Carrara" Subject: Re: [PATCH pve-common v4 01/17] json schema: add multiline string format Message-ID: References: <20261106154554.2182986-1-m.carrara@proxmox.com> <20261106154554.2182986-2-m.carrara@proxmox.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <20261106154554.2182986-2-m.carrara@proxmox.com> X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1794317955998 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.361 Adjusted score from AWL reputation of From: address DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment (newer systems) RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: 346YM3R3UH7V5H3XZGSUSJ3WFV7ETM3M X-Message-ID-Hash: 346YM3R3UH7V5H3XZGSUSJ3WFV7ETM3M X-MailFrom: w.bumiller@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header CC: pve-devel@lists.proxmox.com, Alfonso Kuen , Thomas Ellmenreich , Jakob Klocker , Thomas Lamprecht X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox VE development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Given that right now, newlines are almost never wanted/allowed in our API (apart from comments), there's a case to be made here that we might just want a multiline schema flag. (Where by default we'd reject newlines. This could potentially remove a whole class of possible future section-config related bugs…) Also, consider that on the rust side, 'format', 'enum', 'pattern', and the verify-functions are part of the `ApiStringFormat` *enum*, so you can only have one, and we do not have *named* formats at all. Thomas also played around with the thought of adding a multiline boolean to string schemas, so this may be a good time to come to a decision here. IMO, while not strictly being part of any JSONSchema/openapi spec, it would be fine to have that. Also, I'm quite sure that whenever we use patterns or other formats, a pattern which does not want to opt into multiline support should be written in a way which does not allow newlines *anyway*, so for the most part it would act as a hint, but additionally provide a safe-guard just in case. On Fri, Nov 06, 2026 at 04:45:37PM +0100, Max R. Carrara wrote: > Add a new format named "multiline". > > This format explicitly signals to other components (e.g. a client) > that a string is a multiline string and should remain one, without > folding newlines or replacing them with spaces, for example. > > Signed-off-by: Max R. Carrara > --- > src/PVE/JSONSchema.pm | 5 +++++ > 1 file changed, 5 insertions(+) > > diff --git a/src/PVE/JSONSchema.pm b/src/PVE/JSONSchema.pm > index 34f2949..5790a32 100644 > --- a/src/PVE/JSONSchema.pm > +++ b/src/PVE/JSONSchema.pm > @@ -236,10 +236,15 @@ sub get_renderer { > > # register some common type for pve > > register_format('string', sub { }); # allow format => 'string-list' > > +# A multiline string. > +# Used to explicitly tell other components that a string should not > +# have its newlines folded or replaced with spaces. > +register_format('multiline', sub { }); > + > register_format('urlencoded', \&pve_verify_urlencoded); > > sub pve_verify_urlencoded { > my ($text, $noerr) = @_; > if ($text !~ /^[-%a-zA-Z0-9_.!~*'()]*\z/) { > -- > 2.47.3