Skip to content

Commit deea642

Browse files
committed
docs: adds missing documentation around new exceptions
Signed-off-by: Vincent Biret <[email protected]>
1 parent 7478523 commit deea642

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/upgrade-guide-2.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,13 @@ As the YAML format is only supported when including the `Microsoft.OpenApi.YamlR
7373

7474
When the loading methods are used without a format parameter, we will attempt to parse the document using the default JSON reader. If that fails and the YAML reader is registered, then we will attempt to read as YAML. The goal is always to provide the fastest path with JSON but still maintain the convenience of not having to care whether a URL points to YAML or JSON if you need that flexibility.
7575

76+
### Additional exceptions
77+
78+
While parsing an OpenAPI description, the library will now throw the following new exceptions:
79+
80+
- `OpenApiReaderException` when the reader for the format cannot be found, the document cannot be parsed because it does not follow the format conventions, etc...
81+
- `OpenApiUnsupportedSpecVersionException` when the document's version is not implemented by this version of the library and therefore cannot be parsed.
82+
7683
### Removing the OpenAPI Any classes
7784

7885
In the OpenAPI specification, there are a few properties that are defined as type `any`. This includes:

0 commit comments

Comments
 (0)