Merge branch 'sidecar' into kecaruso/python-adapter

keegan-caruso · web-flow · commit 4c7ff9c84b40 · 2025-10-01T14:18:14.000-07:00
diff --git a/src/Microsoft.Identity.Web.Sidecar/Endpoints/AuthorizationHeaderEndpoint.cs b/src/Microsoft.Identity.Web.Sidecar/Endpoints/AuthorizationHeaderEndpoint.cs
@@ -1,6 +1,7 @@
 ﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+using System.ComponentModel;
 using System.Net.Mime;
 using Microsoft.AspNetCore.Http.HttpResults;
 using Microsoft.AspNetCore.Mvc;
@@ -64,9 +65,11 @@ private static OpenApiOperation ConfigureOpenAPI(OpenApiOperation operation)
 
     private static async Task<Results<Ok<AuthorizationHeaderResult>, ProblemHttpResult>> AuthorizationHeaderAsync(
         HttpContext httpContext,
-        [FromRoute] string apiName,
+        [Description("The downstream API to acquire an authorization header for.")]
+        [FromRoute]
+        string apiName,
         [AsParameters] AuthorizationHeaderRequest requestParameters,
-        BindableDownstreamApiOptions? optionsOverride,
+        BindableDownstreamApiOptions optionsOverride,
         [FromServices] IAuthorizationHeaderProvider headerProvider,
         [FromServices] IOptionsMonitor<DownstreamApiOptions> optionsMonitor,
         [FromServices] ILogger<Program> logger,
@@ -81,7 +84,7 @@ private static async Task<Results<Ok<AuthorizationHeaderResult>, ProblemHttpResu
                 statusCode: StatusCodes.Status400BadRequest);
         }
 
-        if (optionsOverride is not null)
+        if (optionsOverride.HasAny)
         {
             options = DownstreamApiOptionsMerger.MergeOptions(options, optionsOverride);
         }
diff --git a/src/Microsoft.Identity.Web.Sidecar/Endpoints/DownstreamApiEndpoint.cs b/src/Microsoft.Identity.Web.Sidecar/Endpoints/DownstreamApiEndpoint.cs
@@ -1,6 +1,7 @@
 ﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+using System.ComponentModel;
 using System.Net.Http.Headers;
 using System.Net.Mime;
 using System.Text;
@@ -63,9 +64,11 @@ private static OpenApiOperation ConfigureOpenAPI(OpenApiOperation operation)
 
     private static async Task<Results<Ok<DownstreamApiResult>, ProblemHttpResult>> DownstreamApiAsync(
         HttpContext httpContext,
-        [FromRoute] string apiName,
+        [Description("The downstream API to call")]
+        [FromRoute]
+        string apiName,
         [AsParameters] DownstreamApiRequest requestParameters,
-        BindableDownstreamApiOptions? optionsOverride,
+        BindableDownstreamApiOptions optionsOverride,
         [FromServices] IDownstreamApi downstreamApi,
         [FromServices] IOptionsMonitor<DownstreamApiOptions> optionsMonitor,
         [FromServices] ILogger<Program> logger,
@@ -80,7 +83,7 @@ private static async Task<Results<Ok<DownstreamApiResult>, ProblemHttpResult>> D
                 statusCode: StatusCodes.Status400BadRequest);
         }
 
-        if (optionsOverride is not null)
+        if (optionsOverride.HasAny)
         {
             options = DownstreamApiOptionsMerger.MergeOptions(options, optionsOverride);
         }
diff --git a/src/Microsoft.Identity.Web.Sidecar/Microsoft.Identity.Web.Sidecar.csproj b/src/Microsoft.Identity.Web.Sidecar/Microsoft.Identity.Web.Sidecar.csproj
@@ -24,9 +24,9 @@
 
   <!-- Trimming + perf (Release only) -->
   <PropertyGroup Condition="'$(Configuration)'=='Release'">
-    <PublishTrimmed>true</PublishTrimmed>
+    <PublishTrimmed>false</PublishTrimmed>
     <TrimMode>partial</TrimMode>
-    <EnableTrimAnalyzer>true</EnableTrimAnalyzer>
+    <EnableTrimAnalyzer>false</EnableTrimAnalyzer>
     <SuppressTrimAnalysisWarnings>false</SuppressTrimAnalysisWarnings>
     <PublishReadyToRun>true</PublishReadyToRun>
     <!-- Optional; enable only if you do not rely on culture-specific globalization -->
diff --git a/src/Microsoft.Identity.Web.Sidecar/Models/AuthorizationHeaderRequest.cs b/src/Microsoft.Identity.Web.Sidecar/Models/AuthorizationHeaderRequest.cs
@@ -1,6 +1,7 @@
 ﻿// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
 
+using System.ComponentModel;
 using System.Diagnostics.CodeAnalysis;
 using System.Text.Json;
 using System.Text.Json.Serialization;
@@ -15,8 +16,10 @@ namespace Microsoft.Identity.Web.Sidecar.Models;
 public readonly struct AuthorizationHeaderRequest
 {
     [FromQuery]
+    [Description("The identity of the agent.")]
     public string? AgentIdentity { get; init; }
 
     [FromQuery]
+    [Description("The username of the agent.")]
     public string? AgentUsername { get; init; }
 }
diff --git a/src/Microsoft.Identity.Web.Sidecar/Models/BindableDownstreamApiOptions.cs b/src/Microsoft.Identity.Web.Sidecar/Models/BindableDownstreamApiOptions.cs
@@ -15,6 +15,12 @@ namespace Microsoft.Identity.Web.Sidecar.Models;
 /// </summary>
 public class BindableDownstreamApiOptions : DownstreamApiOptions, IEndpointParameterMetadataProvider
 {
+    /// <summary>
+    /// The object needs to be non-nullable for the OpenAPI spec generation.
+    /// This provides a way to know if any override was actually provided.
+    /// </summary>
+    public bool HasAny { get; private set; }
+
     public BindableDownstreamApiOptions()
     {
     }
@@ -25,14 +31,16 @@ public BindableDownstreamApiOptions()
         bool hasAny = ctx.Request.Query.Keys.Any(k =>
             k.StartsWith(paramName + ".", StringComparison.OrdinalIgnoreCase));
 
+        var result = new BindableDownstreamApiOptions();
+
         if (!hasAny)
         {
-            // No override supplied
-            return ValueTask.FromResult<BindableDownstreamApiOptions?>(null);
+            return ValueTask.FromResult<BindableDownstreamApiOptions?>(result);
         }
 
+        result.HasAny = true;
+
         var query = ctx.Request.Query;
-        var result = new BindableDownstreamApiOptions();
 
         foreach (var key in query.Keys)
         {
@@ -75,7 +83,7 @@ public BindableDownstreamApiOptions()
                     case "claims":
                         result.AcquireTokenOptions.Claims = last;
                         break;
-                    case "CorrelationId" when Guid.TryParse(last, out var corrId):
+                    case "correlationid" when Guid.TryParse(last, out var corrId):
                         result.AcquireTokenOptions.CorrelationId = corrId;
                         break;
                     case "fmipath":
@@ -118,7 +126,7 @@ public BindableDownstreamApiOptions()
         return ValueTask.FromResult<BindableDownstreamApiOptions?>(result);
     }
 
-    // Let ApiExplorer/OpenAPI know this should be treated as coming from query
+    /// <inheritdoc/>
     public static void PopulateMetadata(ParameterInfo parameter, EndpointBuilder builder)
     {
         builder.Metadata.Add(new FromQueryAttribute());
diff --git a/src/Microsoft.Identity.Web.Sidecar/OpenAPI/Microsoft.Identity.Web.Sidecar.json b/src/Microsoft.Identity.Web.Sidecar/OpenAPI/Microsoft.Identity.Web.Sidecar.json
@@ -57,6 +57,7 @@
           {
             "name": "apiName",
             "in": "path",
+            "description": "The downstream API to acquire an authorization header for.",
             "required": true,
             "schema": {
               "type": "string"
@@ -65,13 +66,15 @@
           {
             "name": "AgentIdentity",
             "in": "query",
+            "description": "The identity of the agent.",
             "schema": {
               "type": "string"
             }
           },
           {
             "name": "AgentUsername",
             "in": "query",
+            "description": "The username of the agent.",
             "schema": {
               "type": "string"
             }
@@ -244,6 +247,7 @@
           {
             "name": "apiName",
             "in": "path",
+            "description": "The downstream API to acquire an authorization header for.",
             "required": true,
             "schema": {
               "type": "string"
@@ -252,13 +256,15 @@
           {
             "name": "AgentIdentity",
             "in": "query",
+            "description": "The identity of the agent.",
             "schema": {
               "type": "string"
             }
           },
           {
             "name": "AgentUsername",
             "in": "query",
+            "description": "The username of the agent.",
             "schema": {
               "type": "string"
             }
@@ -431,6 +437,7 @@
           {
             "name": "apiName",
             "in": "path",
+            "description": "The downstream API to call",
             "required": true,
             "schema": {
               "type": "string"
@@ -618,6 +625,7 @@
           {
             "name": "apiName",
             "in": "path",
+            "description": "The downstream API to call",
             "required": true,
             "schema": {
               "type": "string"

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,12 @@ namespace Microsoft.Identity.Web.Sidecar.Models;`
`15`	`15`	`/// </summary>`
`16`	`16`	`public class BindableDownstreamApiOptions : DownstreamApiOptions, IEndpointParameterMetadataProvider`
`17`	`17`	`{`
	`18`	`+ /// <summary>`
	`19`	`+ /// The object needs to be non-nullable for the OpenAPI spec generation.`
	`20`	`+ /// This provides a way to know if any override was actually provided.`
	`21`	`+ /// </summary>`
	`22`	`+ public bool HasAny { get; private set; }`
	`23`	`+`
`18`	`24`	`public BindableDownstreamApiOptions()`
`19`	`25`	`{`
`20`	`26`	`}`
`@@ -25,14 +31,16 @@ public BindableDownstreamApiOptions()`
`25`	`31`	`bool hasAny = ctx.Request.Query.Keys.Any(k =>`
`26`	`32`	`k.StartsWith(paramName + ".", StringComparison.OrdinalIgnoreCase));`
`27`	`33`
	`34`	`+ var result = new BindableDownstreamApiOptions();`
	`35`	`+`
`28`	`36`	`if (!hasAny)`
`29`	`37`	`{`
`30`		`- // No override supplied`
`31`		`- return ValueTask.FromResult<BindableDownstreamApiOptions?>(null);`
	`38`	`+ return ValueTask.FromResult<BindableDownstreamApiOptions?>(result);`
`32`	`39`	`}`
`33`	`40`
	`41`	`+ result.HasAny = true;`
	`42`	`+`
`34`	`43`	`var query = ctx.Request.Query;`
`35`		`- var result = new BindableDownstreamApiOptions();`
`36`	`44`
`37`	`45`	`foreach (var key in query.Keys)`
`38`	`46`	`{`
`@@ -75,7 +83,7 @@ public BindableDownstreamApiOptions()`
`75`	`83`	`case "claims":`
`76`	`84`	`result.AcquireTokenOptions.Claims = last;`
`77`	`85`	`break;`
`78`		`- case "CorrelationId" when Guid.TryParse(last, out var corrId):`
	`86`	`+ case "correlationid" when Guid.TryParse(last, out var corrId):`
`79`	`87`	`result.AcquireTokenOptions.CorrelationId = corrId;`
`80`	`88`	`break;`
`81`	`89`	`case "fmipath":`
`@@ -118,7 +126,7 @@ public BindableDownstreamApiOptions()`
`118`	`126`	`return ValueTask.FromResult<BindableDownstreamApiOptions?>(result);`
`119`	`127`	`}`
`120`	`128`
`121`		`- // Let ApiExplorer/OpenAPI know this should be treated as coming from query`
	`129`	`+ /// <inheritdoc/>`
`122`	`130`	`public static void PopulateMetadata(ParameterInfo parameter, EndpointBuilder builder)`
`123`	`131`	`{`
`124`	`132`	`builder.Metadata.Add(new FromQueryAttribute());`
Original file line number	Diff line number	Diff line change
`@@ -57,6 +57,7 @@`
`57`	`57`	`{`
`58`	`58`	`"name": "apiName",`
`59`	`59`	`"in": "path",`
	`60`	`+ "description": "The downstream API to acquire an authorization header for.",`
`60`	`61`	`"required": true,`
`61`	`62`	`"schema": {`
`62`	`63`	`"type": "string"`
`@@ -65,13 +66,15 @@`
`65`	`66`	`{`
`66`	`67`	`"name": "AgentIdentity",`
`67`	`68`	`"in": "query",`
	`69`	`+ "description": "The identity of the agent.",`
`68`	`70`	`"schema": {`
`69`	`71`	`"type": "string"`
`70`	`72`	`}`
`71`	`73`	`},`
`72`	`74`	`{`
`73`	`75`	`"name": "AgentUsername",`
`74`	`76`	`"in": "query",`
	`77`	`+ "description": "The username of the agent.",`
`75`	`78`	`"schema": {`
`76`	`79`	`"type": "string"`
`77`	`80`	`}`
`@@ -244,6 +247,7 @@`
`244`	`247`	`{`
`245`	`248`	`"name": "apiName",`
`246`	`249`	`"in": "path",`
	`250`	`+ "description": "The downstream API to acquire an authorization header for.",`
`247`	`251`	`"required": true,`
`248`	`252`	`"schema": {`
`249`	`253`	`"type": "string"`
`@@ -252,13 +256,15 @@`
`252`	`256`	`{`
`253`	`257`	`"name": "AgentIdentity",`
`254`	`258`	`"in": "query",`
	`259`	`+ "description": "The identity of the agent.",`
`255`	`260`	`"schema": {`
`256`	`261`	`"type": "string"`
`257`	`262`	`}`
`258`	`263`	`},`
`259`	`264`	`{`
`260`	`265`	`"name": "AgentUsername",`
`261`	`266`	`"in": "query",`
	`267`	`+ "description": "The username of the agent.",`
`262`	`268`	`"schema": {`
`263`	`269`	`"type": "string"`
`264`	`270`	`}`
`@@ -431,6 +437,7 @@`
`431`	`437`	`{`
`432`	`438`	`"name": "apiName",`
`433`	`439`	`"in": "path",`
	`440`	`+ "description": "The downstream API to call",`
`434`	`441`	`"required": true,`
`435`	`442`	`"schema": {`
`436`	`443`	`"type": "string"`
`@@ -618,6 +625,7 @@`
`618`	`625`	`{`
`619`	`626`	`"name": "apiName",`
`620`	`627`	`"in": "path",`
	`628`	`+ "description": "The downstream API to call",`
`621`	`629`	`"required": true,`
`622`	`630`	`"schema": {`
`623`	`631`	`"type": "string"`