From 70991e6bacb1d4e21912c1feabb89ff23ddef74d Mon Sep 17 00:00:00 2001
From: NaiJi <naijiworld@protonmail.com>
Date: Mon, 10 Jul 2023 05:44:56 -0300
Subject: [PATCH] chore(models): Add commentary for Hetzner Volume replicating
 Hetzner documentation

---
 lib/logic/models/json/hetzner_server_info.dart | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/lib/logic/models/json/hetzner_server_info.dart b/lib/logic/models/json/hetzner_server_info.dart
index b0706599..557f8ea7 100644
--- a/lib/logic/models/json/hetzner_server_info.dart
+++ b/lib/logic/models/json/hetzner_server_info.dart
@@ -137,6 +137,12 @@ class HetznerLocation {
       _$HetznerLocationFromJson(json);
 }
 
+/// A Volume is a highly-available, scalable, and SSD-based block storage for Servers.
+///
+/// Pricing for Volumes depends on the Volume size and Location, not the actual used storage.
+///
+/// Please see Hetzner Docs for more details about Volumes.
+/// https://docs.hetzner.cloud/#volumes
 @JsonSerializable()
 class HetznerVolume {
   HetznerVolume(
@@ -146,11 +152,20 @@ class HetznerVolume {
     this.name,
     this.linuxDevice,
   );
+
+  /// ID of the Resource
   final int id;
+
+  /// Size in GB of the Volume
   final int size;
+
+  /// ID of the Server the Volume is attached to, null if it is not attached at all
   final int? serverId;
+
+  /// Name of the Resource. Is unique per Project.
   final String name;
 
+  /// Device path on the file system for the Volume
   @JsonKey(name: 'linux_device')
   final String? linuxDevice;