Update nb_inventory to support NetBox 3.5 (#999)

* Enable CI for 3.5

Author: rodvand

.github/workflows/main.yml

@@ -80,8 +80,8 @@ jobs:
             NETBOX_DOCKER_VERSION: 2.3.0
           - VERSION: "v3.4"
             NETBOX_DOCKER_VERSION: 2.5.3
-          #- VERSION: "v3.5"
-          #  NETBOX_DOCKER_VERSION: 2.6.1
+          - VERSION: "v3.5"
+            NETBOX_DOCKER_VERSION: 2.6.1
         # If we want to integration test wiht all supported Python:
         #python-version: ["3.9", "3.10", "3.11"]
 

plugins/inventory/nb_inventory.py

@@ -1498,23 +1498,39 @@ def fetch_api_docs(self):
         cached_api_version = openapi.get("info", {}).get("version")
 
         if netbox_api_version != cached_api_version:
-            openapi = self._fetch_information(
-                self.api_endpoint + "/api/docs/?format=openapi"
-            )
+            if version.parse(netbox_api_version) >= version.parse("3.5.0"):
+                endpoint_url = self.api_endpoint + "/api/schema/?format=json"
+            else:
+                endpoint_url = self.api_endpoint + "/api/docs/?format=openapi"
 
+            openapi = self._fetch_information(endpoint_url)
             with open(tmp_file, "w") as file:
                 json.dump(openapi, file)
 
-        self.api_version = version.parse(openapi["info"]["version"])
-        self.allowed_device_query_parameters = [
-            p["name"] for p in openapi["paths"]["/dcim/devices/"]["get"]["parameters"]
-        ]
-        self.allowed_vm_query_parameters = [
-            p["name"]
-            for p in openapi["paths"]["/virtualization/virtual-machines/"]["get"][
-                "parameters"
+        self.api_version = version.parse(netbox_api_version)
+
+        if self.api_version >= version.parse("3.5.0"):
+            self.allowed_device_query_parameters = [
+                p["name"]
+                for p in openapi["paths"]["/api/dcim/devices/"]["get"]["parameters"]
+            ]
+            self.allowed_vm_query_parameters = [
+                p["name"]
+                for p in openapi["paths"]["/api/virtualization/virtual-machines/"][
+                    "get"
+                ]["parameters"]
+            ]
+        else:
+            self.allowed_device_query_parameters = [
+                p["name"]
+                for p in openapi["paths"]["/dcim/devices/"]["get"]["parameters"]
+            ]
+            self.allowed_vm_query_parameters = [
+                p["name"]
+                for p in openapi["paths"]["/virtualization/virtual-machines/"]["get"][
+                    "parameters"
+                ]
             ]
-        ]
 
     def validate_query_parameter(self, parameter, allowed_query_parameters):
         if not (isinstance(parameter, dict) and len(parameter) == 1):

poetry.lock

@@ -237,6 +237,7 @@
                     "parent-region"
                 ],
                 "role": "core-switch",
+                "serial": "",
                 "services": [
                     {
                         "comments": "",
@@ -268,8 +269,7 @@
                     "label": "Active",
                     "value": "active"
                 },
-                "tags": [],
-                "serial": ""
+                "tags": []
             },
             "TestDeviceR1": {
                 "config_context": {},
@@ -288,17 +288,18 @@
                     "parent-region"
                 ],
                 "role": "core-switch",
+                "serial": "FAB12345678",
                 "services": [],
                 "site": "test-site",
                 "site_groups": [],
                 "status": {
                     "label": "Active",
                     "value": "active"
                 },
-                "tags": [],
-                "serial": "FAB12345678"
+                "tags": []
             },
             "test100": {
+                "asset_tag": "123456789",
                 "config_context": {
                     "ntp_servers": [
                         "pool.ntp.org"
@@ -540,6 +541,7 @@
                     "parent-region"
                 ],
                 "role": "core-switch",
+                "serial": "FAB01234567",
                 "services": [
                     {
                         "comments": "",
@@ -607,9 +609,7 @@
                     "label": "Active",
                     "value": "active"
                 },
-                "tags": [],
-                "serial": "FAB01234567",
-                "asset_tag": "123456789"
+                "tags": []
             },
             "test100-vm": {
                 "cluster": "Test Cluster",
@@ -965,25 +965,25 @@
     },
     "all": {
         "children": [
-            "cluster_Test_Cluster",
-            "cluster_group_test_cluster_group",
-            "cluster_type_test_cluster_type",
-            "device_type_cisco_test",
-            "device_type_nexus_parent",
-            "is_virtual",
-            "manufacturer_cisco",
-            "rack_Test_Rack",
+            "ungrouped",
+            "site_test_site2",
             "region_other_region",
             "region_parent_region",
-            "role_core_switch",
-            "service_http",
-            "service_ssh",
-            "service_telnet",
             "site_group_other_site_group",
             "site_group_parent_site_group",
-            "site_test_site2",
+            "role_core_switch",
+            "device_type_nexus_parent",
+            "manufacturer_cisco",
+            "service_telnet",
             "status_active",
-            "ungrouped"
+            "rack_Test_Rack",
+            "device_type_cisco_test",
+            "service_ssh",
+            "service_http",
+            "cluster_Test_Cluster",
+            "cluster_group_test_cluster_group",
+            "cluster_type_test_cluster_type",
+            "is_virtual"
         ]
     },
     "cluster_Test_Cluster": {
@@ -1010,14 +1010,6 @@
             "test103-vm"
         ]
     },
-    "is_virtual": {
-        "hosts": [
-            "test100-vm",
-            "test101-vm",
-            "test102-vm",
-            "test103-vm"
-        ]
-    },
     "device_type_cisco_test": {
         "hosts": [
             "TestDeviceR1",
@@ -1029,6 +1021,14 @@
             "Test Nexus One"
         ]
     },
+    "is_virtual": {
+        "hosts": [
+            "test100-vm",
+            "test101-vm",
+            "test102-vm",
+            "test103-vm"
+        ]
+    },
     "location_parent_rack_group": {
         "children": [
             "location_test_rack_group"
@@ -1091,14 +1091,14 @@
         ]
     },
     "site_test_site": {
+        "children": [
+            "location_parent_rack_group"
+        ],
         "hosts": [
             "test100-vm",
             "test101-vm",
             "test102-vm",
             "test103-vm"
-        ],        
-        "children": [
-            "location_parent_rack_group"
         ]
     },
     "status_active": {