Models comments

src/Docker.DotNet/Models/Actor.Generated.cs

@@ -1,6 +1,13 @@
 #nullable enable
 namespace Docker.DotNet.Models
 {
+    /// <summary>
+    /// Actor describes something that generates events,
+    /// like a container, or a network, or a volume.
+    /// It has a defined name and a set of attributes.
+    /// The container attributes are its labels, other actors
+    /// can generate these attributes from other properties.
+    /// </summary>
     public class Actor // (events.Actor)
     {
         [JsonPropertyName("ID")]

src/Docker.DotNet/Models/Annotations.Generated.cs

@@ -1,6 +1,9 @@
 #nullable enable
 namespace Docker.DotNet.Models
 {
+    /// <summary>
+    /// Annotations represents how to describe an object.
+    /// </summary>
     public class Annotations // (swarm.Annotations)
     {
         [JsonPropertyName("Name")]

src/Docker.DotNet/Models/AppArmorOpts.Generated.cs

@@ -1,6 +1,10 @@
 #nullable enable
 namespace Docker.DotNet.Models
 {
+    /// <summary>
+    /// AppArmorOpts defines the options for configuring AppArmor on a swarm-managed
+    /// container.  Currently, custom AppArmor profiles are not supported.
+    /// </summary>
     public class AppArmorOpts // (swarm.AppArmorOpts)
     {
         [JsonPropertyName("Mode")]

src/Docker.DotNet/Models/AttestationProperties.Generated.cs

@@ -3,6 +3,9 @@ namespace Docker.DotNet.Models
 {
     public class AttestationProperties // (image.AttestationProperties)
     {
+        /// <summary>
+        /// For is the digest of the image manifest that this attestation is for.
+        /// </summary>
         [JsonPropertyName("For")]
         public string For { get; set; } = default!;
     }

src/Docker.DotNet/Models/AuthConfig.Generated.cs

@@ -1,6 +1,9 @@
 #nullable enable
 namespace Docker.DotNet.Models
 {
+    /// <summary>
+    /// AuthConfig contains authorization information for connecting to a Registry.
+    /// </summary>
     public class AuthConfig // (registry.AuthConfig)
     {
         [JsonPropertyName("username")]
@@ -15,9 +18,16 @@ public class AuthConfig // (registry.AuthConfig)
         [JsonPropertyName("serveraddress")]
         public string? ServerAddress { get; set; }
 
+        /// <summary>
+        /// IdentityToken is used to authenticate the user and get
+        /// an access token for the registry.
+        /// </summary>
         [JsonPropertyName("identitytoken")]
         public string? IdentityToken { get; set; }
 
+        /// <summary>
+        /// RegistryToken is a bearer token to be sent to a registry
+        /// </summary>
         [JsonPropertyName("registrytoken")]
         public string? RegistryToken { get; set; }
     }

src/Docker.DotNet/Models/AuthResponse.Generated.cs

@@ -1,11 +1,25 @@
 #nullable enable
 namespace Docker.DotNet.Models
 {
+    /// <summary>
+    /// AuthResponse An identity token was generated successfully.
+    /// 
+    /// swagger:model AuthResponse
+    /// </summary>
     public class AuthResponse // (registry.AuthResponse)
     {
+        /// <summary>
+        /// An opaque token used to authenticate a user after a successful login
+        /// Example: 9cbaf023786cd7...
+        /// </summary>
         [JsonPropertyName("IdentityToken")]
         public string? IdentityToken { get; set; }
 
+        /// <summary>
+        /// The status of the authentication
+        /// Example: Login Succeeded
+        /// Required: true
+        /// </summary>
         [JsonPropertyName("Status")]
         public string Status { get; set; } = default!;
     }

src/Docker.DotNet/Models/BindOptions.Generated.cs

@@ -1,6 +1,9 @@
 #nullable enable
 namespace Docker.DotNet.Models
 {
+    /// <summary>
+    /// BindOptions defines options specific to mounts of type &quot;bind&quot;.
+    /// </summary>
     public class BindOptions // (mount.BindOptions)
     {
         [JsonPropertyName("Propagation")]
@@ -12,9 +15,16 @@ public class BindOptions // (mount.BindOptions)
         [JsonPropertyName("CreateMountpoint")]
         public bool? CreateMountpoint { get; set; }
 
+        /// <summary>
+        /// ReadOnlyNonRecursive makes the mount non-recursively read-only, but still leaves the mount recursive
+        /// (unless NonRecursive is set to true in conjunction).
+        /// </summary>
         [JsonPropertyName("ReadOnlyNonRecursive")]
         public bool? ReadOnlyNonRecursive { get; set; }
 
+        /// <summary>
+        /// ReadOnlyForceRecursive raises an error if the mount cannot be made recursively read-only.
+        /// </summary>
         [JsonPropertyName("ReadOnlyForceRecursive")]
         public bool? ReadOnlyForceRecursive { get; set; }
     }

src/Docker.DotNet/Models/BlkioStatEntry.Generated.cs

@@ -1,6 +1,10 @@
 #nullable enable
 namespace Docker.DotNet.Models
 {
+    /// <summary>
+    /// BlkioStatEntry is one small entity to store a piece of Blkio stats
+    /// Not used on Windows.
+    /// </summary>
     public class BlkioStatEntry // (container.BlkioStatEntry)
     {
         [JsonPropertyName("major")]

src/Docker.DotNet/Models/BlkioStats.Generated.cs

@@ -1,8 +1,17 @@
 #nullable enable
 namespace Docker.DotNet.Models
 {
+    /// <summary>
+    /// BlkioStats stores All IO service stats for data read and write.
+    /// This is a Linux specific structure as the differences between expressing
+    /// block I/O on Windows and Linux are sufficiently significant to make
+    /// little sense attempting to morph into a combined structure.
+    /// </summary>
     public class BlkioStats // (container.BlkioStats)
     {
+        /// <summary>
+        /// number of bytes transferred to and from the block device
+        /// </summary>
         [JsonPropertyName("io_service_bytes_recursive")]
         public IList<BlkioStatEntry> IoServiceBytesRecursive { get; set; } = default!;
 

src/Docker.DotNet/Models/CAConfig.Generated.cs

@@ -1,20 +1,39 @@
 #nullable enable
 namespace Docker.DotNet.Models
 {
+    /// <summary>
+    /// CAConfig represents CA configuration.
+    /// </summary>
     public class CAConfig // (swarm.CAConfig)
     {
+        /// <summary>
+        /// NodeCertExpiry is the duration certificates should be issued for
+        /// </summary>
         [JsonPropertyName("NodeCertExpiry")]
         public long? NodeCertExpiry { get; set; }
 
+        /// <summary>
+        /// ExternalCAs is a list of CAs to which a manager node will make
+        /// certificate signing requests for node certificates.
+        /// </summary>
         [JsonPropertyName("ExternalCAs")]
         public IList<ExternalCA>? ExternalCAs { get; set; }
 
+        /// <summary>
+        /// SigningCACert and SigningCAKey specify the desired signing root CA and
+        /// root CA key for the swarm.  When inspecting the cluster, the key will
+        /// be redacted.
+        /// </summary>
         [JsonPropertyName("SigningCACert")]
         public string? SigningCACert { get; set; }
 
         [JsonPropertyName("SigningCAKey")]
         public string? SigningCAKey { get; set; }
 
+        /// <summary>
+        /// If this value changes, and there is no specified signing cert and key,
+        /// then the swarm is forced to generate a new root certificate and key.
+        /// </summary>
         [JsonPropertyName("ForceRotate")]
         public ulong? ForceRotate { get; set; }
     }

src/Docker.DotNet/Models/CPUStats.Generated.cs

@@ -1,17 +1,32 @@
 #nullable enable
 namespace Docker.DotNet.Models
 {
+    /// <summary>
+    /// CPUStats aggregates and wraps all CPU related info of container
+    /// </summary>
     public class CPUStats // (container.CPUStats)
     {
+        /// <summary>
+        /// CPU Usage. Linux and Windows.
+        /// </summary>
         [JsonPropertyName("cpu_usage")]
         public CPUUsage CPUUsage { get; set; } = default!;
 
+        /// <summary>
+        /// System Usage. Linux only.
+        /// </summary>
         [JsonPropertyName("system_cpu_usage")]
         public ulong? SystemUsage { get; set; }
 
+        /// <summary>
+        /// Online CPUs. Linux only.
+        /// </summary>
         [JsonPropertyName("online_cpus")]
         public uint? OnlineCPUs { get; set; }
 
+        /// <summary>
+        /// Throttling Data. Linux only.
+        /// </summary>
         [JsonPropertyName("throttling_data")]
         public ThrottlingData? ThrottlingData { get; set; }
     }

src/Docker.DotNet/Models/CPUUsage.Generated.cs

@@ -1,17 +1,41 @@
 #nullable enable
 namespace Docker.DotNet.Models
 {
+    /// <summary>
+    /// CPUUsage stores All CPU stats aggregated since container inception.
+    /// </summary>
     public class CPUUsage // (container.CPUUsage)
     {
+        /// <summary>
+        /// Total CPU time consumed.
+        /// Units: nanoseconds (Linux)
+        /// Units: 100&apos;s of nanoseconds (Windows)
+        /// </summary>
         [JsonPropertyName("total_usage")]
         public ulong TotalUsage { get; set; } = default!;
 
+        /// <summary>
+        /// Total CPU time consumed per core (Linux). Not used on Windows.
+        /// Units: nanoseconds.
+        /// </summary>
         [JsonPropertyName("percpu_usage")]
         public IList<ulong>? PercpuUsage { get; set; }
 
+        /// <summary>
+        /// Time spent by tasks of the cgroup in kernel mode (Linux).
+        /// Time spent by all container processes in kernel mode (Windows).
+        /// Units: nanoseconds (Linux).
+        /// Units: 100&apos;s of nanoseconds (Windows). Not populated for Hyper-V Containers.
+        /// </summary>
         [JsonPropertyName("usage_in_kernelmode")]
         public ulong UsageInKernelmode { get; set; } = default!;
 
+        /// <summary>
+        /// Time spent by tasks of the cgroup in user mode (Linux).
+        /// Time spent by all container processes in user mode (Windows).
+        /// Units: nanoseconds (Linux).
+        /// Units: 100&apos;s of nanoseconds (Windows). Not populated for Hyper-V Containers
+        /// </summary>
         [JsonPropertyName("usage_in_usermode")]
         public ulong UsageInUsermode { get; set; } = default!;
     }

src/Docker.DotNet/Models/CapacityRange.Generated.cs

@@ -1,11 +1,23 @@
 #nullable enable
 namespace Docker.DotNet.Models
 {
+    /// <summary>
+    /// CapacityRange describes the minimum and maximum capacity a volume should be
+    /// created with
+    /// </summary>
     public class CapacityRange // (volume.CapacityRange)
     {
+        /// <summary>
+        /// RequiredBytes specifies that a volume must be at least this big. The
+        /// value of 0 indicates an unspecified minimum.
+        /// </summary>
         [JsonPropertyName("RequiredBytes")]
         public long RequiredBytes { get; set; } = default!;
 
+        /// <summary>
+        /// LimitBytes specifies that a volume must not be bigger than this. The
+        /// value of 0 indicates an unspecified maximum
+        /// </summary>
         [JsonPropertyName("LimitBytes")]
         public long LimitBytes { get; set; } = default!;
     }

src/Docker.DotNet/Models/ClusterInfo.Generated.cs

@@ -1,6 +1,10 @@
 #nullable enable
 namespace Docker.DotNet.Models
 {
+    /// <summary>
+    /// ClusterInfo represents info about the cluster for outputting in &quot;info&quot;
+    /// it contains the same information as &quot;Swarm&quot;, but without the JoinTokens
+    /// </summary>
     public class ClusterInfo // (swarm.ClusterInfo)
     {
         public ClusterInfo()

src/Docker.DotNet/Models/ClusterOptions.Generated.cs

@@ -1,6 +1,9 @@
 #nullable enable
 namespace Docker.DotNet.Models
 {
+    /// <summary>
+    /// ClusterOptions specifies options for a Cluster volume.
+    /// </summary>
     public class ClusterOptions // (mount.ClusterOptions)
     {
     }

src/Docker.DotNet/Models/ClusterVolume.Generated.cs

@@ -1,6 +1,10 @@
 #nullable enable
 namespace Docker.DotNet.Models
 {
+    /// <summary>
+    /// ClusterVolume contains options and information specific to, and only present
+    /// on, Swarm CSI cluster volumes.
+    /// </summary>
     public class ClusterVolume // (volume.ClusterVolume)
     {
         public ClusterVolume()
@@ -17,6 +21,11 @@ public ClusterVolume(Meta Meta)
             }
         }
 
+        /// <summary>
+        /// ID is the Swarm ID of the volume. Because cluster volumes are Swarm
+        /// objects, they have an ID, unlike non-cluster volumes, which only have a
+        /// Name. This ID can be used to refer to the cluster volume.
+        /// </summary>
         [JsonPropertyName("ID")]
         public string ID { get; set; } = default!;
 
@@ -29,12 +38,22 @@ public ClusterVolume(Meta Meta)
         [JsonPropertyName("UpdatedAt")]
         public DateTime? UpdatedAt { get; set; }
 
+        /// <summary>
+        /// Spec is the cluster-specific options from which this volume is derived.
+        /// </summary>
         [JsonPropertyName("Spec")]
         public ClusterVolumeSpec Spec { get; set; } = default!;
 
+        /// <summary>
+        /// PublishStatus contains the status of the volume as it pertains to its
+        /// publishing on Nodes.
+        /// </summary>
         [JsonPropertyName("PublishStatus")]
         public IList<PublishStatus>? PublishStatus { get; set; }
 
+        /// <summary>
+        /// Info is information about the global status of the volume.
+        /// </summary>
         [JsonPropertyName("Info")]
         public VolumeInfo? Info { get; set; }
     }