public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Gabriel Goller <g.goller@proxmox.com>
To: Dominik Csapak <d.csapak@proxmox.com>
Cc: pve-devel@lists.proxmox.com
Subject: Re: [pve-devel] [RFC PATCH] api: network: add return schema for interface listing
Date: Thu, 5 Dec 2024 13:49:41 +0100	[thread overview]
Message-ID: <splkipz76ztlsljsmhqvlsue55vdyw6fnzvyatkmmq2r6fao7h@ulbodpyq3muo> (raw)
In-Reply-To: <20241205082743.459521-1-d.csapak@proxmox.com>

Just in case you haven't noticed, a few typos inline:

On 05.12.2024 09:27, Dominik Csapak wrote:
>Most optiosn come from the api call parameter list

s/optiosn/options/

>(`json_config_properties`). The description and types for the remaining
>ons are either taken from the manpages, source code or similar
>documentation where available.
> [snip]
>diff --git a/PVE/API2/Network.pm b/PVE/API2/Network.pm
>index b9db9b27..df3db5af 100644
>--- a/PVE/API2/Network.pm
>+++ b/PVE/API2/Network.pm
>@@ -38,7 +38,7 @@ my $bond_mode_enum = [
>     ];
>
> my $network_type_enum = ['bridge', 'bond', 'eth', 'alias', 'vlan',
>-			 'OVSBridge', 'OVSBond', 'OVSPort', 'OVSIntPort'];
>+			 'OVSBridge', 'OVSBond', 'OVSPort', 'OVSIntPort', 'vnet'];
>
> my $confdesc = {
>     type => {
>@@ -223,7 +223,100 @@ __PACKAGE__->register_method({
> 	type => "array",
> 	items => {
> 	    type => "object",
>-	    properties => {},
>+	    properties => json_config_properties({
>+		iface => get_standard_option('pve-iface'),
>+		active => {
>+		    type => 'boolean',
>+		    optional => 1,
>+		    description => "Set to 1 if the interface is active.",
>+		},
>+		exists => {
>+		    type => 'boolean',
>+		    optional => 1,
>+		    description => "Set to 1 if the interface physically exists.",
>+		},
>+		families => {
>+		    type => "array",
>+		    description => "The network families.",
>+		    items => {
>+			type => "string",
>+			description => "A ntework familiy.",

s/ntework/network/
s/familiy/family/

>+			enum => ["inet", "inet6"],
>+		    },
>+		    optional => 1,
>+		},
>+		method => {
>+		    type => "string",
>+		    description => "The network configuration method for IPv4.",
>+		    enum => ["manual", "static", "auto"],
>+		    optional => 1,
>+		},
>+		method6 => {
>+		    type => "string",
>+		    description => "The network configuration method for IPv6.",
>+		    enum => ["manual", "static", "auto"],
>+		    optional => 1,
>+		},
>+		priority => {
>+		    type => 'integer',
>+		    description => "The order of the interface.",
>+		    optional => 1,
>+		},
>+		options => {
>+		    type => 'array',
>+		    optional => 1,
>+		    description => "A list of additional interface options for IPv4.",
>+		    items => {
>+			type => "string",
>+			description => "An interface property.",
>+		    },
>+		},
>+		options6 => {
>+		    type => 'array',
>+		    optional => 1,
>+		    description => "A list of additional interface options for IPv6.",
>+		    items => {
>+			type => "string",
>+			description => "An interface property.",
>+		    },
>+		},
>+		'uplink-id' => {
>+		    type => 'string',
>+		    optional => 1,
>+		    description => "The uplink ID.",
>+		},
>+		'link-type' => {
>+		    type => 'string',
>+		    optional => 1,
>+		    description => "The link type.",
>+		},
>+		'vlan-protocol' => {
>+		    type => 'string',
>+		    optional => 1,
>+		    enum => [qw(802.1ad 802.1q)],
>+		    description => "The vlan protocol.",

s/vlan/VLAN/

>+		},
>+		'vxlan-id' => {
>+		    type => 'integer',
>+		    optional => 1,
>+		    description => "The VXLAN ID.",
>+		},
>+		'vxlan-svcnodeip' => {
>+		    type => 'string',
>+		    optional => 1,
>+		    description => "The VXLAN SVC node IP.",
>+		},
>+		'vxlan-physdev' => {
>+		    type => 'string',
>+		    optional => 1,
>+		    description => "The physical device for the VXLAN tunnel communication.",

I would remove the "communication" as it's kinda redundant IMO.

>+		},
>+		'vxlan-local-tunnelip' => {
>+		    type => 'string',
>+		    optional => 1,
>+		    description => "The VXLAN local tunnel IP.",
>+		},
>+	    }),
> 	},
> 	links => [ { rel => 'child', href => "{iface}" } ],
>     },


_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel


  parent reply	other threads:[~2024-12-05 12:50 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-12-05  8:27 Dominik Csapak
2024-12-05  8:29 ` Dominik Csapak
2024-12-05  8:43 ` Thomas Lamprecht
2024-12-05 11:53   ` Stefan Hanreich
2024-12-06  8:52   ` Dominik Csapak
2024-12-06 10:00     ` Thomas Lamprecht
2024-12-05 12:49 ` Gabriel Goller [this message]
2024-12-06 11:16 ` Dominik Csapak

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=splkipz76ztlsljsmhqvlsue55vdyw6fnzvyatkmmq2r6fao7h@ulbodpyq3muo \
    --to=g.goller@proxmox.com \
    --cc=d.csapak@proxmox.com \
    --cc=pve-devel@lists.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