docs/examples/ip_address.py missing Interface

[celeroncool]

Diode SDK Python version

v1.10.0

Diode version

v1.10.0

Diode NetBox Plugin version

v1.10.0

NetBox version

v4.5.8

Steps to reproduce

Trying to ingest Device, Interface and Interface IP results in error "TypeError: IPAddress.new() got an unexpected keyword argument 'interface'"
Looking through documentation docs/examples/ip_address.py, I cannot find any mentions of "interface".
The interface object inside IP is last seen in the old documentation: https://github.com/netboxlabs/diode-sdk-python/blob/release/docs/entities.md

Expected behavior

When ingesting IP, it should be possible to assign it to interface.

Observed behavior

No IP is assigned to the created interface.

[mfiedorowicz]

Updated docs are about to be released, in the meantime please see examples from develop branch: https://github.com/netboxlabs/diode-sdk-python/blob/develop/docs/README.md

[celeroncool]

Hmm, the https://github.com/netboxlabs/diode-sdk-python/blob/develop/docs/examples/ip_address.py is also missing interface.
Digging deeper, I found this from

diode-sdk-python/netboxlabs/diode/sdk/ingester.py

Line 3364 in 16287b3

assigned_object_interface: str | Interface | pb.Interface | None = None,

    assigned_object_interface = convert_to_protobuf(
        assigned_object_interface, pb.Interface
    )

So this code works:

        device_obj = Device(
            name=name,
            device_type=DeviceType(
                manufacturer=Manufacturer(name="Juniper"),
                model=model,
            ),
            role=DeviceRole(name=role_name),
            site=Site(name=site_name),
            serial=serial,
            status="active",
        )

        iface_obj = Interface(
            device=device_obj,
            name=iface,
            type="virtual",
            enabled=True,
        )
        iface_entities.append(Entity(interface=iface_obj))

        if ip and ip != "N/A":
            ip_entities.append(Entity(ip_address=IPAddress(
                address=ip,
                status="active",
                assigned_object_interface=iface_obj,
            )))

[mfiedorowicz]

Probably a gap in the generated docs.