Skip to content

Commit 3e65e28

Browse files
committed
WN: P1
1 parent 606c6e6 commit 3e65e28

File tree

2 files changed

+4
-5
lines changed

2 files changed

+4
-5
lines changed

aspnetcore/release-notes/aspnetcore-10/includes/openApi.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ Some of the changes you will see in the generated OpenAPI document include:
1212
- Nullable types no longer have the `nullable: true` property in the schema.
1313
- Instead of a `nullable: true` property, they have a `type` keyword whose value is an array that includes `null` as one of the types.
1414

15-
With this feature, the default OpenAPI version for generated documents will be `3.1` . You can easily change the version
16-
by explicitly setting the [OpenApiVersion](/dotnet/api/microsoft.aspnetcore.openapi.openapioptions.openapiversion?view=aspnetcore-9.0) property of the [OpenApiOptions](/dotnet/api/microsoft.aspnetcore.openapi.openapioptions?view=aspnetcore-9.0) in the `configureOptions` delegate parameter of [AddOpenApi](/dotnet/api/microsoft.extensions.dependencyinjection.openapiservicecollectionextensions.addopenapi?view=aspnetcore-9.0).
15+
With this feature, the default OpenAPI version for generated documents is`3.1` . The version can be changed by explicitly setting the [OpenApiVersion](/dotnet/api/microsoft.aspnetcore.openapi.openapioptions.openapiversion) property of the [OpenApiOptions](/dotnet/api/microsoft.aspnetcore.openapi.openapioptions) in the `configureOptions` delegate parameter of [AddOpenApi](/dotnet/api/microsoft.extensions.dependencyinjection.openapiservicecollectionextensions.addopenapi).
1716

1817
```csharp
1918
builder.Services.AddOpenApi(options =>
@@ -30,7 +29,7 @@ When generating the OpenAPI document at build time, the OpenAPI version can be s
3029
<OpenApiGenerateDocumentsOptions>--openapi-version OpenApi3_0</OpenApiGenerateDocumentsOptions>
3130
```
3231

33-
OpenAPI 3.1 support was primarly added in the following this [PR](https://github.com/dotnet/aspnetcore/pull/59480).
32+
OpenAPI 3.1 support was primarly added in the following [PR](https://github.com/dotnet/aspnetcore/pull/59480).
3433

3534
### OpenAPI 3.1 breaking changes
3635

@@ -91,6 +90,6 @@ app.MapOpenApi("/openapi/{documentName}.yaml");
9190
Support for:
9291

9392
* YAML is currently only available for the the OpenAPI served from the OpenAPI endpoint.
94-
* Generating OpenAPI documents in YAML format at build time will be added in a future preview.
93+
* Generating OpenAPI documents in YAML format at build time isadded in a future preview.
9594

9695
See [this PR](https://github.com/dotnet/aspnetcore/pull/58616) which added support for serving the generated OpenAPI document in YAML format.

aspnetcore/release-notes/aspnetcore-10/includes/responseDescProducesResponseType.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Response description on ProducesResponseType
22

3-
The [ProducesAttribute](/dotnet/api/microsoft.aspnetcore.mvc.producesattribute-1?view=aspnetcore-9.0), [ProducesResponseTypeAttribute](/dotnet/api/microsoft.aspnetcore.mvc.producesresponsetypeattribute-1?view=aspnetcore-9.0), and [ProducesDefaultResponseType](/dotnet/api/microsoft.aspnetcore.mvc.producesdefaultresponsetypeattribute?view=aspnetcore-9.0) attributes now accept an optional string parameter, `Description`, that will set the description of the response. Here's an example:
3+
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:
44

55
```csharp
66
[HttpGet(Name = "GetWeatherForecast")]

0 commit comments

Comments
 (0)