src/api2/types.rs: define and use api type GarbageCollectionStatus

src/api2/admin/datastore.rs

@@ -509,32 +509,30 @@ fn start_garbage_collection(
     Ok(json!(upid_str))
 }
 
-#[sortable]
-pub const API_METHOD_GARBAGE_COLLECTION_STATUS: ApiMethod = ApiMethod::new(
-    &ApiHandler::Sync(&garbage_collection_status),
-    &ObjectSchema::new(
-        "Garbage collection status.",
-        &sorted!([
-            ("store", false, &DATASTORE_SCHEMA),
-        ])
-    )
-);
-
+#[api(
+    input: {
+        properties: {
+            store: {
+                schema: DATASTORE_SCHEMA,
+            },
+        },
+    },
+    returns: {
+        type: GarbageCollectionStatus,
+    }
+)]
+/// Garbage collection status.
 fn garbage_collection_status(
-    param: Value,
+    store: String,
     _info: &ApiMethod,
     _rpcenv: &mut dyn RpcEnvironment,
-) -> Result<Value, Error> {
-
-    let store = param["store"].as_str().unwrap();
+) -> Result<GarbageCollectionStatus, Error> {
 
     let datastore = DataStore::lookup_datastore(&store)?;
 
-    println!("Garbage collection status on store {}", store);
-
     let status = datastore.last_gc_status();
 
-    Ok(serde_json::to_value(&status)?)
+    Ok(status)
 }
 
 

src/api2/types.rs

@@ -276,6 +276,48 @@ pub struct BackupContent {
     pub size: Option<u64>,
 }
 
+#[api(
+    properties: {
+        "upid": {
+            optional: true,
+            schema: UPID_SCHEMA,
+        },
+    },
+)]
+#[derive(Clone, Serialize, Deserialize)]
+#[serde(rename_all="kebab-case")]
+/// Garbage collection status.
+pub struct GarbageCollectionStatus {
+    pub upid: Option<String>,
+    /// Number of processed index files.
+    pub index_file_count: usize,
+    /// Sum of bytes referred by index files.
+    pub index_data_bytes: u64,
+    /// Bytes used on disk.
+    pub disk_bytes: u64,
+    /// Chunks used on disk.
+    pub disk_chunks: usize,
+    /// Sum of removed bytes.
+    pub removed_bytes: u64,
+    /// Number of removed chunks.
+    pub removed_chunks: usize,
+}
+
+impl Default for GarbageCollectionStatus {
+    fn default() -> Self {
+        GarbageCollectionStatus {
+            upid: None,
+            index_file_count: 0,
+            index_data_bytes: 0,
+            disk_bytes: 0,
+            disk_chunks: 0,
+            removed_bytes: 0,
+            removed_chunks: 0,
+        }
+    }
+}
+
+
 #[api()]
 #[derive(Serialize, Deserialize)]
 /// Storage space usage information.