Refine public documentation

This commit is contained in:
2026-08-16 23:58:16 +10:00
parent 464b514f5c
commit f07c08df17
15 changed files with 57 additions and 67 deletions
@@ -11,10 +11,7 @@ public sealed class BinaryLaneOptions
/// <summary>The BinaryLane API root URL.</summary>
public string BaseUrl { get; set; } = "https://api.binarylane.com.au/";
/// <summary>
/// The bearer token to use when the default token provider is registered. Prefer a secret store,
/// user secrets, or environment-variable based configuration rather than committing this value.
/// </summary>
/// <summary>The bearer token used by the default token provider.</summary>
public string? ApiToken { get; set; }
/// <summary>Timeout applied to individual HTTP requests.</summary>
@@ -13,8 +13,8 @@ namespace BinaryLane.Api.V2.DependencyInjection;
public static class ServiceCollectionExtensions
{
/// <summary>
/// Registers a typed BinaryLane client. The returned builder lets an application compose its
/// own proxy, telemetry, and safe GET-only resilience handlers.
/// Registers a typed BinaryLane client. The returned builder supports application-specific
/// HTTP client configuration.
/// </summary>
public static IHttpClientBuilder AddBinaryLaneApi(
this IServiceCollection services,
@@ -32,10 +32,7 @@ public class BinaryLaneApiException : Exception
/// <summary>Structured problem details, when BinaryLane supplied them.</summary>
public BinaryLaneApiProblem? Problem { get; }
/// <summary>
/// Bounded raw response text for diagnostics. It omits request headers, but can contain
/// provider-supplied or user-provided data; avoid logging it indiscriminately.
/// </summary>
/// <summary>Bounded raw response text for diagnostics.</summary>
public string? ResponseBody { get; }
/// <summary>Response and content headers.</summary>