Skip to content

Commit 305f026

Browse files
committed
docs: adds information regarding trimming support
Signed-off-by: Vincent Biret <[email protected]>
1 parent 7f3be25 commit 305f026

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/upgrade-guide-2.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,14 @@ Is now:
3939
var result = await myOperation.SerializeAsJsonAsync(OpenApiSpecVersion.OpenApi2_0);
4040
```
4141

42+
### Trimming support
43+
44+
To better support applications deployed in high performance environments or on devices which have limited compute available, any usage of reflection has been removed from the code base. This also brings support for trimming to the library. Any method relying on reflection has been removed or re-written.
45+
46+
> Note: as part of this change, the following types have been removed:
47+
>
48+
> - StringExtensions
49+
4250
## Reduced Dependencies
4351

4452
In OpenAPI v1, it was necessary to include the Microsoft.OpenApi.Readers library to be able to read OpenAPI descriptions in either YAML or JSON. In OpenAPI.NET v2, the core Microsoft.OpenAPI library can both read and write JSON. It is only necessary to use the newly renamed [Microsoft.OpenApi.YamlReader](https://www.nuget.org/packages/Microsoft.OpenApi.YamlReader/) library if you need YAML support. This allows teams who are only working in JSON to avoid the additional dependency and therefore eliminate all non-.NET library references.

0 commit comments

Comments
 (0)