- add summary info for documentation files

- add license acceptance requirement to add package
- bump version

Author: modabas

Directory.Build.props

@@ -16,7 +16,8 @@
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
 
-    <Version>0.4.2</Version>
+    <Version>0.4.3</Version>
   </PropertyGroup>
 </Project>

src/ModEndpoints.Core/[Configuration]/MapToGroupAttribute.cs

@@ -1,8 +1,9 @@
 namespace ModEndpoints.Core;
 
 /// <summary>
-/// 
+/// Attribute to map targeted endpoint or route group under specified parent route group.
 /// </summary>
+/// <typeparam name="TGroup"></typeparam>
 [AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = false)]
 public class MapToGroupAttribute<TGroup> : Attribute
   where TGroup : IRouteGroupConfigurator, new()

src/ModEndpoints.RemoteServices/DependencyInjectionExtensions.cs

@@ -11,6 +11,15 @@ public static class DependencyInjectionExtensions
   private const string ChannelAlreadyRegistered = "A channel for request type {0} is already registered.";
   private const string ChannelCannotBeRegistered = "Channel couldn't be registered for request type {0} and client name {1}.";
 
+  /// <summary>
+  /// Adds and configures a new client for specified ServiceEndpoint request.
+  /// </summary>
+  /// <typeparam name="TRequest">ServiceEndpoint request type to be processed.</typeparam>
+  /// <param name="services"></param>
+  /// <param name="baseAddress">Base address of Uri of the Internet resource used when sending requests.</param>
+  /// <param name="timeout">Timespan to wait before the request times out.</param>
+  /// <param name="configureClientBuilder">Delegate to further customize <see cref="IHttpClientBuilder"/> for added <see cref="HttpClient"/>.</param>
+  /// <returns></returns>
   public static IServiceCollection AddRemoteServiceWithNewClient<TRequest>(
     this IServiceCollection services,
     string baseAddress,
@@ -26,6 +35,16 @@ public static IServiceCollection AddRemoteServiceWithNewClient<TRequest>(
       configureClientBuilder);
   }
 
+  /// <summary>
+  /// Adds and configures a new client for specified ServiceEndpoint request.
+  /// </summary>
+  /// <typeparam name="TRequest">ServiceEndpoint request type to be processed.</typeparam>
+  /// <param name="services"></param>
+  /// <param name="clientName">The logical name for the client to configure.</param>
+  /// <param name="baseAddress">Base address of Uri of the Internet resource used when sending requests.</param>
+  /// <param name="timeout">Timespan to wait before the request times out.</param>
+  /// <param name="configureClientBuilder">Delegate to further customize <see cref="IHttpClientBuilder"/> for added <see cref="HttpClient"/>.</param>
+  /// <returns></returns>
   public static IServiceCollection AddRemoteServiceWithNewClient<TRequest>(
     this IServiceCollection services,
     string clientName,
@@ -48,6 +67,14 @@ public static IServiceCollection AddRemoteServiceWithNewClient<TRequest>(
       configureClientBuilder);
   }
 
+  /// <summary>
+  /// Adds and configures a new client for specified ServiceEndpoint request.
+  /// </summary>
+  /// <typeparam name="TRequest">ServiceEndpoint request type to be processed.</typeparam>
+  /// <param name="services"></param>
+  /// <param name="configureClient">Delegate that will be used to configure <see cref="HttpClient"/>.</param>
+  /// <param name="configureClientBuilder">Delegate to further customize <see cref="IHttpClientBuilder"/> for added <see cref="HttpClient"/>.</param>
+  /// <returns></returns>
   public static IServiceCollection AddRemoteServiceWithNewClient<TRequest>(
     this IServiceCollection services,
     Action<IServiceProvider, HttpClient> configureClient,
@@ -61,6 +88,16 @@ public static IServiceCollection AddRemoteServiceWithNewClient<TRequest>(
       configureClientBuilder);
   }
 
+  /// <summary>
+  /// Adds and configures a new client for specified ServiceEndpoint request.
+  /// </summary>
+  /// <typeparam name="TRequest">ServiceEndpoint request type to be processed.</typeparam>
+  /// <param name="services"></param>
+  /// <param name="clientName">The logical name for the client to configure.</param>
+  /// <param name="configureClient">Delegate that will be used to configure <see cref="HttpClient"/>.</param>
+  /// <param name="configureClientBuilder">Delegate to further customize <see cref="IHttpClientBuilder"/> for added <see cref="HttpClient"/>.</param>
+  /// <returns></returns>
+  /// <exception cref="InvalidOperationException"></exception>
   public static IServiceCollection AddRemoteServiceWithNewClient<TRequest>(
     this IServiceCollection services,
     string clientName,
@@ -80,6 +117,14 @@ public static IServiceCollection AddRemoteServiceWithNewClient<TRequest>(
       configureClientBuilder);
   }
 
+  /// <summary>
+  /// Adds specified ServiceEndpoint request to an already added and configured client.
+  /// </summary>
+  /// <typeparam name="TRequest">ServiceEndpoint request type to be processed.</typeparam>
+  /// <param name="services"></param>
+  /// <param name="clientName">The logical name for the client to configure.</param>
+  /// <returns></returns>
+  /// <exception cref="InvalidOperationException"></exception>
   public static IServiceCollection AddRemoteServiceToExistingClient<TRequest>(
     this IServiceCollection services,
     string clientName)
@@ -92,6 +137,17 @@ public static IServiceCollection AddRemoteServiceToExistingClient<TRequest>(
     return services.AddRemoteServiceToExistingClientInternal(typeof(TRequest), clientName);
   }
 
+  /// <summary>
+  /// Adds and configures a new client for ServiceEndpoint requests in specified assembly.
+  /// </summary>
+  /// <param name="services"></param>
+  /// <param name="fromAssembly">Name of the assembly that will be scanned for ServiceEndpoint requests.</param>
+  /// <param name="clientName">The logical name for the client to configure.</param>
+  /// <param name="configureClient">Delegate that will be used to configure <see cref="HttpClient"/>.</param>
+  /// <param name="configureClientBuilder">Delegate to further customize <see cref="IHttpClientBuilder"/> for added <see cref="HttpClient"/>.</param>
+  /// <param name="requestFilterPredicate">A predicate to filter ServiceEndpoint requests found, before being processed.</param>
+  /// <returns></returns>
+  /// <exception cref="InvalidOperationException"></exception>
   public static IServiceCollection AddRemoteServicesWithNewClient(
     this IServiceCollection services,
     Assembly fromAssembly,
@@ -128,6 +184,15 @@ public static IServiceCollection AddRemoteServicesWithNewClient(
     return services;
   }
 
+  /// <summary>
+  /// Adds ServiceEndpoint requests in specified assembly to an already added and configured client.
+  /// </summary>
+  /// <param name="services"></param>
+  /// <param name="fromAssembly">Name of the assembly that will be scanned for ServiceEndpoint requests.</param>
+  /// <param name="clientName">The logical name for the client to configure.</param>
+  /// <param name="requestFilterPredicate">A predicate to filter ServiceEndpoint requests found, before being processed.</param>
+  /// <returns></returns>
+  /// <exception cref="InvalidOperationException"></exception>
   public static IServiceCollection AddRemoteServicesToExistingClient(
     this IServiceCollection services,
     Assembly fromAssembly,

src/ModEndpoints.RemoteServices/IServiceChannel.cs

@@ -4,8 +4,25 @@
 using ModResults;
 
 namespace ModEndpoints.RemoteServices;
+
+/// <summary>
+/// ServiceEndpoint channel for sending requests to remote services via configured clients.
+/// </summary>
 public interface IServiceChannel
 {
+  /// <summary>
+  /// Sends request to remote service endpoint.
+  /// </summary>
+  /// <typeparam name="TRequest">Type of ServiceEndpoint request that will be sent.</typeparam>
+  /// <typeparam name="TResponse">ServiceEndpoint response type.</typeparam>
+  /// <param name="req">Request to be sent.</param>
+  /// <param name="ct">The <see cref="CancellationToken"/> to cancel operation.</param>
+  /// <param name="endpointUriPrefix">Path to append as prefix to resolved enpoint uri. Usually used to add path segments to configured client's base address.</param>
+  /// <param name="mediaType">The media type to use for the content.</param>
+  /// <param name="jsonSerializerOptions">Options to control the behavior during serialization.</param>
+  /// <param name="configureRequestHeaders">Delegate to configure HTTP request headers.</param>
+  /// <param name="uriResolverName"><see cref="IServiceEndpointUriResolver"/> name to be used to resolve ServiceEnpoint Uri.</param>
+  /// <returns>Response of remote service endpoint or failure result.</returns>
   Task<Result<TResponse>> SendAsync<TRequest, TResponse>(
     TRequest req,
     CancellationToken ct,
@@ -16,6 +33,19 @@ Task<Result<TResponse>> SendAsync<TRequest, TResponse>(
     string? uriResolverName = null)
     where TRequest : IServiceRequest<TResponse>
     where TResponse : notnull;
+
+  /// <summary>
+  /// Sends request to remote service endpoint.
+  /// </summary>
+  /// <typeparam name="TRequest">Type of ServiceEndpoint request that will be sent.</typeparam>
+  /// <param name="req">Request to be sent.</param>
+  /// <param name="ct">The <see cref="CancellationToken"/> to cancel operation.</param>
+  /// <param name="endpointUriPrefix">Path to append as prefix to resolved enpoint uri. Usually used to add path segments to configured client's base address.</param>
+  /// <param name="mediaType">The media type to use for the content.</param>
+  /// <param name="jsonSerializerOptions">Options to control the behavior during serialization.</param>
+  /// <param name="configureRequestHeaders">Delegate to configure HTTP request headers.</param>
+  /// <param name="uriResolverName"><see cref="IServiceEndpointUriResolver"/> name to be used to resolve ServiceEnpoint Uri.</param>
+  /// <returns>Response of remote service endpoint or failure result.</returns>
   Task<Result> SendAsync<TRequest>(
     TRequest req,
     CancellationToken ct,