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 DB5301FF0B7 for ; Fri, 13 Nov 2026 21:33:40 +0100 (CET) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id DCEFC212D2; Fri, 13 Nov 2026 21:33:37 +0100 (CET) From: "Max R. Carrara" To: pve-devel@lists.proxmox.com Subject: [PATCH pve-common v5 01/19] json schema: add multiline validation keyword Date: Fri, 13 Nov 2026 21:33:05 +0100 Message-ID: <20261113203330.932813-2-m.carrara@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20261113203330.932813-1-m.carrara@proxmox.com> References: <20261113203330.932813-1-m.carrara@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1794602012580 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.302 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: 7GA2MP4BKSCJIWM6BP7222GYGJFVQTAP X-Message-ID-Hash: 7GA2MP4BKSCJIWM6BP7222GYGJFVQTAP X-MailFrom: m.carrara@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: Alfonso Kuen , Thomas Ellmenreich , Jakob Klocker X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox VE development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Add a new `multiline` validation keyword that indicates that a given string may contain un-escaped newline characters. This keyword explicitly signals to other components (e.g. a client) that a string is a multi-line string and should remain one, without folding newlines or replacing them with spaces, for example. Note that no actual validation is performed on the schema's side here; this keyword purely serves as a hint for other implementations at the moment. Actual validation, that is, whether newlines should be *allowed* or not, should be handled by other keywords like `format` and `pattern`. Make these things clear in the `multiline` keyword's description. Signed-off-by: Max R. Carrara --- src/PVE/JSONSchema.pm | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/PVE/JSONSchema.pm b/src/PVE/JSONSchema.pm index 4b4842d..aecb771 100644 --- a/src/PVE/JSONSchema.pm +++ b/src/PVE/JSONSchema.pm @@ -1855,10 +1855,20 @@ my $default_schema_noref = { type => "array", optional => 1, description => "This provides an enumeration of possible values that are valid for the instance property.", }, + multiline => { + type => "boolean", + optional => 1, + description => "If the instance value is a string, this hints" + . " that the string is a multi-line string. Note that the" + . " 'pattern' or 'format' keywords should be used to validate" + . " whether a string may actually contain newlines or not." + . " This keyword specifically only acts as a hint, not as a" + . " validation guarantee.", + }, description => { type => "string", optional => 1, description => "This provides a description of the purpose the instance property. The value can be a string or it can be an object with properties corresponding to various different instance languages (with an optional default property indicating the default description).", -- 2.47.3