Document DataMapping

[itdependsnetworks]

Environment

• Nautobot version: latest
• nautobot-ssot version: latest

Proposed Functionality

Document the data_mappings classmethod and DataMapping class, e.g.

    @classmethod
    def data_mappings(cls):
        """Shows mapping of models between ACI and Nautobot."""
        return (
            DataMapping("Tenant", None, "Tenant", reverse("tenancy:tenant_list")),
            DataMapping("Node", None, "Device", reverse("dcim:device_list")),
            DataMapping("Model", None, "Device Type", reverse("dcim:devicetype_list")),
            DataMapping("Controller/Leaf/Spine OOB Mgmt IP", None, "IP Address", reverse("ipam:ipaddress_list")),
            DataMapping("Subnet", None, "Prefix", reverse("ipam:prefix_list")),
            DataMapping("Interface", None, "Interface", reverse("dcim:interface_list")),
            DataMapping("VRF", None, "VRF", reverse("ipam:vrf_list")),
        )

Use Case

to communicate how thing the ui is populated.

[Kircheneer]

In addition, this should auto-populate from nautobot_ssot.contrib.NautobotAdapter