feat(HttpApi): Added a new security scheme and requirement to Swagger, allowing users to authenticate in the UI using static tokens

Signed-off-by: Charles d'Avernas <[email protected]>

Author: cdavernas

src/api/Synapse.Api.Http/Extensions/IServiceCollectionExtensions.cs

@@ -66,6 +66,29 @@ public static IServiceCollection AddSynapseHttpApi(this IServiceCollection servi
                 var action = (ControllerActionDescriptor)o.ActionDescriptor;
                 return $"{action.ActionName}".ToCamelCase();
             });
+            builder.AddSecurityDefinition("Static Token", new OpenApiSecurityScheme
+            {
+                Description = "Static token authorization using the Bearer scheme",
+                Name = "Authorization",
+                In = ParameterLocation.Header,
+                Type = SecuritySchemeType.Http,
+                Scheme = "bearer",
+                BearerFormat = "Static Token"
+            });
+            builder.AddSecurityRequirement(new()
+            {
+                {
+                    new()
+                    {
+                        Reference = new()
+                        {
+                            Id = "Static Token",
+                            Type = ReferenceType.SecurityScheme
+                        }
+                    },
+                    Array.Empty<string>()
+                }
+            });
             builder.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());
             builder.SwaggerDoc("v1", new OpenApiInfo
             {