diff --git a/src/Microsoft.Identity.Abstractions/DownstreamApi/IDownstreamApi.HttpMethods.cs b/src/Microsoft.Identity.Abstractions/DownstreamApi/IDownstreamApi.HttpMethods.cs index 84184c7..bb24abb 100644 --- a/src/Microsoft.Identity.Abstractions/DownstreamApi/IDownstreamApi.HttpMethods.cs +++ b/src/Microsoft.Identity.Abstractions/DownstreamApi/IDownstreamApi.HttpMethods.cs @@ -21,6 +21,7 @@ namespace Microsoft.Identity.Abstractions /// public partial interface IDownstreamApi { + /// /// Calls, using , a downstream API returning data. /// By default the returned data is deserialized from JSON but you can provide your own deserializer in the action @@ -56,6 +57,7 @@ public partial interface IDownstreamApi Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -95,6 +97,7 @@ public partial interface IDownstreamApi Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API returning data. /// By default the returned data is deserialized from JSON but you can provide your own deserializer in the action @@ -126,6 +129,7 @@ public partial interface IDownstreamApi string? serviceName, Action? downstreamApiOptionsOverride = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -161,6 +165,7 @@ public partial interface IDownstreamApi TInput input, Action? downstreamApiOptionsOverride = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API with some input data . /// By default the input data is serialized in JSON but you can provide your own serializer in the action @@ -199,6 +204,7 @@ public Task PostForUserAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default); + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -238,6 +244,7 @@ public Task PostForUserAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API with some input data . /// By default the input data is serialized in JSON but you can provide your own serializer in the action @@ -272,6 +279,7 @@ public Task PostForAppAsync( TInput input, Action? downstreamApiOptionsOverride = null, CancellationToken cancellationToken = default); + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -307,6 +315,7 @@ public Task PostForAppAsync( TInput input, Action? downstreamApiOptionsOverride = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API with some input data . /// By default the input data is serialized in JSON but you can provide your own serializer in the action @@ -345,6 +354,7 @@ public Task PutForUserAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default); + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -384,6 +394,7 @@ public Task PutForUserAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API with some input data . /// By default the input data is serialized in JSON but you can provide your own serializer in the action @@ -418,6 +429,7 @@ public Task PutForAppAsync( TInput input, Action? downstreamApiOptionsOverride = null, CancellationToken cancellationToken = default); + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -455,6 +467,7 @@ public Task PutForAppAsync( CancellationToken cancellationToken = default)where TOutput : class; #if NETSTANDARD2_1_OR_GREATER + /// /// Calls, using , a downstream API with some input data . /// By default the input data is serialized in JSON but you can provide your own serializer in the action @@ -493,6 +506,7 @@ public Task PatchForUserAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default); + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -532,6 +546,7 @@ public Task PatchForUserAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API with some input data . /// By default the input data is serialized in JSON but you can provide your own serializer in the action @@ -566,6 +581,7 @@ public Task PatchForAppAsync( TInput input, Action? downstreamApiOptionsOverride = null, CancellationToken cancellationToken = default); + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -603,6 +619,7 @@ public Task PatchForAppAsync( CancellationToken cancellationToken = default)where TOutput : class; #endif // NETSTANDARD2_1_OR_GREATER + /// /// Calls, using , a downstream API with some input data . /// By default the input data is serialized in JSON but you can provide your own serializer in the action @@ -641,6 +658,7 @@ public Task DeleteForUserAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default); + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -680,6 +698,7 @@ public Task DeleteForUserAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API with some input data . /// By default the input data is serialized in JSON but you can provide your own serializer in the action @@ -714,6 +733,7 @@ public Task DeleteForAppAsync( TInput input, Action? downstreamApiOptionsOverride = null, CancellationToken cancellationToken = default); + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -751,6 +771,7 @@ public Task DeleteForAppAsync( CancellationToken cancellationToken = default)where TOutput : class; #if NET8_0_OR_GREATER + /// /// Calls, using , a downstream API returning data. /// By default the returned data is deserialized from JSON but you can provide your own deserializer in the action @@ -785,6 +806,7 @@ public Task DeleteForAppAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -825,6 +847,7 @@ public Task DeleteForAppAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API returning data. /// By default the returned data is deserialized from JSON but you can provide your own deserializer in the action @@ -855,6 +878,7 @@ public Task DeleteForAppAsync( JsonTypeInfo outputJsonTypeInfo, Action? downstreamApiOptionsOverride = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -891,6 +915,7 @@ public Task DeleteForAppAsync( JsonTypeInfo outputJsonTypeInfo, Action? downstreamApiOptionsOverride = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API with some input data . /// By default the input data is serialized in JSON but you can provide your own serializer in the action @@ -928,6 +953,7 @@ public Task PostForUserAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default); + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -968,6 +994,7 @@ public Task PostForUserAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API with some input data . /// By default the input data is serialized in JSON but you can provide your own serializer in the action @@ -1001,6 +1028,7 @@ public Task PostForAppAsync( JsonTypeInfo inputJsonTypeInfo, Action? downstreamApiOptionsOverride = null, CancellationToken cancellationToken = default); + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -1037,6 +1065,7 @@ public Task PostForAppAsync( JsonTypeInfo outputJsonTypeInfo, Action? downstreamApiOptionsOverride = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API with some input data . /// By default the input data is serialized in JSON but you can provide your own serializer in the action @@ -1074,6 +1103,7 @@ public Task PutForUserAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default); + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -1114,6 +1144,7 @@ public Task PutForUserAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API with some input data . /// By default the input data is serialized in JSON but you can provide your own serializer in the action @@ -1147,6 +1178,7 @@ public Task PutForAppAsync( JsonTypeInfo inputJsonTypeInfo, Action? downstreamApiOptionsOverride = null, CancellationToken cancellationToken = default); + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -1185,6 +1217,7 @@ public Task PutForAppAsync( CancellationToken cancellationToken = default)where TOutput : class; #if NETSTANDARD2_1_OR_GREATER + /// /// Calls, using , a downstream API with some input data . /// By default the input data is serialized in JSON but you can provide your own serializer in the action @@ -1222,6 +1255,7 @@ public Task PatchForUserAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default); + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -1262,6 +1296,7 @@ public Task PatchForUserAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API with some input data . /// By default the input data is serialized in JSON but you can provide your own serializer in the action @@ -1295,6 +1330,7 @@ public Task PatchForAppAsync( JsonTypeInfo inputJsonTypeInfo, Action? downstreamApiOptionsOverride = null, CancellationToken cancellationToken = default); + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -1333,6 +1369,7 @@ public Task PatchForAppAsync( CancellationToken cancellationToken = default)where TOutput : class; #endif // NETSTANDARD2_1_OR_GREATER + /// /// Calls, using , a downstream API with some input data . /// By default the input data is serialized in JSON but you can provide your own serializer in the action @@ -1370,6 +1407,7 @@ public Task DeleteForUserAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default); + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action @@ -1410,6 +1448,7 @@ public Task DeleteForUserAsync( Action? downstreamApiOptionsOverride = null, ClaimsPrincipal? user = null, CancellationToken cancellationToken = default)where TOutput : class; + /// /// Calls, using , a downstream API with some input data . /// By default the input data is serialized in JSON but you can provide your own serializer in the action @@ -1443,6 +1482,7 @@ public Task DeleteForAppAsync( JsonTypeInfo inputJsonTypeInfo, Action? downstreamApiOptionsOverride = null, CancellationToken cancellationToken = default); + /// /// Calls, using , a downstream API with some input data and returning data. /// By default the input data is serialized in JSON and the returned data is deserialized from JSON but you can provide your own serializer and your own deserializer in the action diff --git a/src/Microsoft.Identity.Abstractions/DownstreamApi/IDownstreamApi.HttpMethods.tt b/src/Microsoft.Identity.Abstractions/DownstreamApi/IDownstreamApi.HttpMethods.tt index 8879b1c..2fe841d 100644 --- a/src/Microsoft.Identity.Abstractions/DownstreamApi/IDownstreamApi.HttpMethods.tt +++ b/src/Microsoft.Identity.Abstractions/DownstreamApi/IDownstreamApi.HttpMethods.tt @@ -67,6 +67,7 @@ namespace Microsoft.Identity.Abstractions string user = !hasApp ? "user" : "null"; string sampleCodeTemplate = template.Replace("TOutput", "IEnumerable").Replace("TInput", "MyItem").Replace("<", "<").Replace(">", ">"); #> + /// /// Calls, using , a downstream API <#= hasInput ? "with some input data " : ""#><#= hasInput&&hasOutput ? "and " : ""#><#= hasOutput ? "returning data" : ""#>. /// By default <#= hasInput ? "the input data is serialized in JSON " : ""#><#= hasInput&&hasOutput ? "and " : ""#><#= hasOutput ? "the returned data is deserialized from JSON" : ""#> but you can provide <#= hasInput ? "your own serializer " : ""#><#= hasInput&&hasOutput ? "and " : ""#><#= hasOutput ? "your own deserializer " : ""#>in the action