diff --git a/aspnetcore/release-notes/aspnetcore-10/includes/responseDescProducesResponseType.md b/aspnetcore/release-notes/aspnetcore-10/includes/responseDescProducesResponseType.md index 29eb865527c6..517777365b05 100644 --- a/aspnetcore/release-notes/aspnetcore-10/includes/responseDescProducesResponseType.md +++ b/aspnetcore/release-notes/aspnetcore-10/includes/responseDescProducesResponseType.md @@ -1,23 +1,22 @@ -### Response description on ProducesResponseType for API controllers +### Response description on `ProducesResponseType` for API controllers -The [ProducesAttribute](/dotnet/api/microsoft.aspnetcore.mvc.producesattribute-1), [ProducesResponseTypeAttribute](/dotnet/api/microsoft.aspnetcore.mvc.producesresponsetypeattribute-1), and [ProducesDefaultResponseType](/dotnet/api/microsoft.aspnetcore.mvc.producesdefaultresponsetypeattribute) attributes now accept an optional string parameter, `Description`, that will set the description of the response. Here's an example: +The , , and now accept an optional string parameter, `Description`, that sets the description of the response: ```csharp [HttpGet(Name = "GetWeatherForecast")] [ProducesResponseType>(StatusCodes.Status200OK, - Description = "The weather forecast for the next 5 days.")] + Description = "The weather forecast for the next 5 days.")] public IEnumerable Get() { ``` -And the generated OpenAPI: +Generated OpenAPI data: ```json - "responses": { - "200": { - "description": "The weather forecast for the next 5 days.", - "content": { +"responses": { + "200": { + "description": "The weather forecast for the next 5 days.", + "content": { ``` -[Minimal APIs](https://github.com/dotnet/aspnetcore/issues/58724) currently don't support `ProducesResponseType`. -[Community contribution](https://github.com/dotnet/aspnetcore/pull/58193) by [Sander ten Brinke](https://github.com/sander1095) 🙏 +[Community contribution (`dotnet/aspnetcore` #58193)](https://github.com/dotnet/aspnetcore/pull/58193) by [Sander ten Brinke](https://github.com/sander1095). diff --git a/aspnetcore/release-notes/aspnetcore-10/includes/webapiaotTemplateAddedOpenAPI.md b/aspnetcore/release-notes/aspnetcore-10/includes/webapiaotTemplateAddedOpenAPI.md index eb64f256aac5..1f50dc867ac3 100644 --- a/aspnetcore/release-notes/aspnetcore-10/includes/webapiaotTemplateAddedOpenAPI.md +++ b/aspnetcore/release-notes/aspnetcore-10/includes/webapiaotTemplateAddedOpenAPI.md @@ -1,5 +1,5 @@ ### Microsoft.AspNetCore.OpenApi added to the ASP.NET Core web API (Native AOT) template -The **ASP.NET Core Web API (Native AOT)** project template (short name `webapiaot`) now includes support for OpenAPI document generation using the [`Microsoft.AspNetCore.OpenApi`](https://www.nuget.org/packages/Microsoft.AspNetCore.OpenApi) package by default. This support is disabled by using the `--no-openapi` flag when creating a new project. +The **ASP.NET Core Web API (Native AOT)** project template (short name `webapiaot`) now includes support for OpenAPI document generation using the [`Microsoft.AspNetCore.OpenApi` package](https://www.nuget.org/packages/Microsoft.AspNetCore.OpenApi) by default. This support is disabled by using the `--no-openapi` flag when creating a new project. -This was a community contribution by @sander1095. Thanks for this contribution! +[Community contribution (`dotnet/aspnetcore` #60337)](https://github.com/dotnet/aspnetcore/pull/60337) by [Sander ten Brinke](https://github.com/sander1095).