Skip to content

Commit 0722db8

Browse files
Add docstring
1 parent 84e9d11 commit 0722db8

File tree

1 file changed

+48
-2
lines changed

1 file changed

+48
-2
lines changed

linode_api4/objects/linode_interfaces.py

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,73 +36,119 @@ class LinodeInterfacesSettings(Base):
3636

3737

3838
# Interface POST Options
39-
40-
4139
@dataclass
4240
class LinodeInterfaceDefaultRouteOptions(JSONObject):
41+
"""
42+
Options accepted when creating or updating a Linode Interface's default route settings.
43+
"""
44+
4345
ipv4: Optional[bool] = None
4446
ipv6: Optional[bool] = None
4547

4648

4749
@dataclass
4850
class LinodeInterfaceVPCIPv4AddressOptions(JSONObject):
51+
"""
52+
Options accepted for a single address when creating or updating the IPv4 configuration of a VPC Linode Interface.
53+
"""
54+
4955
address: str = ""
5056
primary: Optional[bool] = None
5157
nat_1_1_address: Optional[str] = None
5258

5359

5460
@dataclass
5561
class LinodeInterfaceVPCIPv4RangeOptions(JSONObject):
62+
"""
63+
Options accepted for a single range when creating or updating the IPv4 configuration of a VPC Linode Interface.
64+
"""
65+
5666
range: str = ""
5767

5868

5969
@dataclass
6070
class LinodeInterfaceVPCIPv4Options(JSONObject):
71+
"""
72+
Options accepted when creating or updating the IPv4 configuration of a VPC Linode Interface.
73+
"""
74+
6175
addresses: Optional[List[LinodeInterfaceVPCIPv4AddressOptions]] = None
6276
ranges: Optional[List[LinodeInterfaceVPCIPv4RangeOptions]] = None
6377

6478

6579
@dataclass
6680
class LinodeInterfaceVPCOptions(JSONObject):
81+
"""
82+
VPC-exclusive options accepted when creating or updating a Linode Interface.
83+
"""
84+
6785
subnet_id: int = 0
6886
ipv4: Optional[LinodeInterfaceVPCIPv4Options] = None
6987

7088

7189
@dataclass
7290
class LinodeInterfacePublicIPv4AddressOptions(JSONObject):
91+
"""
92+
Options accepted for a single address when creating or updating the IPv4 configuration of a public Linode Interface.
93+
"""
94+
7395
address: str = ""
7496
primary: Optional[bool] = None
7597

7698

7799
@dataclass
78100
class LinodeInterfacePublicIPv4Options(JSONObject):
101+
"""
102+
Options accepted when creating or updating the IPv4 configuration of a public Linode Interface.
103+
"""
104+
79105
addresses: Optional[List[LinodeInterfacePublicIPv4AddressOptions]] = None
80106

81107

82108
@dataclass
83109
class LinodeInterfacePublicIPv6RangeOptions(JSONObject):
110+
"""
111+
Options accepted for a single range when creating or updating the IPv6 configuration of a public Linode Interface.
112+
"""
113+
84114
range: str = ""
85115

86116

87117
@dataclass
88118
class LinodeInterfacePublicIPv6Options(JSONObject):
119+
"""
120+
Options accepted when creating or updating the IPv6 configuration of a public Linode Interface.
121+
"""
122+
89123
ranges: Optional[List[LinodeInterfacePublicIPv6RangeOptions]] = None
90124

91125

92126
@dataclass
93127
class LinodeInterfacePublicOptions(JSONObject):
128+
"""
129+
Public-exclusive options accepted when creating or updating a Linode Interface.
130+
"""
131+
94132
ipv4: Optional[LinodeInterfacePublicIPv4Options] = None
95133
ipv6: Optional[LinodeInterfacePublicIPv6Options] = None
96134

97135

98136
@dataclass
99137
class LinodeInterfaceVLANOptions(JSONObject):
138+
"""
139+
VLAN-exclusive options accepted when creating or updating a Linode Interface.
140+
"""
141+
100142
vlan_label: str = ""
101143
ipam_address: Optional[str] = None
102144

103145

104146
@dataclass
105147
class LinodeInterfaceOptions(JSONObject):
148+
"""
149+
Options accepted when creating or updating a Linode Interface.
150+
"""
151+
106152
firewall_id: Optional[int] = None
107153
default_route: Optional[LinodeInterfaceDefaultRouteOptions] = None
108154
vpc: Optional[LinodeInterfaceVPCOptions] = None

0 commit comments

Comments
 (0)