public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Wolfgang Bumiller <w.bumiller@proxmox.com>
To: "Max R. Carrara" <m.carrara@proxmox.com>
Cc: Thomas Lamprecht <t.lamprecht@proxmox.com>,
	pve-devel@lists.proxmox.com,
	Alfonso Kuen <gerencia@idkmanager.com>,
	Thomas Ellmenreich <t.ellmenreich@proxmox.com>,
	Jakob Klocker <j.klocker@proxmox.com>
Subject: Re: [PATCH pve-common v4 01/17] json schema: add multiline string format
Date: Thu, 12 Nov 2026 10:24:34 +0100	[thread overview]
Message-ID: <wetxgvonig22ovhuqe4bssli6eou4mgews3vcebcgw54sfl7i3@fpwb7vpoy2jl> (raw)
In-Reply-To: <DMSFHZ2373Z0.A4LLT9KRA0IZ@proxmox.com>

On Wed, Nov 11, 2026 at 02:50:39PM +0100, Max R. Carrara wrote:
> On Wed Nov 11, 2026 at 12:38 PM CET, Thomas Lamprecht wrote:
> > Am 11.11.26 um 11:56 schrieb Max R. Carrara:
> > > On Tue Nov 10, 2026 at 2:39 PM CET, Wolfgang Bumiller wrote:
> > >> 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…)
> > >
> > > If a fear of SectionConfig bugs is preventing us from simply adding
> > > multiline strings, we should seriously consider migrating the
> > > SectionConfig *file format* to something different in the long term.
> >
> > unescaped newline will cause issues in most (non-binary) formats, lets
> > not overreact here...
> 
> Many modern formats like TOML and HJSON support multiline string
> literals. Or am I misunderstanding something here?

This is not only about formats we can choose ourselves. Eg. the API can
also manage `/etc/network/interfaces` where pretty much everything
(other than the comments) could cause major issues if newlines are
inserted. (Sure, this particular example requires privileges, but the
point is that we don't always choose the format).

> 
> >
> > >> 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, [...]
> > >
> > > Which is something we should change eventually then, since validation
> > > keywords are independent unless explicitly stated otherwise, at least as
> > > per section 3.1.1 of this draft:
> > >
> > > https://json-schema.org/draft-07/draft-handrews-json-schema-validation-00.pdf
> > >
> > > Sure, you could argue that it doesn't make sense to have `format`,
> > > `enum`, and `pattern` co-exist for the same property, but the spec
> > > doesn't place any restrictions on this.
> > >
> > >
> > >> [...] and we do not have *named* formats at all.
> > >
> > > Why not?

Because in rust the schema is meant to fully resolve at build-time.
This isn't something I'd want to change just to allow newlines in a
a probably-single-digit-amount of API parameters.

> > >
> > >>
> > >> 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.
> > >
> > > NAK -- I don't think we should deviate from the spec just to make a
> >
> > FWIW we're not exactly spec conform nor fully support all potential
> > variants now and I hardly see why one has to bend backward to do either
> > here.
> 
> That's what I'm trying to point out here; we seem to "bend backward" to
> adapt things like JSONSchema to SectionConfig, instead of doing it the
> other way around.

We're not bending backwards there, and SC is not the (only) reason
either, it is just *one thing* which *exposes* (not *causes*) issues
inherent to JSONSchema and where we use it.
Look at the oneOf changes for example, and combine it with CLI option
parsing, where we run into even more issues: One example being boolean
flags. We accept `--a-bool 1`, but we also accept `--a-bool` without the
1, so what if you add a variant to an existing enum which *then* causes
an option to be *maybe* a boolean? The shell-completion function
suddenly gains a lot of complexity from this.
You could argue that we simply "shouldn't" mess up the CLI → enter
custom storage plugins ;-)

Any addition/change to the schema *should* ideally take all such things
into account as much as we possibly can. And a `multiline` *safeguard*
doesn't seem to cause many such issues, and would not prevent it from
being used with openapi tooling either.

And besides, this series already introduces other `x-foo` options for
the GUI, so it may as well have been `x-multline`.




  reply	other threads:[~2026-11-12  9:24 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-06 15:45 [PATCH common/manager/proxmox-widget-toolkit/storage/storage-plugin-examples v4 00/17] GUI Support for Custom Storage Plugins Max R. Carrara
2026-11-06 15:45 ` [PATCH pve-common v4 01/17] json schema: add multiline string format Max R. Carrara
2026-11-10 13:39   ` Wolfgang Bumiller
2026-11-11 10:56     ` Max R. Carrara
2026-11-11 11:38       ` Thomas Lamprecht
2026-11-11 13:50         ` Max R. Carrara
2026-11-12  9:24           ` Wolfgang Bumiller [this message]
2026-11-06 15:45 ` [PATCH pve-storage v4 02/17] api: plugins/storage: add initial routes and endpoints Max R. Carrara
2026-11-10 14:35   ` Wolfgang Bumiller
2026-11-11 10:58     ` Max R. Carrara
2026-11-06 15:45 ` [PATCH pve-storage v4 03/17] api: plugins/storage/plugin: include schema in plugin metadata Max R. Carrara
2026-11-06 15:45 ` [PATCH pve-storage v4 04/17] api: plugins/storage/plugin: mark sensitive properties in schema Max R. Carrara
2026-11-06 15:45 ` [PATCH pve-storage v4 05/17] api: plugins/storage/plugin: factor plugin metadata code into helper Max R. Carrara
2026-11-06 15:45 ` [PATCH pve-storage v4 06/17] api: plugins/storage/plugin: add plugins' 'content' to their metadata Max R. Carrara
2026-11-06 15:45 ` [PATCH pve-storage v4 07/17] all plugins: add 'title' to properties, adapt 'description's Max R. Carrara
2026-11-06 15:45 ` [PATCH pve-storage v4 08/17] all plugins, api: mark certain properties as advanced in plugindata() Max R. Carrara
2026-11-06 15:45 ` [PATCH pve-storage v4 09/17] all plugins, api: mark certain properties as hidden " Max R. Carrara
2026-11-06 15:45 ` [PATCH proxmox-widget-toolkit v4 10/17] form: introduce new 'proxmoxtextarea' field Max R. Carrara
2026-11-06 15:45 ` [PATCH proxmox-widget-toolkit v4 11/17] utils: introduce helper function getFieldDefFromPropertySchema Max R. Carrara
2026-11-06 15:45 ` [PATCH proxmox-widget-toolkit v4 12/17] acme: use helper to construct ExtJS fields from property schemas Max R. Carrara
2026-11-06 15:45 ` [PATCH pve-manager v4 13/17] api: sort modules and API method registrations Max R. Carrara
2026-11-06 15:45 ` [PATCH pve-manager v4 14/17] api: add API routes 'plugins' and 'plugins/storage' Max R. Carrara
2026-11-06 15:45 ` [PATCH pve-manager v4 15/17] ui: storage view: display error when no editor for storage type exists Max R. Carrara
2026-11-06 15:45 ` [PATCH pve-manager v4 16/17] ui: storage: add basic UI integration for custom storage plugins Max R. Carrara
2026-11-06 15:45 ` [PATCH pve-storage-plugin-examples v4 17/17] sshfs: Update SSHFS plugin Max R. Carrara
2026-11-13 20:36 ` superseded: [PATCH common/manager/proxmox-widget-toolkit/storage/storage-plugin-examples v4 00/17] GUI Support for Custom Storage Plugins Max R. Carrara

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=wetxgvonig22ovhuqe4bssli6eou4mgews3vcebcgw54sfl7i3@fpwb7vpoy2jl \
    --to=w.bumiller@proxmox.com \
    --cc=gerencia@idkmanager.com \
    --cc=j.klocker@proxmox.com \
    --cc=m.carrara@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    --cc=t.ellmenreich@proxmox.com \
    --cc=t.lamprecht@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