Add support for writing the JSON file response indented

C0nquistadore · C0nquistadore · commit ad17ffb96ba6 · 2025-09-09T13:39:01.000+02:00
diff --git a/shared/Http/HttpFileResponseDefinition.cs b/shared/Http/HttpFileResponseDefinition.cs
@@ -4,11 +4,13 @@ public sealed class HttpFileResponseDefinition
     {
         public bool Cache { get; }
         public ContentDispositionType DispositionType { get; }
+        public bool IndentJson { get; }
 
-        public HttpFileResponseDefinition(bool cache, ContentDispositionType dispositionType)
+        public HttpFileResponseDefinition(bool cache, ContentDispositionType dispositionType, bool indentJson)
         {
             Cache = cache;
             DispositionType = dispositionType;
+            IndentJson = indentJson;
         }
     }
 }
diff --git a/src/Dibix.Http.Host/Runtime/HttpResponseFormatter.cs b/src/Dibix.Http.Host/Runtime/HttpResponseFormatter.cs
@@ -1,5 +1,6 @@
 ﻿using System;
 using System.IO;
+using System.Text.Json;
 using System.Threading;
 using System.Threading.Tasks;
 using Dibix.Http.Server;
@@ -26,7 +27,7 @@ public HttpResponseFormatter(HttpResponse response)
             }
             else
             {
-                await WriteJsonResponse(result, cancellationToken).ConfigureAwait(false);
+                await WriteJsonResponse(result, writeIndented: false, cancellationToken).ConfigureAwait(false);
             }
 
             return null;
@@ -62,23 +63,31 @@ void AppendFileName(ResponseHeaders responseHeaders, string fileName)
 
                 case IJsonFileMetadata jsonFileMetadata:
                     AppendFileName(responseHeaders, jsonFileMetadata.FileName);
-                    await WriteJsonResponse(result, cancellationToken).ConfigureAwait(false);
+                    await WriteJsonResponse(result, fileResponse.IndentJson, cancellationToken).ConfigureAwait(false);
                     break;
 
                 default:
                     throw new InvalidOperationException($"Unexpected file result type: {result.GetType()}");
             }
         }
 
-        private async Task WriteJsonResponse(object? result, CancellationToken cancellationToken)
+        private async Task WriteJsonResponse(object? result, bool writeIndented, CancellationToken cancellationToken)
         {
             if (result == null)
             {
                 _response.StatusCode = StatusCodes.Status204NoContent;
                 return;
             }
 
-            await _response.WriteAsJsonAsync(result, cancellationToken: cancellationToken).ConfigureAwait(false);
+            if (writeIndented)
+            {
+                JsonSerializerOptions jsonSerializerOptions = new JsonSerializerOptions(JsonSerializerDefaults.Web) { WriteIndented = true };
+                await _response.WriteAsJsonAsync(result, jsonSerializerOptions, cancellationToken: cancellationToken).ConfigureAwait(false);
+            }
+            else
+            {
+                await _response.WriteAsJsonAsync(result, cancellationToken: cancellationToken).ConfigureAwait(false);
+            }
         }
     }
 }
diff --git a/src/Dibix.Sdk.CodeGeneration/Lookup/SqlStatementDefinitionActionTargetDefinitionResolver.cs b/src/Dibix.Sdk.CodeGeneration/Lookup/SqlStatementDefinitionActionTargetDefinitionResolver.cs
@@ -110,7 +110,7 @@ private bool TryGetStatementDefinitionByProbing(string targetName, out SqlStatem
         private static void CollectResponse(ActionDefinition actionDefinition, SqlStatementDefinition definition)
         {
             if (definition.FileResult != null)
-                actionDefinition.SetFileResponse(new ActionFileResponse(HttpMediaType.Binary, cache: false, dispositionType: ContentDispositionType.Attachment), definition.FileResult.Location);
+                actionDefinition.SetFileResponse(new ActionFileResponse(HttpMediaType.Binary, cache: false, dispositionType: ContentDispositionType.Attachment, indentJson: null), definition.FileResult.Location);
             else
                 actionDefinition.DefaultResponseType = definition.ResultType;
         }
diff --git a/src/Dibix.Sdk.CodeGeneration/Model/ActionFileResponse.cs b/src/Dibix.Sdk.CodeGeneration/Model/ActionFileResponse.cs
@@ -7,12 +7,14 @@ public sealed class ActionFileResponse
         public string MediaType { get; }
         public bool Cache { get; }
         public ContentDispositionType DispositionType { get; }
+        public SourceLocation? IndentJson { get; }
 
-        public ActionFileResponse(string mediaType, bool cache, ContentDispositionType dispositionType)
+        public ActionFileResponse(string mediaType, bool cache, ContentDispositionType dispositionType, SourceLocation? indentJson)
         {
             MediaType = mediaType;
             Cache = cache;
             DispositionType = dispositionType;
+            IndentJson = indentJson;
         }
     }
 }
diff --git a/src/Dibix.Sdk.CodeGeneration/Output/ApiDescriptionWriter.cs b/src/Dibix.Sdk.CodeGeneration/Output/ApiDescriptionWriter.cs
@@ -196,7 +196,7 @@ private void WriteActionConfiguration(CodeGenerationContext context, StringWrite
                 }
 
                 if (action.FileResponse != null)
-                    writer.WriteLine($"{variableName}.FileResponse = new HttpFileResponseDefinition(cache: {ComputeConstantLiteral(context, action.FileResponse.Cache)}, dispositionType: {ComputeConstantLiteral(context, action.FileResponse.DispositionType)});");
+                    writer.WriteLine($"{variableName}.FileResponse = new HttpFileResponseDefinition(cache: {ComputeConstantLiteral(context, action.FileResponse.Cache)}, dispositionType: {ComputeConstantLiteral(context, action.FileResponse.DispositionType)}, indentJson: false);");
 
                 foreach (int disabledAutoDetectionStatusCode in action.DisabledAutoDetectionStatusCodes)
                 {
diff --git a/src/Dibix.Sdk.CodeGeneration/Output/PackageMetadataUnit.cs b/src/Dibix.Sdk.CodeGeneration/Output/PackageMetadataUnit.cs
@@ -49,14 +49,15 @@ private static IEnumerable<HttpActionDefinitionMetadata> CollectActions(CodeGene
         {
             foreach (ActionDefinition actionDefinition in controllerDefinition.Actions)
             {
+                ActionFileResponse fileResponse = actionDefinition.FileResponse;
                 HttpActionDefinitionMetadata actionMetadata = new HttpActionDefinitionMetadata
                 (
                     actionName: actionDefinition.OperationId,
                     relativeNamespace: actionDefinition.Target.RelativeNamespace,
                     uri: new Uri(RouteBuilder.BuildRoute(model.AreaName, controllerDefinition.Name, actionDefinition.ChildRoute), UriKind.Relative),
                     method: actionDefinition.Method,
                     childRoute: actionDefinition.ChildRoute?.Value,
-                    fileResponse: actionDefinition.FileResponse != null ? new HttpFileResponseDefinition(actionDefinition.FileResponse.Cache, actionDefinition.FileResponse.DispositionType) : null,
+                    fileResponse: fileResponse != null ? new HttpFileResponseDefinition(fileResponse.Cache, fileResponse.DispositionType, indentJson: fileResponse.IndentJson != null) : null,
                     description: actionDefinition.Description,
                     modelContextProtocolType: actionDefinition.ModelContextProtocolType,
                     securitySchemes: actionDefinition.SecuritySchemes.Requirements.Select(x => x.Scheme.SchemeName).ToArray(),
diff --git a/src/Dibix.Sdk.CodeGeneration/Registration/ControllerDefinitionProvider.cs b/src/Dibix.Sdk.CodeGeneration/Registration/ControllerDefinitionProvider.cs
@@ -368,13 +368,15 @@ private static bool TryReadFileResponse(JObject action, out ActionFileResponse f
 
             JProperty mediaTypeProperty = fileResponseValue.Property("mediaType");
             JProperty cacheProperty = fileResponseValue.Property("cache");
+            JProperty indentJsonProperty = fileResponseValue.Property("indentJson");
 
             string mediaType = (string)mediaTypeProperty?.Value ?? HttpMediaType.Binary;
             bool cache = (bool?)cacheProperty?.Value ?? true;
+            SourceLocation? indentJson = (bool?)indentJsonProperty?.Value == true ? indentJsonProperty.GetSourceInfo() : null;
             if (!Enum.TryParse((string)fileResponseValue.Property("dispositionType")?.Value, true, out ContentDispositionType dispositionType))
                 dispositionType = ContentDispositionType.Inline;
 
-            fileResponse = new ActionFileResponse(mediaType, cache, dispositionType);
+            fileResponse = new ActionFileResponse(mediaType, cache, dispositionType, indentJson);
             location = fileResponseProperty.GetSourceInfo();
 
             return true;
diff --git a/src/Dibix.Sdk.CodeGeneration/Schema/dibix.endpoints.schema.json b/src/Dibix.Sdk.CodeGeneration/Schema/dibix.endpoints.schema.json
@@ -373,6 +373,9 @@
         "cache": {
           "type": "boolean"
         },
+        "indentJson": {
+          "type": "boolean"
+        },
         "dispositionType": {
           "type": "string",
           "enum": [
diff --git a/src/Dibix.Sdk.CodeGeneration/Validation/EndpointModelValidator.cs b/src/Dibix.Sdk.CodeGeneration/Validation/EndpointModelValidator.cs
@@ -29,7 +29,10 @@ public bool Validate(CodeGenerationModel model)
                                                            .ToArray();
 
             // Use non-short-circuit operator to collect all compiler errors
-            bool isValid = ValidateActions(actions) & ValidateEquivalentPaths(actions) & ValidateDuplicateMethods(actions) && ValidateAmbiguousActionNames(actions);
+            bool isValid = ValidateActions(actions)
+                         & ValidateEquivalentPaths(actions)
+                         & ValidateDuplicateMethods(actions)
+                         & ValidateAmbiguousActionNames(actions);
             return isValid;
         }
 
@@ -128,7 +131,12 @@ private bool ValidateAmbiguousActionNames(IEnumerable<ActionRegistration> action
 
         private bool ValidateAction(ActionDefinition action)
         {
-            bool isValid = ValidateReservedPathSegments(action) && ValidateParameters(action) && ValidateBodyAllowedForMethod(action) && ValidateMcpDescription(action);
+            // Use non-short-circuit operator to collect all compiler errors
+            bool isValid = ValidateReservedPathSegments(action)
+                         & ValidateParameters(action)
+                         & ValidateBodyAllowedForMethod(action)
+                         & ValidateMcpDescription(action)
+                         & ValidateIndentJson(action);
             return isValid;
         }
 
@@ -207,6 +215,28 @@ private bool ValidateMcpDescription(ActionDefinition actionDefinition)
             return false;
         }
 
+        private bool ValidateIndentJson(ActionDefinition actionDefinition)
+        {
+            SourceLocation? indentJsonLocation = actionDefinition.FileResponse?.IndentJson;
+            if (indentJsonLocation == null)
+                return true;
+
+            bool result = true;
+            if (actionDefinition.Target is ReflectionActionTarget)
+            {
+                _logger.LogError("The 'indentJson' property is not supported for actions targeting methods in external assemblies", indentJsonLocation.Value);
+                result = false;
+            }
+
+            if (actionDefinition.FileResponse.MediaType != HttpMediaType.Json)
+            {
+                _logger.LogError("The 'indentJson' property is only supported for media type 'application/json'", indentJsonLocation.Value);
+                result = false;
+            }
+
+            return result;
+        }
+
         // When using the BODY.$RAW property source, the raw body will be passed to as a stream to an SqlParameter.
         // The stream will be only accessed asynchronously if one of the async ADO.NET methods is used.
         // Otherwise, it will cause this exception in the ASP.NET core host:
diff --git a/tests/Dibix.Sdk.Tests.Database/Endpoints/GenericEndpoint.json b/tests/Dibix.Sdk.Tests.Database/Endpoints/GenericEndpoint.json
@@ -95,6 +95,7 @@
       "fileResponse": {
         "mediaType": "image/*",
         "cache": false,
+        "indentJson": false,
         "dispositionType": "attachment"
       },
       "authorization": "none"
diff --git a/tests/Dibix.Sdk.Tests.Database/Endpoints/GenericEndpointWithErrors.json b/tests/Dibix.Sdk.Tests.Database/Endpoints/GenericEndpointWithErrors.json
@@ -22,6 +22,20 @@
       "securitySchemes": "FreeToUse",
       "authorization": "none"
     },
+    {
+      "method": "GET",
+      "target": "FileResult",
+      "childRoute": "File/{id}",
+      "securitySchemes": [
+        "Anonymous",
+        "Bearer"
+      ],
+      "fileResponse": {
+        "mediaType": "image/*",
+        "indentJson": true
+      },
+      "authorization": "none"
+    },
     {
       "method": "GET",
       "target": "Dibix.Sdk.Tests.CodeGeneration.CodeGenerationTaskTests.ReflectionTarget,Dibix.Sdk.Tests",
@@ -30,11 +44,16 @@
         "source": {
           "convertFromBody": "X"
         }
+      },
+      "fileResponse": {
+        "mediaType": "application/json",
+        "indentJson": true
       }
     },
     {
       "method": "POST",
       "target": "EmptyWithParamsAndComplexUdt",
+      "operationId": "PostEmptyWithParamsAndComplexUdt",
       "body": "Request",
       "childRoute": "this/get/is/wrong",
       "params": {
@@ -77,6 +96,7 @@
     {
       "method": "POST",
       "target": "EmptyWithParams",
+      "operationId": "PostEmptyWithParams",
       "childRoute": "ambiguous/route/{b}/{c}/{password}",
       "params": {
         "a": "QUERY.a",
@@ -87,6 +107,7 @@
     {
       "method": "GET",
       "target": "EmptyWithParamsAndComplexUdt",
+      "operationId": "GetEmptyWithParamsAndComplexUdtAndAmbiguousRoute",
       "childRoute": "ambiguous/route/{a}/{c}/{password}",
       "params": {
         "b": "QUERY.b",
@@ -99,6 +120,7 @@
     {
       "method": "GET",
       "target": "EmptyWithParams",
+      "operationId": "EmptyWithParamsValidChildRoute",
       "childRoute": "this/first/route/is/ok",
       "params": {
         "a": "QUERY.a",
@@ -112,6 +134,7 @@
     {
       "method": "GET",
       "target": "EmptyWithParams",
+      "operationId": "EmptyWithParamsSecondValidChildRoute",
       "childRoute": "this/second/route/is/ok",
       "params": {
         "a": "QUERY.a",
@@ -125,6 +148,7 @@
     {
       "method": "DELETE",
       "target": "EmptyWithParams",
+      "operationId": "DeleteEmptyWithParams",
       "body": "InputContract",
       "authorization": "none"
     }
diff --git a/tests/Dibix.Sdk.Tests/CodeGeneration/CodeGenerationTaskTests.cs b/tests/Dibix.Sdk.Tests/CodeGeneration/CodeGenerationTaskTests.cs
@@ -553,6 +553,7 @@ public void Endpoint_WithValidationErrors_Error()
                   , @"Types\dbx_codeanalysis_udt_inttwo.sql"
                   , @"Tests\Syntax\dbx_tests_syntax_empty_params.sql"
                   , @"Tests\Syntax\dbx_tests_syntax_empty_params_udt.sql"
+                  , @"Tests\Syntax\dbx_tests_syntax_fileresult.sql"
                   , @"Tests\Syntax\dbx_tests_syntax_singleconcreteresult.sql"
                   , @"Tests\Syntax\dbx_tests_syntax_singleconcreteresult_missingcolumn.sql"
                 }
diff --git a/tests/Dibix.Sdk.Tests/Resources/CodeGeneration/Endpoint_WithValidationErrors_Error.txt b/tests/Dibix.Sdk.Tests/Resources/CodeGeneration/Endpoint_WithValidationErrors_Error.txt
diff --git a/tests/Dibix.Sdk.Tests/Resources/CodeGeneration/Endpoints_Accessor.cs b/tests/Dibix.Sdk.Tests/Resources/CodeGeneration/Endpoints_Accessor.cs

Original file line number	Diff line number	Diff line change
`@@ -4,11 +4,13 @@ public sealed class HttpFileResponseDefinition`
`4`	`4`	`{`
`5`	`5`	`public bool Cache { get; }`
`6`	`6`	`public ContentDispositionType DispositionType { get; }`
	`7`	`+ public bool IndentJson { get; }`
`7`	`8`
`8`		`- public HttpFileResponseDefinition(bool cache, ContentDispositionType dispositionType)`
	`9`	`+ public HttpFileResponseDefinition(bool cache, ContentDispositionType dispositionType, bool indentJson)`
`9`	`10`	`{`
`10`	`11`	`Cache = cache;`
`11`	`12`	`DispositionType = dispositionType;`
	`13`	`+ IndentJson = indentJson;`
`12`	`14`	`}`
`13`	`15`	`}`
`14`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.IO;`
	`3`	`+using System.Text.Json;`
`3`	`4`	`using System.Threading;`
`4`	`5`	`using System.Threading.Tasks;`
`5`	`6`	`using Dibix.Http.Server;`
`@@ -26,7 +27,7 @@ public HttpResponseFormatter(HttpResponse response)`
`26`	`27`	`}`
`27`	`28`	`else`
`28`	`29`	`{`
`29`		`- await WriteJsonResponse(result, cancellationToken).ConfigureAwait(false);`
	`30`	`+ await WriteJsonResponse(result, writeIndented: false, cancellationToken).ConfigureAwait(false);`
`30`	`31`	`}`
`31`	`32`
`32`	`33`	`return null;`
`@@ -62,23 +63,31 @@ void AppendFileName(ResponseHeaders responseHeaders, string fileName)`
`62`	`63`
`63`	`64`	`case IJsonFileMetadata jsonFileMetadata:`
`64`	`65`	`AppendFileName(responseHeaders, jsonFileMetadata.FileName);`
`65`		`- await WriteJsonResponse(result, cancellationToken).ConfigureAwait(false);`
	`66`	`+ await WriteJsonResponse(result, fileResponse.IndentJson, cancellationToken).ConfigureAwait(false);`
`66`	`67`	`break;`
`67`	`68`
`68`	`69`	`default:`
`69`	`70`	`throw new InvalidOperationException($"Unexpected file result type: {result.GetType()}");`
`70`	`71`	`}`
`71`	`72`	`}`
`72`	`73`
`73`		`- private async Task WriteJsonResponse(object? result, CancellationToken cancellationToken)`
	`74`	`+ private async Task WriteJsonResponse(object? result, bool writeIndented, CancellationToken cancellationToken)`
`74`	`75`	`{`
`75`	`76`	`if (result == null)`
`76`	`77`	`{`
`77`	`78`	`_response.StatusCode = StatusCodes.Status204NoContent;`
`78`	`79`	`return;`
`79`	`80`	`}`
`80`	`81`
`81`		`- await _response.WriteAsJsonAsync(result, cancellationToken: cancellationToken).ConfigureAwait(false);`
	`82`	`+ if (writeIndented)`
	`83`	`+ {`
	`84`	`+ JsonSerializerOptions jsonSerializerOptions = new JsonSerializerOptions(JsonSerializerDefaults.Web) { WriteIndented = true };`
	`85`	`+ await _response.WriteAsJsonAsync(result, jsonSerializerOptions, cancellationToken: cancellationToken).ConfigureAwait(false);`
	`86`	`+ }`
	`87`	`+ else`
	`88`	`+ {`
	`89`	`+ await _response.WriteAsJsonAsync(result, cancellationToken: cancellationToken).ConfigureAwait(false);`
	`90`	`+ }`
`82`	`91`	`}`
`83`	`92`	`}`
`84`	`93`	`}`
Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ private bool TryGetStatementDefinitionByProbing(string targetName, out SqlStatem`
`110`	`110`	`private static void CollectResponse(ActionDefinition actionDefinition, SqlStatementDefinition definition)`
`111`	`111`	`{`
`112`	`112`	`if (definition.FileResult != null)`
`113`		`- actionDefinition.SetFileResponse(new ActionFileResponse(HttpMediaType.Binary, cache: false, dispositionType: ContentDispositionType.Attachment), definition.FileResult.Location);`
	`113`	`+ actionDefinition.SetFileResponse(new ActionFileResponse(HttpMediaType.Binary, cache: false, dispositionType: ContentDispositionType.Attachment, indentJson: null), definition.FileResult.Location);`
`114`	`114`	`else`
`115`	`115`	`actionDefinition.DefaultResponseType = definition.ResultType;`
`116`	`116`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,12 +7,14 @@ public sealed class ActionFileResponse`
`7`	`7`	`public string MediaType { get; }`
`8`	`8`	`public bool Cache { get; }`
`9`	`9`	`public ContentDispositionType DispositionType { get; }`
	`10`	`+ public SourceLocation? IndentJson { get; }`
`10`	`11`
`11`		`- public ActionFileResponse(string mediaType, bool cache, ContentDispositionType dispositionType)`
	`12`	`+ public ActionFileResponse(string mediaType, bool cache, ContentDispositionType dispositionType, SourceLocation? indentJson)`
`12`	`13`	`{`
`13`	`14`	`MediaType = mediaType;`
`14`	`15`	`Cache = cache;`
`15`	`16`	`DispositionType = dispositionType;`
	`17`	`+ IndentJson = indentJson;`
`16`	`18`	`}`
`17`	`19`	`}`
`18`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -196,7 +196,7 @@ private void WriteActionConfiguration(CodeGenerationContext context, StringWrite`
`196`	`196`	`}`
`197`	`197`
`198`	`198`	`if (action.FileResponse != null)`
`199`		`- writer.WriteLine($"{variableName}.FileResponse = new HttpFileResponseDefinition(cache: {ComputeConstantLiteral(context, action.FileResponse.Cache)}, dispositionType: {ComputeConstantLiteral(context, action.FileResponse.DispositionType)});");`
	`199`	`+ writer.WriteLine($"{variableName}.FileResponse = new HttpFileResponseDefinition(cache: {ComputeConstantLiteral(context, action.FileResponse.Cache)}, dispositionType: {ComputeConstantLiteral(context, action.FileResponse.DispositionType)}, indentJson: false);");`
`200`	`200`
`201`	`201`	`foreach (int disabledAutoDetectionStatusCode in action.DisabledAutoDetectionStatusCodes)`
`202`	`202`	`{`
Original file line number	Diff line number	Diff line change
`@@ -49,14 +49,15 @@ private static IEnumerable<HttpActionDefinitionMetadata> CollectActions(CodeGene`
`49`	`49`	`{`
`50`	`50`	`foreach (ActionDefinition actionDefinition in controllerDefinition.Actions)`
`51`	`51`	`{`
	`52`	`+ ActionFileResponse fileResponse = actionDefinition.FileResponse;`
`52`	`53`	`HttpActionDefinitionMetadata actionMetadata = new HttpActionDefinitionMetadata`
`53`	`54`	`(`
`54`	`55`	`actionName: actionDefinition.OperationId,`
`55`	`56`	`relativeNamespace: actionDefinition.Target.RelativeNamespace,`
`56`	`57`	`uri: new Uri(RouteBuilder.BuildRoute(model.AreaName, controllerDefinition.Name, actionDefinition.ChildRoute), UriKind.Relative),`
`57`	`58`	`method: actionDefinition.Method,`
`58`	`59`	`childRoute: actionDefinition.ChildRoute?.Value,`
`59`		`- fileResponse: actionDefinition.FileResponse != null ? new HttpFileResponseDefinition(actionDefinition.FileResponse.Cache, actionDefinition.FileResponse.DispositionType) : null,`
	`60`	`+ fileResponse: fileResponse != null ? new HttpFileResponseDefinition(fileResponse.Cache, fileResponse.DispositionType, indentJson: fileResponse.IndentJson != null) : null,`
`60`	`61`	`description: actionDefinition.Description,`
`61`	`62`	`modelContextProtocolType: actionDefinition.ModelContextProtocolType,`
`62`	`63`	`securitySchemes: actionDefinition.SecuritySchemes.Requirements.Select(x => x.Scheme.SchemeName).ToArray(),`