Unable to set request body format to binary in minimal api

[FranklinWhale]

Is there an existing issue for this?

• I have searched the existing issues

Describe the bug

requestBody in swagger.json of the code below

app.MapPut("/file", Created (HttpRequest request) => {
    return TypedResults.Created("https://example.org");
})
.Accepts<byte[]>("application/zip")
.Produces(StatusCodes.Status415UnsupportedMediaType)

is

"requestBody": {
  "content": {
    "application/zip": {
      "schema": {
        "type": "string",
        "format": "byte"
      }
    }
  }
}

while .Accepts<Stream>("application/zip")

leads to

"requestBody": {
  "content": {
    "application/zip": {
      "schema": {
        "$ref": "#/components/schemas/Stream"
      }
    }
  }
}

When I want to override requestBody by adding

.WithOpenApi(o => {
    o.RequestBody = new OpenApiRequestBody {
        Content = new Dictionary<string, OpenApiMediaType>() {
            {
                "application/zip",
                new OpenApiMediaType {
                    Schema = new OpenApiSchema {
                        Type = "string",
                        Format = "binary"
                    }
                }
            }
        }
    };
    return o;
});

I find that it has no effect.

How to set format to binary?

.NET Version

7.0.100

[captainsafia]

Triage: This behavior occurs because the moment schema generation for types in OpenAPI is facilitated by Swashbuckle. Even if you set a schema specifically using WithOpenApi, it gets overridden in Swashbuckle's schema generator. See domaindrivendev/Swashbuckle.AspNetCore#2521 for more info. By default, the correct scheme isn't set here.

For now, you might want to consider using an OperationFilter in Swashbuckle to set the types whenever the return type is a stream. It would look something like this:

builder.Services.AddSwaggerGen(c =>
{
    c.OperationFilter<StreamParameterOperationFilter>();
});

public class StreamParameterOperationFilter : IOperationFilter
{
    public void Apply(OpenApiOperation operation, OperationFilterContext context)
    {
      var acceptsMetadata = context.ApiDescription.ActionDescriptor.EndpointMetadata.OfType<IAcceptsMetadata>();
      if (acceptsMetadata.RequestType == typeof(Stream)
      {
         // modify operation here
      }
    }

Hi @FranklinWhale. We have added the "Needs: Author Feedback" label to this issue, which indicates that we have an open question for you before we can take further action. This issue will be closed automatically in 7 days if we do not hear back from you by then - please feel free to re-open it if you come back to this issue after that time.

This issue has been automatically marked as stale because it has been marked as requiring author feedback but has not had any activity for 4 days. It will be closed if no further activity occurs within 3 days of this comment. If it is closed, feel free to comment when you are able to provide the additional information and we will re-investigate.

See our Issue Management Policies for more information.