[pve-devel] [PATCH pve-common v1 17/23] sectionconfig: correct docs regarding global props in unified mode
Max R. Carrara
m.carrara at proxmox.com
Fri Dec 19 20:44:52 CET 2025
Note that default properties in unified mode are only excluded from
the update schema if they are not specified in `options()`.
Remove the paragraph at the end that suggests that this is the case
for isolated mode and both create and update schema.
Signed-off-by: Max R. Carrara <m.carrara at proxmox.com>
---
src/PVE/SectionConfig.pm | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/src/PVE/SectionConfig.pm b/src/PVE/SectionConfig.pm
index 069ca9e..6504399 100644
--- a/src/PVE/SectionConfig.pm
+++ b/src/PVE/SectionConfig.pm
@@ -345,15 +345,17 @@ which I<properties> are used in the method's return value. Because properties
are registered globally in this mode, any properties may be specified,
regardless of which plugin introduced them.
+B<NOTE:> Properties in the global list of properties (see C<L<< private()|/$base->private() >>>)
+are B<not> automatically added to C<L<< updateSchema()|/$base->updateSchema() >>>
+and must be explicitly declared in C<L<< options()|/$plugin->options() >>> if one
+wishes to use them.
+
In I<L<isolated mode|/MODES>>, the locally defined properties (those registered
by overriding C<L<< properties()|/$plugin->properties() >>>) are automatically
added to the plugin's schema and made C<optional> by default. Should this not be
desired, a property may still be explicitly defined, in order to make it required
or C<fixed> instead.
-Properties in the global list of properties (see C<L<< private()|/$base->private() >>>)
-are not automatically added and must be explicitly defined instead.
-
=cut
sub options {
--
2.47.3
More information about the pve-devel
mailing list