more docs

Author: lgarber-akamai

linode_api4/objects/linode_interfaces.py

@@ -9,12 +9,20 @@
 
 @dataclass
 class LinodeInterfacesSettingsDefaultRouteOptions(JSONObject):
+    """
+    The options used to configure the default route settings for a Linode's network interfaces.
+    """
+
     ipv4_interface_id: Optional[int] = None
     ipv6_interface_id: Optional[int] = None
 
 
 @dataclass
 class LinodeInterfacesSettingsDefaultRoute(JSONObject):
+    """
+    The default route settings for a Linode's network interfaces.
+    """
+
     put_class = LinodeInterfacesSettingsDefaultRouteOptions
 
     ipv4_interface_id: Optional[int] = None
@@ -24,6 +32,12 @@ class LinodeInterfacesSettingsDefaultRoute(JSONObject):
 
 
 class LinodeInterfacesSettings(Base):
+    """"
+    The settings for a Linode's network interfaces.
+
+    API Documentation: Not yet available.
+    """
+
     api_endpoint = "/linode/instances/{id}/interfaces/settings"
 
     properties = {
@@ -161,6 +175,10 @@ class LinodeInterfaceOptions(JSONObject):
 
 @dataclass
 class LinodeInterfaceDefaultRoute(JSONObject):
+    """
+    The default route configuration of a Linode Interface.
+    """
+
     put_class = LinodeInterfaceDefaultRouteOptions
 
     ipv4: bool = False
@@ -169,6 +187,10 @@ class LinodeInterfaceDefaultRoute(JSONObject):
 
 @dataclass
 class LinodeInterfaceVPCIPv4Address(JSONObject):
+    """
+    A single address under the IPv4 configuration of a VPC Linode Interface.
+    """
+
     put_class = LinodeInterfaceVPCIPv4AddressOptions
 
     address: str = ""
@@ -178,13 +200,21 @@ class LinodeInterfaceVPCIPv4Address(JSONObject):
 
 @dataclass
 class LinodeInterfaceVPCIPv4Range(JSONObject):
+    """
+    A single range under the IPv4 configuration of a VPC Linode Interface.
+    """
+
     put_class = LinodeInterfaceVPCIPv4RangeOptions
 
     range: str = ""
 
 
 @dataclass
 class LinodeInterfaceVPCIPv4(JSONObject):
+    """
+    A single address under the IPv4 configuration of a VPC Linode Interface.
+    """
+
     put_class = LinodeInterfaceVPCIPv4Options
 
     addresses: List[LinodeInterfaceVPCIPv4Address] = field(default_factory=list)
@@ -193,6 +223,10 @@ class LinodeInterfaceVPCIPv4(JSONObject):
 
 @dataclass
 class LinodeInterfaceVPC(JSONObject):
+    """
+    VPC-specific configuration field for a Linode Interface.
+    """
+
     put_class = LinodeInterfaceVPCOptions
 
     vpc_id: int = 0
@@ -203,6 +237,10 @@ class LinodeInterfaceVPC(JSONObject):
 
 @dataclass
 class LinodeInterfacePublicIPv4Address(JSONObject):
+    """
+    A single address under the IPv4 configuration of a public Linode Interface.
+    """
+
     put_class = LinodeInterfacePublicIPv4AddressOptions
 
     address: str = ""
@@ -211,12 +249,20 @@ class LinodeInterfacePublicIPv4Address(JSONObject):
 
 @dataclass
 class LinodeInterfacePublicIPv4Shared(JSONObject):
+    """
+    A single shared address under the IPv4 configuration of a public Linode Interface.
+    """
+
     address: str = ""
     linode_id: int = 0
 
 
 @dataclass
 class LinodeInterfacePublicIPv4(JSONObject):
+    """
+    The IPv4 configuration of a public Linode Interface.
+    """
+
     put_class = LinodeInterfacePublicIPv4Options
 
     addresses: List[LinodeInterfacePublicIPv4Address] = field(
@@ -227,18 +273,30 @@ class LinodeInterfacePublicIPv4(JSONObject):
 
 @dataclass
 class LinodeInterfacePublicIPv6SLAAC(JSONObject):
+    """
+    A single SLAAC entry under the IPv6 configuration of a public Linode Interface.
+    """
+
     address: str = ""
     prefix: int = 0
 
 
 @dataclass
 class LinodeInterfacePublicIPv6Shared(JSONObject):
+    """
+    A single shared range under the IPv6 configuration of a public Linode Interface.
+    """
+
     range: str = ""
     route_target: Optional[str] = None
 
 
 @dataclass
 class LinodeInterfacePublicIPv6Range(JSONObject):
+    """
+    A single range under the IPv6 configuration of a public Linode Interface.
+    """
+
     put_class = LinodeInterfacePublicIPv6RangeOptions
 
     range: str = ""
@@ -247,6 +305,10 @@ class LinodeInterfacePublicIPv6Range(JSONObject):
 
 @dataclass
 class LinodeInterfacePublicIPv6(JSONObject):
+    """
+    The IPv6 configuration of a Linode Interface.
+    """
+
     put_class = LinodeInterfacePublicIPv6Options
 
     slaac: List[LinodeInterfacePublicIPv6SLAAC] = field(default_factory=list)
@@ -256,6 +318,10 @@ class LinodeInterfacePublicIPv6(JSONObject):
 
 @dataclass
 class LinodeInterfacePublic(JSONObject):
+    """
+    Public-specific configuration field for a Linode Interface.
+    """
+
     put_class = LinodeInterfacePublicOptions
 
     ipv4: Optional[LinodeInterfacePublicIPv4] = None
@@ -264,6 +330,10 @@ class LinodeInterfacePublic(JSONObject):
 
 @dataclass
 class LinodeInterfaceVLAN(JSONObject):
+    """
+    VLAN-specific configuration field for a Linode Interface.
+    """
+
     put_class = LinodeInterfaceVLANOptions
 
     vlan_label: str = ""
@@ -274,7 +344,7 @@ class LinodeInterface(DerivedBase):
     """
     A Linode's network interface.
 
-    API Documentation: Not yet available.
+    API Documentation: https://techdocs.akamai.com/linode-api/reference/get-linode-interface
     """
 
     api_endpoint = "/linode/instances/{linode_id}/interfaces/{id}"
@@ -310,6 +380,8 @@ def firewalls(self, *filters) -> List[Firewall]:
 
         NOTE: Caching is disabled on this method and each call will make
         an additional Linode API request.
+
+        API Documentation: Not yet available.
         """
 
         return self._client._get_and_filter(