opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-06-28 22:53:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

net types: remove omitempty from required fields

Browse Source 
This will make reading the fields easier in rust because we can
guarantee that the fields will be present in the json output.

[NO TESTS NEEDED]

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
This commit is contained in:
Paul Holzinger
2021-09-22 13:52:57 +02:00
parent 7910bfd7c1
commit 68d21b6ff5
1 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
libpod/network/types/network.go
View File

@ -32,11 +32,11 @@ type ContainerNetwork interface {
// Network describes the Network attributes. // Network describes the Network attributes.
type Network struct { type Network struct {
// Name of the Network. // Name of the Network.
Name string `json:"name,omitempty"` Name string `json:"name"`
// ID of the Network. // ID of the Network.
ID string `json:"id,omitempty"` ID string `json:"id"`
// Driver for this Network, e.g. bridge, macvlan... // Driver for this Network, e.g. bridge, macvlan...
Driver string `json:"driver,omitempty"` Driver string `json:"driver"`
// InterfaceName is the network interface name on the host. // InterfaceName is the network interface name on the host.
NetworkInterface string `json:"network_interface,omitempty"` NetworkInterface string `json:"network_interface,omitempty"`
// Created contains the timestamp when this network was created. // Created contains the timestamp when this network was created.
@ -97,7 +97,7 @@ func (n *IPNet) UnmarshalText(text []byte) error {
type Subnet struct { type Subnet struct {
// Subnet for this Network in CIDR form. // Subnet for this Network in CIDR form.
// swagger:strfmt string // swagger:strfmt string
Subnet IPNet `json:"subnet,omitempty"` Subnet IPNet `json:"subnet"`
// Gateway IP for this Network. // Gateway IP for this Network.
// swagger:strfmt string // swagger:strfmt string
Gateway net.IP `json:"gateway,omitempty"` Gateway net.IP `json:"gateway,omitempty"`
@ -134,14 +134,14 @@ type NetInterface struct {
// Networks list of assigned subnets with their gateway. // Networks list of assigned subnets with their gateway.
Networks []NetAddress `json:"networks,omitempty"` Networks []NetAddress `json:"networks,omitempty"`
// MacAddress for this Interface. // MacAddress for this Interface.
MacAddress net.HardwareAddr `json:"mac_address,omitempty"` MacAddress net.HardwareAddr `json:"mac_address"`
} }
// NetAddress contains the subnet and gatway. // NetAddress contains the subnet and gatway.
type NetAddress struct { type NetAddress struct {
// Subnet of this NetAddress. Note that the subnet contains the // Subnet of this NetAddress. Note that the subnet contains the
// actual ip of the net interface and not the network address. // actual ip of the net interface and not the network address.
Subnet IPNet `json:"subnet,omitempty"` Subnet IPNet `json:"subnet"`
// Gateway for the Subnet. This can be nil if there is no gateway, e.g. internal network. // Gateway for the Subnet. This can be nil if there is no gateway, e.g. internal network.
Gateway net.IP `json:"gateway,omitempty"` Gateway net.IP `json:"gateway,omitempty"`
} }
@ -157,27 +157,27 @@ type PerNetworkOptions struct {
// StaticMac for this container. Optional. // StaticMac for this container. Optional.
StaticMAC net.HardwareAddr `json:"static_mac,omitempty"` StaticMAC net.HardwareAddr `json:"static_mac,omitempty"`
// InterfaceName for this container. Required. // InterfaceName for this container. Required.
InterfaceName string `json:"interface_name,omitempty"` InterfaceName string `json:"interface_name"`
} }
// NetworkOptions for a given container. // NetworkOptions for a given container.
type NetworkOptions struct { type NetworkOptions struct {
// ContainerID is the container id, used for iptables comments and ipam allocation. // ContainerID is the container id, used for iptables comments and ipam allocation.
ContainerID string `json:"container_id,omitempty"` ContainerID string `json:"container_id"`
// ContainerName is the container name, used as dns name. // ContainerName is the container name, used as dns name.
ContainerName string `json:"container_name,omitempty"` ContainerName string `json:"container_name"`
// PortMappings contains the port mappings for this container // PortMappings contains the port mappings for this container
PortMappings []PortMapping `json:"port_mappings,omitempty"` PortMappings []PortMapping `json:"port_mappings,omitempty"`
// Networks contains all networks with the PerNetworkOptions. // Networks contains all networks with the PerNetworkOptions.
// The map should contain at least one element. // The map should contain at least one element.
Networks map[string]PerNetworkOptions `json:"networks,omitempty"` Networks map[string]PerNetworkOptions `json:"networks"`
} }
// PortMapping is one or more ports that will be mapped into the container. // PortMapping is one or more ports that will be mapped into the container.
type PortMapping struct { type PortMapping struct {
// HostIP is the IP that we will bind to on the host. // HostIP is the IP that we will bind to on the host.
// If unset, assumed to be 0.0.0.0 (all interfaces). // If unset, assumed to be 0.0.0.0 (all interfaces).
HostIP string `json:"host_ip,omitempty"` HostIP string `json:"host_ip"`
// ContainerPort is the port number that will be exposed from the // ContainerPort is the port number that will be exposed from the
// container. // container.
// Mandatory. // Mandatory.
@ -186,7 +186,7 @@ type PortMapping struct {
// the container. // the container.
// If omitted, a random port on the host (guaranteed to be over 1024) // If omitted, a random port on the host (guaranteed to be over 1024)
// will be assigned. // will be assigned.
HostPort uint16 `json:"host_port,omitempty"` HostPort uint16 `json:"host_port"`
// Range is the number of ports that will be forwarded, starting at // Range is the number of ports that will be forwarded, starting at
// HostPort and ContainerPort and counting up. // HostPort and ContainerPort and counting up.
// This is 1-indexed, so 1 is assumed to be a single port (only the // This is 1-indexed, so 1 is assumed to be a single port (only the
@ -195,12 +195,12 @@ type PortMapping struct {
// If unset, assumed to be 1 (a single port). // If unset, assumed to be 1 (a single port).
// Both hostport + range and containerport + range must be less than // Both hostport + range and containerport + range must be less than
// 65536. // 65536.
Range uint16 `json:"range,omitempty"` Range uint16 `json:"range"`
// Protocol is the protocol forward. // Protocol is the protocol forward.
// Must be either "tcp", "udp", and "sctp", or some combination of these // Must be either "tcp", "udp", and "sctp", or some combination of these
// separated by commas. // separated by commas.
// If unset, assumed to be TCP. // If unset, assumed to be TCP.
Protocol string `json:"protocol,omitempty"` Protocol string `json:"protocol"`
} }
// OCICNIPortMapping maps to the standard CNI portmapping Capability. // OCICNIPortMapping maps to the standard CNI portmapping Capability.