Add support for JSON file input using body.treatAsFile property

Author: C0nquistadore

src/Dibix.Sdk.CodeGeneration/Lookup/ActionTargetDefinitionResolver.cs

@@ -22,7 +22,17 @@ protected ActionTargetDefinitionResolver(ISchemaRegistry schemaRegistry, ILogger
         #endregion
 
         #region Abstract Methods
-        public abstract bool TryResolve<T>(string targetName, SourceLocation sourceLocation, IReadOnlyDictionary<string, ExplicitParameter> explicitParameters, IReadOnlyDictionary<string, PathParameter> readOnlyDictionary, ICollection<string> bodyParameters, ActionRequestBody requestBody, Func<ActionTarget, T> actionTargetDefinitionFactory, out T actionTargetDefinition) where T : ActionTargetDefinition;
+        public bool TryResolve<T>(string targetName, SourceLocation sourceLocation, IReadOnlyDictionary<string, ExplicitParameter> explicitParameters, IReadOnlyDictionary<string, PathParameter> readOnlyDictionary, ICollection<string> bodyParameters, ActionRequestBody requestBody, Func<ActionTarget, T> actionTargetDefinitionFactory, out T actionTargetDefinition) where T : ActionTargetDefinition
+        {
+            bool result = TryResolveTarget(targetName, sourceLocation, explicitParameters, readOnlyDictionary, bodyParameters, requestBody, actionTargetDefinitionFactory, out actionTargetDefinition);
+            if (result)
+            {
+                CollectAdditionalParameters(requestBody, actionTargetDefinition);
+            }
+            return result;
+        }
+
+        protected abstract bool TryResolveTarget<T>(string targetName, SourceLocation sourceLocation, IReadOnlyDictionary<string, ExplicitParameter> explicitParameters, IReadOnlyDictionary<string, PathParameter> readOnlyDictionary, ICollection<string> bodyParameters, ActionRequestBody requestBody, Func<ActionTarget, T> actionTargetDefinitionFactory, out T actionTargetDefinition) where T : ActionTargetDefinition;
         #endregion
 
         #region Protected Methods
@@ -209,6 +219,29 @@ private ActionParameter CreateActionParameter(string name, TypeReference type, b
             bool isRequired = this.IsParameterRequired(type, location, defaultValue);
             return new ActionParameter(apiParameterName, internalParameterName, type, location, isRequired, isOutput, defaultValue, description, source, sourceLocation);
         }
+
+        private static void CollectAdditionalParameters(ActionRequestBody requestBody, ActionTargetDefinition actionTargetDefinition)
+        {
+            if (requestBody == null)
+                return;
+
+            if (!requestBody.IsStream(out SourceLocation isStreamLocation))
+                return;
+
+            if (requestBody.MediaType == HttpMediaType.Binary && actionTargetDefinition.Parameters.All(x => x.ApiParameterName != SpecialHttpParameterName.MediaType))
+            {
+                PrimitiveTypeReference mediaTypeParameterType = new PrimitiveTypeReference(PrimitiveType.String, isNullable: true, isEnumerable: false);
+                ActionParameter mediaTypeParameter = new ActionParameter(SpecialHttpParameterName.MediaType, SpecialHttpParameterName.MediaType, mediaTypeParameterType, ActionParameterLocation.Body, isRequired: false, isOutput: false, defaultValue: new NullValueReference(mediaTypeParameterType, default), description: null, source: null, isStreamLocation);
+                actionTargetDefinition.Parameters.Add(mediaTypeParameter);
+            }
+
+            if (actionTargetDefinition.Parameters.All(x => x.ApiParameterName != SpecialHttpParameterName.FileName))
+            {
+                PrimitiveTypeReference fileNameParameterType = new PrimitiveTypeReference(PrimitiveType.String, isNullable: true, isEnumerable: false);
+                ActionParameter fileNameParameter = new ActionParameter(SpecialHttpParameterName.FileName, SpecialHttpParameterName.FileName, fileNameParameterType, ActionParameterLocation.Body, isRequired: false, isOutput: false, defaultValue: new NullValueReference(fileNameParameterType, default), description: null, source: null, isStreamLocation);
+                actionTargetDefinition.Parameters.Add(fileNameParameter);
+            }
+        }
         #endregion
     }
 }

src/Dibix.Sdk.CodeGeneration/Lookup/ExternalReflectionActionTargetDefinitionResolver.cs

@@ -15,7 +15,7 @@ public ExternalReflectionActionTargetDefinitionResolver(ISchemaRegistry schemaRe
             this._lockEntryManager = lockEntryManager;
         }
 
-        public override bool TryResolve<T>(string targetName, SourceLocation sourceLocation, IReadOnlyDictionary<string, ExplicitParameter> explicitParameters, IReadOnlyDictionary<string, PathParameter> pathParameters, ICollection<string> bodyParameters, ActionRequestBody requestBody, Func<ActionTarget, T> actionTargetDefinitionFactory, out T actionTargetDefinition)
+        protected override bool TryResolveTarget<T>(string targetName, SourceLocation sourceLocation, IReadOnlyDictionary<string, ExplicitParameter> explicitParameters, IReadOnlyDictionary<string, PathParameter> pathParameters, ICollection<string> bodyParameters, ActionRequestBody requestBody, Func<ActionTarget, T> actionTargetDefinitionFactory, out T actionTargetDefinition)
         {
             string[] parts = targetName.Split(',');
             if (parts.Length != 2)

src/Dibix.Sdk.CodeGeneration/Lookup/SqlStatementDefinitionActionTargetDefinitionResolver.cs

@@ -35,7 +35,7 @@ string productName
         #endregion
 
         #region Overrides
-        public override bool TryResolve<T>(string targetName, SourceLocation sourceLocation, IReadOnlyDictionary<string, ExplicitParameter> explicitParameters, IReadOnlyDictionary<string, PathParameter> pathParameters, ICollection<string> bodyParameters, ActionRequestBody requestBody, Func<ActionTarget, T> actionTargetDefinitionFactory, out T actionTargetDefinition)
+        protected override bool TryResolveTarget<T>(string targetName, SourceLocation sourceLocation, IReadOnlyDictionary<string, ExplicitParameter> explicitParameters, IReadOnlyDictionary<string, PathParameter> pathParameters, ICollection<string> bodyParameters, ActionRequestBody requestBody, Func<ActionTarget, T> actionTargetDefinitionFactory, out T actionTargetDefinition)
         {
             if (!TryGetStatementDefinitionByProbing(targetName, out SqlStatementDefinition statementDefinition))
             {

src/Dibix.Sdk.CodeGeneration/Mapping/PrimitiveTypeMap.cs

@@ -70,8 +70,8 @@ internal static class PrimitiveTypeMap
           , [PrimitiveType.Decimal]        = () => new OpenApiSchema { Type = "number",  Format = "double"    }
           , [PrimitiveType.Binary]         = () => new OpenApiSchema { Type = "string",  Format = "byte"      }
           , [PrimitiveType.Stream]         = () => new OpenApiSchema { Type = "string",  Format = "binary"    }
-          , [PrimitiveType.Date]           = () => new OpenApiSchema { Type = "string",  Format = "date" }
-          , [PrimitiveType.Time]           = () => new OpenApiSchema { Type = "string",  Format = "time" }
+          , [PrimitiveType.Date]           = () => new OpenApiSchema { Type = "string",  Format = "date"      }
+          , [PrimitiveType.Time]           = () => new OpenApiSchema { Type = "string",  Format = "time"      }
           , [PrimitiveType.DateTime]       = () => new OpenApiSchema { Type = "string",  Format = "date-time" }
           , [PrimitiveType.DateTimeOffset] = () => new OpenApiSchema { Type = "string",  Format = "date-time" }
           , [PrimitiveType.String]         = () => new OpenApiSchema { Type = "string"                        }

src/Dibix.Sdk.CodeGeneration/Model/ActionRequestBody.cs

@@ -5,6 +5,7 @@ public sealed class ActionRequestBody
         public string MediaType { get; } = HttpMediaType.Json;
         public TypeReference Contract { get; }
         public string Binder { get; }
+        public SourceLocation? TreatAsFile { get; }
         public SourceLocation Location { get; }
 
         public ActionRequestBody(TypeReference contract, SourceLocation location)
@@ -16,9 +17,10 @@ public ActionRequestBody(TypeReference contract, SourceLocation location, string
         {
             MediaType = mediaType;
         }
-        public ActionRequestBody(TypeReference contract, SourceLocation location, string mediaType, string binder) : this(contract, location, mediaType)
+        public ActionRequestBody(TypeReference contract, SourceLocation location, string mediaType, string binder, SourceLocation? treatAsFile) : this(contract, location, mediaType)
         {
             Binder = binder;
+            TreatAsFile = treatAsFile;
         }
     }
 }

src/Dibix.Sdk.CodeGeneration/Model/SchemaExtensions.cs

@@ -28,5 +28,22 @@ bool MatchesOutputFilter(SchemaDefinition schema)
             IEnumerable<SchemaDefinition> schemas = model.Schemas.Where(MatchesOutputFilter);
             return schemas;
         }
+
+        public static bool IsStream(this ActionRequestBody requestBody, out SourceLocation location)
+        {
+            if (requestBody.Contract != null && requestBody.Contract.IsStream(out location))
+            {
+                return true;
+            }
+
+            if (requestBody.TreatAsFile != null)
+            {
+                location = requestBody.TreatAsFile.Value;
+                return true;
+            }
+
+            location = default;
+            return false;
+        }
     }
 }

src/Dibix.Sdk.CodeGeneration/OpenApi/OpenApiGenerator.cs

@@ -176,19 +176,20 @@ private static OpenApiParameter AppendParameter(OpenApiDocument document, OpenAp
                 In = parameterLocation,
                 Required = actionParameter.IsRequired,
                 Name = actionParameter.ApiParameterName,
-                Schema = CreateSchema(document, parameterType, isEnumerable, actionParameter.DefaultValue, rootNamespace, supportOpenApiNullableReferenceTypes, schemaRegistry, logger)
+                Schema = CreateSchema(document, parameterType, isEnumerable, actionParameter.DefaultValue, rootNamespace, supportOpenApiNullableReferenceTypes, treatAsFile: false, schemaRegistry, logger)
             };
             operation.Parameters.Add(apiParameter);
             return apiParameter;
         }
 
         private static void AppendBody(OpenApiDocument document, OpenApiOperation operation, ActionDefinition action, string rootNamespace, bool supportOpenApiNullableReferenceTypes, ISchemaRegistry schemaRegistry, ILogger logger)
         {
-            if (action.RequestBody == null)
+            ActionRequestBody requestBody = action.RequestBody;
+            if (requestBody == null)
                 return;
 
             OpenApiRequestBody body = new OpenApiRequestBody { Required = true };
-            AppendContent(document, body.Content, action.RequestBody.MediaType, action.RequestBody.Contract, rootNamespace, supportOpenApiNullableReferenceTypes, schemaRegistry, logger);
+            AppendContent(document, body.Content, requestBody.MediaType, requestBody.Contract, rootNamespace, supportOpenApiNullableReferenceTypes, requestBody.TreatAsFile != null, schemaRegistry, logger);
             operation.RequestBody = body;
         }
 
@@ -199,7 +200,7 @@ private static void AppendResponses(OpenApiDocument document, OpenApiOperation o
                 OpenApiResponse apiResponse = new OpenApiResponse();
 
                 if (actionResponse.ResultType != null)
-                    AppendContent(document, apiResponse.Content, actionResponse.MediaType, actionResponse.ResultType, rootNamespace, supportOpenApiNullableReferenceTypes, schemaRegistry, logger);
+                    AppendContent(document, apiResponse.Content, actionResponse.MediaType, actionResponse.ResultType, rootNamespace, supportOpenApiNullableReferenceTypes, treatAsFile: false, schemaRegistry, logger);
 
                 StringBuilder sb = new StringBuilder(actionResponse.Description);
                 if (actionResponse.Errors.Any())
@@ -230,9 +231,10 @@ private static void AppendResponses(OpenApiDocument document, OpenApiOperation o
             }
         }
 
-        private static void AppendContent(OpenApiDocument document, IDictionary<string, OpenApiMediaType> target, string mediaType, TypeReference typeReference, string rootNamespace, bool supportOpenApiNullableReferenceTypes, ISchemaRegistry schemaRegistry, ILogger logger)
+        private static void AppendContent(OpenApiDocument document, IDictionary<string, OpenApiMediaType> target, string mediaType, TypeReference typeReference, string rootNamespace, bool supportOpenApiNullableReferenceTypes, bool treatAsFile, ISchemaRegistry schemaRegistry, ILogger logger)
         {
-            OpenApiMediaType content = new OpenApiMediaType { Schema = CreateSchema(document, typeReference, rootNamespace, supportOpenApiNullableReferenceTypes, schemaRegistry, logger) };
+            OpenApiSchema schema = CreateSchema(document, typeReference, rootNamespace, supportOpenApiNullableReferenceTypes, treatAsFile, schemaRegistry, logger);
+            OpenApiMediaType content = new OpenApiMediaType { Schema = schema };
             target.Add(mediaType, content);
         }
 
@@ -300,10 +302,10 @@ private static void AppendSecuritySchemes(OpenApiDocument document, IEnumerable<
             _ => throw new ArgumentOutOfRangeException(nameof(value), value, null)
         };
 
-        private static OpenApiSchema CreateSchema(OpenApiDocument document, TypeReference typeReference, string rootNamespace, bool supportOpenApiNullableReferenceTypes, ISchemaRegistry schemaRegistry, ILogger logger) => CreateSchema(document, typeReference, typeReference.IsEnumerable, defaultValue: null, rootNamespace: rootNamespace, supportOpenApiNullableReferenceTypes: supportOpenApiNullableReferenceTypes, schemaRegistry: schemaRegistry, logger: logger);
-        private static OpenApiSchema CreateSchema(OpenApiDocument document, TypeReference typeReference, bool isEnumerable, ValueReference defaultValue, string rootNamespace, bool supportOpenApiNullableReferenceTypes, ISchemaRegistry schemaRegistry, ILogger logger)
+        private static OpenApiSchema CreateSchema(OpenApiDocument document, TypeReference typeReference, string rootNamespace, bool supportOpenApiNullableReferenceTypes, bool treatAsFile, ISchemaRegistry schemaRegistry, ILogger logger) => CreateSchema(document, typeReference, typeReference.IsEnumerable, defaultValue: null, rootNamespace, supportOpenApiNullableReferenceTypes, treatAsFile, schemaRegistry, logger);
+        private static OpenApiSchema CreateSchema(OpenApiDocument document, TypeReference typeReference, bool isEnumerable, ValueReference defaultValue, string rootNamespace, bool supportOpenApiNullableReferenceTypes, bool treatAsFile, ISchemaRegistry schemaRegistry, ILogger logger)
         {
-            OpenApiSchema schema = CreateSchemaCore(document, typeReference, defaultValue, rootNamespace, supportOpenApiNullableReferenceTypes, schemaRegistry, logger);
+            OpenApiSchema schema = CreateSchemaCore(document, typeReference, defaultValue, rootNamespace, supportOpenApiNullableReferenceTypes, treatAsFile, schemaRegistry, logger);
 
             if (isEnumerable)
             {
@@ -317,20 +319,27 @@ private static OpenApiSchema CreateSchema(OpenApiDocument document, TypeReferenc
             return schema;
         }
 
-        private static OpenApiSchema CreateSchemaCore(OpenApiDocument document, TypeReference typeReference, ValueReference defaultValue, string rootNamespace, bool supportOpenApiNullableReferenceTypes, ISchemaRegistry schemaRegistry, ILogger logger)
+        private static OpenApiSchema CreateSchemaCore(OpenApiDocument document, TypeReference typeReference, ValueReference defaultValue, string rootNamespace, bool supportOpenApiNullableReferenceTypes, bool treatAsFile, ISchemaRegistry schemaRegistry, ILogger logger)
         {
-            switch (typeReference)
+            if (treatAsFile)
             {
-                case PrimitiveTypeReference primitiveContractPropertyType: return CreatePrimitiveTypeSchema(primitiveContractPropertyType, defaultValue, schemaRegistry, logger);
-                case SchemaTypeReference contractPropertyTypeReference: return CreateReferenceSchema(document, contractPropertyTypeReference, rootNamespace, supportOpenApiNullableReferenceTypes, schemaRegistry, logger);
-                default: throw new ArgumentOutOfRangeException(nameof(typeReference), typeReference, $"Unexpected property type: {typeReference}");
+                return CreatePrimitiveTypeSchema(typeReference, PrimitiveType.Stream, defaultValue, schemaRegistry, logger);
             }
+
+            OpenApiSchema schema = typeReference switch
+            {
+                PrimitiveTypeReference primitiveContractPropertyType => CreatePrimitiveTypeSchema(primitiveContractPropertyType, defaultValue, schemaRegistry, logger),
+                SchemaTypeReference contractPropertyTypeReference => CreateReferenceSchema(document, contractPropertyTypeReference, rootNamespace, supportOpenApiNullableReferenceTypes, schemaRegistry, logger),
+                _ => throw new ArgumentOutOfRangeException(nameof(typeReference), typeReference, $"Unexpected property type: {typeReference}")
+            };
+            return schema;
         }
 
-        private static OpenApiSchema CreatePrimitiveTypeSchema(PrimitiveTypeReference typeReference, ValueReference defaultValue, ISchemaRegistry schemaRegistry, ILogger logger)
+        private static OpenApiSchema CreatePrimitiveTypeSchema(PrimitiveTypeReference typeReference, ValueReference defaultValue, ISchemaRegistry schemaRegistry, ILogger logger) => CreatePrimitiveTypeSchema(typeReference, typeReference.Type, defaultValue, schemaRegistry, logger);
+        private static OpenApiSchema CreatePrimitiveTypeSchema(TypeReference typeReference, PrimitiveType type, ValueReference defaultValue, ISchemaRegistry schemaRegistry, ILogger logger)
         {
-            if (!PrimitiveTypeMap.TryGetOpenApiFactory(typeReference.Type, out Func<OpenApiSchema> schemaFactory))
-                throw new InvalidOperationException($"Unexpected primitive type: {typeReference.Type}");
+            if (!PrimitiveTypeMap.TryGetOpenApiFactory(type, out Func<OpenApiSchema> schemaFactory))
+                throw new InvalidOperationException($"Unexpected primitive type: {type}");
 
             OpenApiSchema schema = schemaFactory();
             schema.Nullable = typeReference.IsNullable;
@@ -440,7 +449,7 @@ private static void AppendObjectSchema(OpenApiDocument document, string schemaNa
                     continue;
 
                 string propertyName = StringExtensions.ToCamelCase(property.Name);
-                OpenApiSchema propertySchema = CreateSchema(document, property.Type, rootNamespace, supportOpenApiNullableReferenceTypes, schemaRegistry, logger);
+                OpenApiSchema propertySchema = CreateSchema(document, property.Type, rootNamespace, supportOpenApiNullableReferenceTypes, treatAsFile: false, schemaRegistry, logger);
                 schema.Properties.Add(propertyName, propertySchema);
 
                 if (property.SerializationBehavior == SerializationBehavior.Always && !property.IsOptional)