[PM-6170] Explore making responses required and nullable

src/Api/SecretsManager/Models/Response/BaseSecretResponseModel.cs

@@ -1,4 +1,6 @@
-using Bit.Core.Models.Api;
+#nullable enable
+
+using Bit.Core.Models.Api;
 using Bit.Core.SecretsManager.Entities;
 
 namespace Bit.Api.SecretsManager.Models.Response;
@@ -24,39 +26,31 @@
         Projects = secret.Projects?.Select(p => new SecretResponseInnerProject(p));
     }
 
-    public BaseSecretResponseModel(string objectName = _objectName) : base(objectName)
-    {
-    }
-
-    public BaseSecretResponseModel() : base(_objectName)
-    {
-    }
-
-    public Guid Id { get; set; }
+    public Guid Id { get; }
 
-    public Guid OrganizationId { get; set; }
+    public Guid OrganizationId { get; }
 
-    public string Key { get; set; }
+    public string? Key { get; }
 
-    public string Value { get; set; }
+    public string? Value { get; }
 
-    public string Note { get; set; }
+    public string? Note { get; }
 
-    public DateTime CreationDate { get; set; }
+    public DateTime CreationDate { get; }
 
-    public DateTime RevisionDate { get; set; }
+    public DateTime RevisionDate { get; }
 
-    public IEnumerable<SecretResponseInnerProject> Projects { get; set; }
+    public IEnumerable<SecretResponseInnerProject>? Projects { get; init; }
 
     public class SecretResponseInnerProject
     {
         public SecretResponseInnerProject(Project project)
         {
             Id = project.Id;
             Name = project.Name;
         }
 
         public SecretResponseInnerProject()
         {
         }
 

src/Api/SecretsManager/Models/Response/SecretResponseModel.cs

@@ -12,10 +12,6 @@ public SecretResponseModel(Secret secret, bool read, bool write) : base(secret,
         Write = write;
     }
 
-    public SecretResponseModel() : base(_objectName)
-    {
-    }
-
     public bool Read { get; set; }
 
     public bool Write { get; set; }

src/Api/Utilities/ServiceCollectionExtensions.cs

@@ -71,6 +71,7 @@ public static void AddSwagger(this IServiceCollection services, GlobalSettings g
             // config.UseReferencedDefinitionsForEnums();
 
             config.SchemaFilter<EnumSchemaFilter>();
+            config.SchemaFilter<RequireNotNullableSchemaFilter>();
 
             var apiFilePath = Path.Combine(AppContext.BaseDirectory, "Api.xml");
             config.IncludeXmlComments(apiFilePath, true);

src/SharedWeb/Swagger/RequireNotNullableSchemaFilter.cs

@@ -0,0 +1,66 @@
+using System.Reflection;
+using Microsoft.OpenApi.Models;
+using Swashbuckle.AspNetCore.SwaggerGen;
+
+namespace Bit.SharedWeb.Swagger;
+
+/// <summary>
+///
+/// </summary>
+/// <remarks>
+/// Credits: https://github.com/domaindrivendev/Swashbuckle.AspNetCore/issues/2036#issuecomment-894015122
+/// </remarks>
+public class RequireNotNullableSchemaFilter : ISchemaFilter
+{
+    public void Apply(OpenApiSchema schema, SchemaFilterContext context)
+    {
+        if (schema.Properties == null)
+        {
+            return;
+        }
+
+        FixNullableProperties(schema, context);
+
+        var notNullableProperties = schema
+            .Properties
+            .Where(x => !x.Value.Nullable && x.Value.Default == default && !schema.Required.Contains(x.Key))
+            .ToList();
+
+        foreach (var property in notNullableProperties)
+        {
+            schema.Required.Add(property.Key);
+        }
+    }
+
+    /// <summary>
+    /// Option "SupportNonNullableReferenceTypes" not working with complex types ({ "type": "object" }),
+    /// so they always have "Nullable = false",
+    /// see method "SchemaGenerator.GenerateSchemaForMember"
+    /// </summary>
+    private static void FixNullableProperties(OpenApiSchema schema, SchemaFilterContext context)
+    {
+        foreach (var property in schema.Properties)
+        {
+            var field = context.Type
+                .GetMembers(BindingFlags.Public | BindingFlags.Instance)
+                .FirstOrDefault(x =>
+                    string.Equals(x.Name, property.Key, StringComparison.InvariantCultureIgnoreCase));
+
+            if (field == null)
+            {
+                continue;
+            }
+
+            var fieldType = field switch
+            {
+                FieldInfo fieldInfo => fieldInfo.FieldType,
+                PropertyInfo propertyInfo => propertyInfo.PropertyType,
+                _ => throw new NotSupportedException(),
+            };
+
+            property.Value.Nullable = fieldType.IsValueType
+                ? Nullable.GetUnderlyingType(fieldType) != null
+                : !field.IsNonNullableReferenceType();
+        }
+    }
+}