From e055172993f68546158815e37d9c7279671e90b8 Mon Sep 17 00:00:00 2001 From: wadepickett Date: Thu, 5 Feb 2026 14:03:29 -0800 Subject: [PATCH 1/3] [11.0 P1] What's New: OpenAPI: Binary File Response --- aspnetcore/release-notes/aspnetcore-11.md | 2 + .../includes/openapi-binary-file-response.md | 57 +++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 aspnetcore/release-notes/aspnetcore-11/includes/openapi-binary-file-response.md diff --git a/aspnetcore/release-notes/aspnetcore-11.md b/aspnetcore/release-notes/aspnetcore-11.md index 88c66575d831..dc476cdfd0cc 100644 --- a/aspnetcore/release-notes/aspnetcore-11.md +++ b/aspnetcore/release-notes/aspnetcore-11.md @@ -37,6 +37,8 @@ This section describes new features for Minimal APIs. This section describes new features for OpenAPI. +[!INCLUDE[](~/release-notes/aspnetcore-11/includes/openapi-binary-file-response.md)] + ## Authentication and authorization This section describes new features for authentication and authorization. diff --git a/aspnetcore/release-notes/aspnetcore-11/includes/openapi-binary-file-response.md b/aspnetcore/release-notes/aspnetcore-11/includes/openapi-binary-file-response.md new file mode 100644 index 000000000000..d19372be8062 --- /dev/null +++ b/aspnetcore/release-notes/aspnetcore-11/includes/openapi-binary-file-response.md @@ -0,0 +1,57 @@ +### Describe binary file responses + +ASP.NET Core 11 Preview 1 introduces support for generating OpenAPI descriptions for operations that return binary file responses. This support maps the `FileContentResult` result type to an OpenAPI schema with `type: string` and `format: binary`. + +#### [Minimal APIs](#tab/minimal-apis) + +Use the `Produces` extension method with `T` of `FileContentResult` to specify the response type and content type: + + +```csharp +app.MapPost("/filecontentresult", () => +{ + var content = "This endpoint returns a FileContentResult!"u8.ToArray(); + return TypedResults.File(content); +}) +.Produces(contentType: MediaTypeNames.Application.Octet); +``` + +#### [Controllers](#tab/controllers) + +Use the `ProducesResponseType` attribute with `T` of `FileContentResult` to specify the response type and content type: + +```csharp +[HttpPost("filecontentresult")] +[ProducesResponseType(StatusCodes.Status200OK, MediaTypeNames.Application.Octet)] +public IActionResult PostFileContentResult() +{ + var content = "This endpoint returns a FileContentResult!"u8.ToArray(); + return new FileContentResult(content, MediaTypeNames.Application.Octet); +} +``` + +--- + +The generated OpenAPI document describes the endpoint response as: + +```yaml +responses: + '200': + description: OK + content: + application/octet-stream: + schema: + $ref: '#/components/schemas/FileContentResult' +``` + +With `FileContentResult` defined in `components/schemas` as: + +```yaml +components: + schemas: + FileContentResult: + type: string + format: binary +``` From 3da4c178ed1babdace299a8824c3151b736cf7f8 Mon Sep 17 00:00:00 2001 From: Wade Pickett Date: Fri, 6 Feb 2026 13:22:25 -0800 Subject: [PATCH 2/3] Update aspnetcore/release-notes/aspnetcore-11/includes/openapi-binary-file-response.md Co-authored-by: Luke Latham <1622880+guardrex@users.noreply.github.com> --- .../aspnetcore-11/includes/openapi-binary-file-response.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/aspnetcore/release-notes/aspnetcore-11/includes/openapi-binary-file-response.md b/aspnetcore/release-notes/aspnetcore-11/includes/openapi-binary-file-response.md index d19372be8062..1f7093415e91 100644 --- a/aspnetcore/release-notes/aspnetcore-11/includes/openapi-binary-file-response.md +++ b/aspnetcore/release-notes/aspnetcore-11/includes/openapi-binary-file-response.md @@ -46,7 +46,7 @@ responses: $ref: '#/components/schemas/FileContentResult' ``` -With `FileContentResult` defined in `components/schemas` as: +The `FileContentResult` is defined in `components/schemas` as: ```yaml components: From 8d37008e7fccfe912a3bfd95fa28993dc19eebb7 Mon Sep 17 00:00:00 2001 From: Wade Pickett Date: Fri, 6 Feb 2026 13:22:45 -0800 Subject: [PATCH 3/3] Update aspnetcore/release-notes/aspnetcore-11/includes/openapi-binary-file-response.md Co-authored-by: Luke Latham <1622880+guardrex@users.noreply.github.com> --- .../aspnetcore-11/includes/openapi-binary-file-response.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/aspnetcore/release-notes/aspnetcore-11/includes/openapi-binary-file-response.md b/aspnetcore/release-notes/aspnetcore-11/includes/openapi-binary-file-response.md index 1f7093415e91..c73a4fdb3aae 100644 --- a/aspnetcore/release-notes/aspnetcore-11/includes/openapi-binary-file-response.md +++ b/aspnetcore/release-notes/aspnetcore-11/includes/openapi-binary-file-response.md @@ -1,6 +1,6 @@ ### Describe binary file responses -ASP.NET Core 11 Preview 1 introduces support for generating OpenAPI descriptions for operations that return binary file responses. This support maps the `FileContentResult` result type to an OpenAPI schema with `type: string` and `format: binary`. +ASP.NET Core 11 introduces support for generating OpenAPI descriptions for operations that return binary file responses. This support maps the `FileContentResult` result type to an OpenAPI schema with `type: string` and `format: binary`. #### [Minimal APIs](#tab/minimal-apis)