Documentation

Author: Raul Hidalgo Caballero

src/GraphQL.Client/IGraphQLClient.cs

@@ -6,12 +6,34 @@
 
 namespace GraphQL.Client {
 
+	/// <summary>
+	/// Represents the Interface that any GraphQL Client must implement
+	/// </summary>
 	public interface IGraphQLClient : IDisposable {
 
+		/// <summary>
+		/// Send a Query async
+		/// </summary>
+		/// <param name="request">The Request</param>
+		/// <param name="cancellationToken">The Cancellation Token</param>
+		/// <returns>The Response</returns>
 		Task<GraphQLResponse> SendQueryAsync(GraphQLRequest request, CancellationToken cancellationToken = default);
 
+		/// <summary>
+		/// Send a Mutation Async
+		/// </summary>
+		/// <param name="request">The Request</param>
+		/// <param name="cancellationToken">The Cancellation Token</param>
+		/// <returns>The Response</returns>
 		Task<GraphQLResponse> SendMutationAsync(GraphQLRequest request, CancellationToken cancellationToken = default);
 
+		/// <summary>
+		/// Send a Subscription async
+		/// </summary>
+		/// <param name="request">The Request</param>
+		/// <param name="cancellationToken">The Cancellation Token</param>
+		/// <returns>The Subscription Response</returns>
+		[Obsolete("EXPERIMENTAL")]
 		Task<IGraphQLSubscriptionResult> SendSubscribeAsync(GraphQLRequest request, CancellationToken cancellationToken = default);
 
 	}

src/GraphQL.Client/IGraphQLSubscriptionResult.cs

@@ -3,10 +3,20 @@
 
 namespace GraphQL.Client {
 
+	/// <summary>
+	/// Represents the Result of a subscription
+	/// </summary>
+	[Obsolete("EXPERIMENTAL")]
 	public interface IGraphQLSubscriptionResult : IDisposable {
 
+		/// <summary>
+		/// Event triggered when a new Response is received
+		/// </summary>
 		event Action<GraphQLResponse> OnReceive;
 
+		/// <summary>
+		/// Last Response Received
+		/// </summary>
 		GraphQLResponse LastResponse { get; }
 
 	}