src/api_schema/router.rs: add docu for RpcEnvironmentType

diff --git a/src/api_schema/router.rs b/src/api_schema/router.rs
index e4c61bd7c88a6811c8ff4c435ea877baa1e1ffe8..60d00e4cde1d811426aad2741eca8c03a52719bb 100644 (file)
--- a/src/api_schema/router.rs
+++ b/src/api_schema/router.rs
@@ -32,14 +32,20 @@ pub trait RpcEnvironment {
     fn get_user(&self) -> Option<String>;
 }
 
+
+/// Environment Type
+///
+/// We use this to enumerate the different environment types. Some methods
+/// needs to do different things when started from the command line interface,
+/// or when executed from a privileged server running as root.
 #[derive(PartialEq, Copy, Clone)]
 pub enum RpcEnvironmentType {
-    ///  command started from command line
+    /// Command started from command line
     CLI,
-    /// access from public acessable server
+    /// Access from public accessible server
     PUBLIC,
-    /// ... access from priviledged server (run as root)
-    PRIVILEDGED,
+    /// Access from privileged server (run as root)
+    PRIVILEGED,
 }
 
 #[derive(Debug, Fail)]

diff --git a/src/bin/proxmox-backup-api.rs b/src/bin/proxmox-backup-api.rs
index 22e35b2e6afa15ddefd8b5658e4de1197e8354ff..e9953d77f2313892c1f5bcfa970d0ed1e90fccb5 100644 (file)
--- a/src/bin/proxmox-backup-api.rs
+++ b/src/bin/proxmox-backup-api.rs
@@ -50,7 +50,7 @@ fn run() -> Result<(), Error> {
     }
 
     let config = ApiConfig::new(
-        env!("PROXMOX_JSDIR"), &ROUTER, RpcEnvironmentType::PRIVILEDGED);
+        env!("PROXMOX_JSDIR"), &ROUTER, RpcEnvironmentType::PRIVILEGED);
 
     let rest_server = RestServer::new(config);