tmp

src/publisher/api_client.rs

@@ -9,7 +9,10 @@ extern crate thanix_client;
 
 use reqwest::{blocking::Client, Error as ReqwestError};
 use thanix_client::{
-    paths::{dcim_devices_create, dcim_interfaces_create, DcimDevicesCreateResponse},
+    paths::{
+        dcim_devices_create, dcim_interfaces_create, DcimDevicesCreateResponse,
+        DcimInterfacesCreateResponse,
+    },
     types::{WritableDeviceWithConfigContextRequest, WritableInterfaceRequest},
     util::ThanixClient,
 };

src/publisher/translator.rs

@@ -221,6 +221,10 @@ pub fn information_to_interface(
 /// # Returns
 ///
 /// Returns `Some(i64)` if the specified platform exists, else returns `None`.
+///
+/// # Aborts
+///
+/// If the netBox connection fails, this may terimnate the process.
 fn get_platform_id(state: &ThanixClient, platform_name: String) -> Option<i64> {
     println!("Searching for id of platform '{}' ... ", platform_name);
     let platform_list: Vec<Platform>;
@@ -260,13 +264,18 @@ fn get_platform_id(state: &ThanixClient, platform_name: String) -> Option<i64> {
 /// The function will retrieve a list of IPv4 Adresses from NetBox,
 /// then search this list for the IP Adress Nazara collected.
 ///
-/// The "primary_network_interface" paramter specified in the `nazara_config.toml`
+/// The `primary_network_interface` paramter specified in the `nazara_config.toml`
 /// will be used to specify which adress to search for.
 ///
 /// # Parameters
 ///
 /// * state: `&ThanixClient` - The client required for making API requests.
 /// * machine: `&Machine` - The collected machine information.
+///
+/// # Returns
+///
+/// Returns the ID of the IP address object `i64` if a match has been found.
+/// Else returns `None`.
 fn get_primary_addresses(
     state: &ThanixClient,
     machine: &Machine,