Skip to content

Commit e60abd7

Browse files
committed
WN: P1
1 parent 85c998a commit e60abd7

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ OpenAPI 3.1 support was primarly added in the following [PR](https://github.com/
3535

3636
Support for OpenAPI 3.1 requires an update to the underlying OpenAPI.NET library to a new major version, 2.0. This new version has some breaking changes from the previous version. The breaking changes may impact apps if they have any document, operation, or schema transformers.
3737

38-
One of the most significant changes is that the `OpenApiAny` class has been dropped in favor of using `JsonNode` directly. Transformers that use `OpenApiAny` need to be updated to use `JsonNode`. For example, a schema transformer to add an example in .NET 9 might look like the following:
38+
One of the most significant changes is that the `OpenApiAny` class has been dropped in favor of using `JsonNode` directly. Transformers that use `OpenApiAny` need to be updated to use `JsonNode`. For example, a schema transformer to add an example in .NET 9 might look like the following code:
3939

4040
```csharp
4141
options.AddSchemaTransformer((schema, context, cancellationToken) =>
@@ -54,7 +54,7 @@ One of the most significant changes is that the `OpenApiAny` class has been drop
5454
});
5555
```
5656

57-
In .NET 10 the transformer to do the same task will look like the following:
57+
In .NET 10 the transformer to do the same task will look like the following code:
5858

5959
```csharp
6060
options.AddSchemaTransformer((schema, context, cancellationToken) =>
@@ -101,8 +101,6 @@ Note that these changes are necessary even when only congfiguring the OpenAPI ve
101101

102102
### OpenAPI in Yaml
103103

104-
https://github.com/dotnet/aspnetcore/pull/58616
105-
106104
ASP.NET now supports serving the generated OpenAPI document in YAML format. YAML can be more concise than JSON, eliminating curly braces and quotation marks when these can be inferred. YAML also supports multi-line strings, which can be useful for long descriptions.
107105

108106
To configure an app to serve the generated OpenAPI document in YAML format, specify the endpoint in the MapOpenApi call with a ".yaml" or ".yml" suffix, as shown in the following example:
@@ -113,7 +111,7 @@ app.MapOpenApi("/openapi/{documentName}.yaml");
113111

114112
Support for:
115113

116-
* YAML is currently only available for the the OpenAPI served from the OpenAPI endpoint.
117-
* Generating OpenAPI documents in YAML format at build time isadded in a future preview.
114+
- YAML is currently only available for the the OpenAPI served from the OpenAPI endpoint.
115+
- Generating OpenAPI documents in YAML format at build time isadded in a future preview.
118116

119117
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/testAppsTopLevel.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ In .NET 10, a source generator is used to generate the `public partial class Pro
88

99
The following PRs contribited to this feature:
1010

11-
* [PR 58199](https://github.com/dotnet/aspnetcore/pull/58199)
12-
* [PR 58482](https://github.com/dotnet/aspnetcore/pull/58482)
11+
- [PR 58199](https://github.com/dotnet/aspnetcore/pull/58199)
12+
- [PR 58482](https://github.com/dotnet/aspnetcore/pull/58482)

0 commit comments

Comments
 (0)