From c6c5dd61bfdb2b54c47d96d482cf29a367a16cb2 Mon Sep 17 00:00:00 2001 From: Boshi LIAN Date: Mon, 1 Sep 2025 22:57:50 -0700 Subject: [PATCH 1/4] fix: update file references and clean up validation comments in models --- doc/docfx.json | 2 +- src/KubernetesClient/Models/KubernetesList.cs | 3 --- src/LibKubernetesGenerator/templates/Model.cs.template | 4 +--- 3 files changed, 2 insertions(+), 7 deletions(-) diff --git a/doc/docfx.json b/doc/docfx.json index 9ba72e4c4..48dd60418 100644 --- a/doc/docfx.json +++ b/doc/docfx.json @@ -4,7 +4,7 @@ "src": [ { "files": [ - "KubernetesClient/KubernetesClient.csproj" + "KubernetesClient/bin/Release/net8.0/KubernetesClient.dll" ], "src": "../src" } diff --git a/src/KubernetesClient/Models/KubernetesList.cs b/src/KubernetesClient/Models/KubernetesList.cs index e8167fd75..5a1e326de 100644 --- a/src/KubernetesClient/Models/KubernetesList.cs +++ b/src/KubernetesClient/Models/KubernetesList.cs @@ -44,9 +44,6 @@ public KubernetesList(IList items, string apiVersion = default, string kind = /// /// Validate the object. /// - /// - /// Thrown if validation fails - /// public void Validate() { if (Items == null) diff --git a/src/LibKubernetesGenerator/templates/Model.cs.template b/src/LibKubernetesGenerator/templates/Model.cs.template index f074ae72c..42e0bd0e6 100644 --- a/src/LibKubernetesGenerator/templates/Model.cs.template +++ b/src/LibKubernetesGenerator/templates/Model.cs.template @@ -61,9 +61,7 @@ namespace k8s.Models /// /// Validate the object. /// - /// - /// Thrown if validation fails - /// + public virtual void Validate() { {{ for property in properties }} From 8816c70093b7ad6b8198f363b4a7ea99b529242d Mon Sep 17 00:00:00 2001 From: Boshi LIAN Date: Mon, 1 Sep 2025 23:02:44 -0700 Subject: [PATCH 2/4] chore: add symlink to CONTRIBUTING.md for easier access --- doc/CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) create mode 120000 doc/CONTRIBUTING.md diff --git a/doc/CONTRIBUTING.md b/doc/CONTRIBUTING.md new file mode 120000 index 000000000..44fcc6343 --- /dev/null +++ b/doc/CONTRIBUTING.md @@ -0,0 +1 @@ +../CONTRIBUTING.md \ No newline at end of file From 978f4604f86d896f31cfc178b90ccfd70071def4 Mon Sep 17 00:00:00 2001 From: Boshi LIAN Date: Mon, 1 Sep 2025 23:19:47 -0700 Subject: [PATCH 3/4] fix: update documentation to include full type names for WebSocket and Predicate --- src/KubernetesClient/IStreamDemuxer.cs | 10 +++++----- src/KubernetesClient/Models/ModelExtensions.cs | 6 +++--- src/KubernetesClient/StreamDemuxer.cs | 10 +++++----- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/src/KubernetesClient/IStreamDemuxer.cs b/src/KubernetesClient/IStreamDemuxer.cs index 2097dcca7..ce46d40f8 100644 --- a/src/KubernetesClient/IStreamDemuxer.cs +++ b/src/KubernetesClient/IStreamDemuxer.cs @@ -3,13 +3,13 @@ namespace k8s /// /// /// The interface allows you to interact with processes running in a container in a Kubernetes pod. You can start an exec or attach command - /// by calling - /// or . These methods - /// will return you a connection. + /// by calling + /// or . These methods + /// will return you a connection. /// /// - /// Kubernetes 'multiplexes' multiple channels over this connection, such as standard input, standard output and standard error. The - /// allows you to extract individual s from this class. You can then use these streams to send/receive data from that process. + /// Kubernetes 'multiplexes' multiple channels over this connection, such as standard input, standard output and standard error. The + /// allows you to extract individual s from this . You can then use these streams to send/receive data from that process. /// /// public interface IStreamDemuxer : IDisposable diff --git a/src/KubernetesClient/Models/ModelExtensions.cs b/src/KubernetesClient/Models/ModelExtensions.cs index 0f4903b93..f2c6f6045 100644 --- a/src/KubernetesClient/Models/ModelExtensions.cs +++ b/src/KubernetesClient/Models/ModelExtensions.cs @@ -208,7 +208,7 @@ public static int FindOwnerReference(this IMetadata obj, IKubernet /// reference could be found. /// /// the object meta - /// a to test owner reference + /// a to test owner reference /// the index of the that matches the given object, or -1 if no such /// reference could be found. public static int FindOwnerReference(this IMetadata obj, Predicate predicate) @@ -300,7 +300,7 @@ public static V1OwnerReference GetOwnerReference( /// Gets the that matches the given predicate, or null if no matching reference exists. /// the object meta - /// a to test owner reference + /// a to test owner reference /// the that matches the given object, or null if no matching reference exists. public static V1OwnerReference GetOwnerReference( this IMetadata obj, @@ -400,7 +400,7 @@ public static V1OwnerReference RemoveOwnerReference( /// any were removed. /// /// the object meta - /// a to test owner reference + /// a to test owner reference /// true if any were removed public static bool RemoveOwnerReferences( this IMetadata obj, diff --git a/src/KubernetesClient/StreamDemuxer.cs b/src/KubernetesClient/StreamDemuxer.cs index 3cebd172e..30263b9eb 100644 --- a/src/KubernetesClient/StreamDemuxer.cs +++ b/src/KubernetesClient/StreamDemuxer.cs @@ -7,13 +7,13 @@ namespace k8s /// /// /// The allows you to interact with processes running in a container in a Kubernetes pod. You can start an exec or attach command - /// by calling - /// or . These methods - /// will return you a connection. + /// by calling + /// or . These methods + /// will return you a connection. /// /// - /// Kubernetes 'multiplexes' multiple channels over this connection, such as standard input, standard output and standard error. The - /// allows you to extract individual s from this class. You can then use these streams to send/receive data from that process. + /// Kubernetes 'multiplexes' multiple channels over this connection, such as standard input, standard output and standard error. The + /// allows you to extract individual s from this . You can then use these streams to send/receive data from that process. /// /// public class StreamDemuxer : IStreamDemuxer From a33653636d5917afc693cf8075af3b5ed65853e5 Mon Sep 17 00:00:00 2001 From: Boshi LIAN Date: Mon, 1 Sep 2025 23:19:51 -0700 Subject: [PATCH 4/4] fix: include CONTRIBUTING.md in docfx.json build content --- doc/docfx.json | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/docfx.json b/doc/docfx.json index 48dd60418..2917802e6 100644 --- a/doc/docfx.json +++ b/doc/docfx.json @@ -20,6 +20,7 @@ "files": [ "api/**.yml", "index.md", + "CONTRIBUTING.md", "toc.yml" ] }