diff options
| author | Paul Holzinger <pholzing@redhat.com> | 2021-11-05 19:18:42 +0100 |
|---|---|---|
| committer | Paul Holzinger <pholzing@redhat.com> | 2021-11-05 19:25:40 +0100 |
| commit | 02f67181a281a4d6ae6bc9b21970d3cd66718b11 (patch) | |
| tree | da79ca575eba17183796a5c1429cacf9fdbcfc41 | |
| parent | e826158b4b9c4baef41ca872dea5e68e089355d3 (diff) | |
| download | podman-02f67181a281a4d6ae6bc9b21970d3cd66718b11.tar.gz podman-02f67181a281a4d6ae6bc9b21970d3cd66718b11.tar.bz2 podman-02f67181a281a4d6ae6bc9b21970d3cd66718b11.zip | |
Fix swagger definition for the new mac address type
The new mac address type broke the api docs. While we could
successfully generate the swagger file it could not be viewed in a
browser.
The problem is that the swagger generation create two type definitions
with the name `HardwareAddr` and this pointed back to itself. Thus the
render process was stucked in an endless loop. To fix this manually
rename the new type to MacAddress and overwrite the types to string
because the json unmarshaller accepts the mac as string.
Signed-off-by: Paul Holzinger <pholzing@redhat.com>
| -rw-r--r-- | libpod/network/types/network.go | 1 | ||||
| -rw-r--r-- | pkg/specgen/podspecgen.go | 1 | ||||
| -rw-r--r-- | pkg/specgen/specgen.go | 1 |
3 files changed, 3 insertions, 0 deletions
diff --git a/libpod/network/types/network.go b/libpod/network/types/network.go index 5cf523e20..ba5e018fd 100644 --- a/libpod/network/types/network.go +++ b/libpod/network/types/network.go @@ -99,6 +99,7 @@ func (n *IPNet) UnmarshalText(text []byte) error { // that it adds the json marshal/unmarshal methods. // This allows us to read the mac from a json string // and a byte array. +// swagger:model MacAddress type HardwareAddr net.HardwareAddr func (h *HardwareAddr) String() string { diff --git a/pkg/specgen/podspecgen.go b/pkg/specgen/podspecgen.go index 32d5be79a..948fb990c 100644 --- a/pkg/specgen/podspecgen.go +++ b/pkg/specgen/podspecgen.go @@ -99,6 +99,7 @@ type PodNetworkConfig struct { // Only available if NetNS is set to Bridge (the default for root). // As such, conflicts with NoInfra=true by proxy. // Optional. + // swagger:strfmt string StaticMAC *types.HardwareAddr `json:"static_mac,omitempty"` // PortMappings is a set of ports to map into the infra container. // As, by default, containers share their network with the infra diff --git a/pkg/specgen/specgen.go b/pkg/specgen/specgen.go index 593d91c64..8a4497130 100644 --- a/pkg/specgen/specgen.go +++ b/pkg/specgen/specgen.go @@ -401,6 +401,7 @@ type ContainerNetworkConfig struct { // StaticMAC is a static MAC address to set in the container. // Only available if NetNS is set to bridge. // Optional. + // swagger:strfmt string StaticMAC *nettypes.HardwareAddr `json:"static_mac,omitempty"` // PortBindings is a set of ports to map into the container. // Only available if NetNS is set to bridge or slirp. |