Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/CONTRIBUTING.md
3 changes: 2 additions & 1 deletion doc/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"src": [
{
"files": [
"KubernetesClient/KubernetesClient.csproj"
"KubernetesClient/bin/Release/net8.0/KubernetesClient.dll"
],
"src": "../src"
}
Expand All @@ -20,6 +20,7 @@
"files": [
"api/**.yml",
"index.md",
"CONTRIBUTING.md",
"toc.yml"
]
}
Expand Down
10 changes: 5 additions & 5 deletions src/KubernetesClient/IStreamDemuxer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@ namespace k8s
/// <summary>
/// <para>
/// The <see cref="IStreamDemuxer"/> 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 <see cref="Kubernetes.WebSocketNamespacedPodExecAsync(string, string, IEnumerable{string}, string, bool, bool, bool, bool, Dictionary{string, List{string}}, CancellationToken)"/>
/// or <see cref="Kubernetes.WebSocketNamespacedPodAttachAsync(string, string, string, bool, bool, bool, bool, Dictionary{string, List{string}}, CancellationToken)"/>. These methods
/// will return you a <see cref="WebSocket"/> connection.
/// by calling <see cref="Kubernetes.WebSocketNamespacedPodExecAsync(string, string, IEnumerable{string}, string, bool, bool, bool, bool, string, Dictionary{string, List{string}}, CancellationToken)"/>
/// or <see cref="Kubernetes.WebSocketNamespacedPodAttachAsync(string, string, string, bool, bool, bool, bool, string, Dictionary{string, List{string}}, CancellationToken)"/>. These methods
/// will return you a <see cref="System.Net.WebSockets.WebSocket"/> connection.
/// </para>
/// <para>
/// Kubernetes 'multiplexes' multiple channels over this <see cref="WebSocket"/> connection, such as standard input, standard output and standard error. The <see cref="StreamDemuxer"/>
/// allows you to extract individual <see cref="Stream"/>s from this <see cref="WebSocket"/> class. You can then use these streams to send/receive data from that process.
/// Kubernetes 'multiplexes' multiple channels over this <see cref="System.Net.WebSockets.WebSocket"/> connection, such as standard input, standard output and standard error. The <see cref="StreamDemuxer"/>
/// allows you to extract individual <see cref="Stream"/>s from this <see cref="System.Net.WebSockets.WebSocket"/>. You can then use these streams to send/receive data from that process.
/// </para>
/// </summary>
public interface IStreamDemuxer : IDisposable
Expand Down
3 changes: 0 additions & 3 deletions src/KubernetesClient/Models/KubernetesList.cs
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,6 @@ public KubernetesList(IList<T> items, string apiVersion = default, string kind =
/// <summary>
/// Validate the object.
/// </summary>
/// <exception cref="ValidationException">
/// Thrown if validation fails
/// </exception>
public void Validate()
{
if (Items == null)
Expand Down
6 changes: 3 additions & 3 deletions src/KubernetesClient/Models/ModelExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ public static int FindOwnerReference(this IMetadata<V1ObjectMeta> obj, IKubernet
/// reference could be found.
/// </summary>
/// <param name="obj">the object meta<see cref="V1ObjectMeta"/></param>
/// <param name="predicate">a <see cref="Predicate"/> to test owner reference</param>
/// <param name="predicate">a <see cref="System.Predicate{V1OwnerReference}"/> to test owner reference</param>
/// <returns>the index of the <see cref="V1OwnerReference"/> that matches the given object, or -1 if no such
/// reference could be found.</returns>
public static int FindOwnerReference(this IMetadata<V1ObjectMeta> obj, Predicate<V1OwnerReference> predicate)
Expand Down Expand Up @@ -300,7 +300,7 @@ public static V1OwnerReference GetOwnerReference(

/// <summary>Gets the <see cref="V1OwnerReference"/> that matches the given predicate, or null if no matching reference exists.</summary>
/// <param name="obj">the object meta<see cref="V1ObjectMeta"/></param>
/// <param name="predicate">a <see cref="Predicate"/> to test owner reference</param>
/// <param name="predicate">a <see cref="System.Predicate{V1OwnerReference}"/> to test owner reference</param>
/// <returns>the <see cref="V1OwnerReference"/> that matches the given object, or null if no matching reference exists.</returns>
public static V1OwnerReference GetOwnerReference(
this IMetadata<V1ObjectMeta> obj,
Expand Down Expand Up @@ -400,7 +400,7 @@ public static V1OwnerReference RemoveOwnerReference(
/// any were removed.
/// </summary>
/// <param name="obj">the object meta<see cref="V1ObjectMeta"/></param>
/// <param name="predicate">a <see cref="Predicate"/> to test owner reference</param>
/// <param name="predicate">a <see cref="System.Predicate{V1OwnerReference}"/> to test owner reference</param>
/// <returns>true if any were removed</returns>
public static bool RemoveOwnerReferences(
this IMetadata<V1ObjectMeta> obj,
Expand Down
10 changes: 5 additions & 5 deletions src/KubernetesClient/StreamDemuxer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ namespace k8s
/// <summary>
/// <para>
/// The <see cref="StreamDemuxer"/> allows you to interact with processes running in a container in a Kubernetes pod. You can start an exec or attach command
/// by calling <see cref="Kubernetes.WebSocketNamespacedPodExecAsync(string, string, IEnumerable{string}, string, bool, bool, bool, bool, Dictionary{string, List{string}}, CancellationToken)"/>
/// or <see cref="Kubernetes.WebSocketNamespacedPodAttachAsync(string, string, string, bool, bool, bool, bool, Dictionary{string, List{string}}, CancellationToken)"/>. These methods
/// will return you a <see cref="WebSocket"/> connection.
/// by calling <see cref="Kubernetes.WebSocketNamespacedPodExecAsync(string, string, IEnumerable{string}, string, bool, bool, bool, bool, string, Dictionary{string, List{string}}, CancellationToken)"/>
/// or <see cref="Kubernetes.WebSocketNamespacedPodAttachAsync(string, string, string, bool, bool, bool, bool, string, Dictionary{string, List{string}}, CancellationToken)"/>. These methods
/// will return you a <see cref="System.Net.WebSockets.WebSocket"/> connection.
/// </para>
/// <para>
/// Kubernetes 'multiplexes' multiple channels over this <see cref="WebSocket"/> connection, such as standard input, standard output and standard error. The <see cref="StreamDemuxer"/>
/// allows you to extract individual <see cref="Stream"/>s from this <see cref="WebSocket"/> class. You can then use these streams to send/receive data from that process.
/// Kubernetes 'multiplexes' multiple channels over this <see cref="System.Net.WebSockets.WebSocket"/> connection, such as standard input, standard output and standard error. The <see cref="StreamDemuxer"/>
/// allows you to extract individual <see cref="Stream"/>s from this <see cref="System.Net.WebSockets.WebSocket"/>. You can then use these streams to send/receive data from that process.
/// </para>
/// </summary>
public class StreamDemuxer : IStreamDemuxer
Expand Down
4 changes: 1 addition & 3 deletions src/LibKubernetesGenerator/templates/Model.cs.template
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,7 @@ namespace k8s.Models
/// <summary>
/// Validate the object.
/// </summary>
/// <exception cref="ValidationException">
/// Thrown if validation fails
/// </exception>

public virtual void Validate()
{
{{ for property in properties }}
Expand Down
Loading