feature: this commit introduces the web host environment parameter to UseSpecification to customize the OAuth2 configuration according to the environment (production or development). It improves visual options in the documentation (title, hide templates, expand tags) and updates the call in Program.cs to pass the environment.

Author: https-richardy

Boundaries/Comanda.Orchestrator/Source/Comanda.Orchestrator.WebApi/Extensions/SpecificationExtension.cs

@@ -3,16 +3,39 @@ namespace Comanda.Orchestrator.WebApi.Extensions;
 [ExcludeFromCodeCoverage(Justification = "contains only dependency injection registration with no business logic.")]
 public static class SpecificationsExtension
 {
-    public static void UseSpecification(this IEndpointRouteBuilder app)
+    public static void UseSpecification(this IEndpointRouteBuilder app, IWebHostEnvironment environment)
     {
         app.MapScalarApiReference(options =>
         {
             options.DarkMode = false;
             options.HideDarkModeToggle = true;
             options.HideClientButton = true;
+            options.HideModels = true;
+            options.Servers = [];
 
-            options.WithTitle("Comanda Orchestrator");
-            options.WithClassicLayout();
+            options.WithTitle("Comanda Orchestrator | Reference");
+            options.ExpandAllTags();
+
+            if (environment.IsProduction())
+            {
+                options.AddPreferredSecuritySchemes(SecuritySchemes.OAuth2);
+                options.AddClientCredentialsFlow(SecuritySchemes.OAuth2, flow =>
+                {
+                    flow.WithCredentialsLocation(CredentialsLocation.Body);
+                });
+
+                return;
+            }
+
+            var settings = app.ServiceProvider.GetService<ISettings>()!;
+
+            options.AddPreferredSecuritySchemes(SecuritySchemes.OAuth2);
+            options.AddClientCredentialsFlow(SecuritySchemes.OAuth2, flow =>
+            {
+                flow.ClientId = settings.Federation.ClientId;
+                flow.ClientSecret = settings.Federation.ClientSecret;
+                flow.WithCredentialsLocation(CredentialsLocation.Body);
+            });
         });
     }
 }

Boundaries/Comanda.Orchestrator/Source/Comanda.Orchestrator.WebApi/Program.cs

@@ -5,6 +5,8 @@ public partial class Program
     private static async Task Main(string[] args)
     {
         var builder = WebApplication.CreateBuilder(args);
+
+        var environment = builder.Environment;
         var configuration = builder.Configuration;
 
         builder.Services.AddInfrastructure(configuration);
@@ -20,7 +22,7 @@ private static async Task Main(string[] args)
         app.MapOpenApi();
 
         app.UseHttpPipeline();
-        app.UseSpecification();
+        app.UseSpecification(environment);
 
         await app.RunAsync();
     }