Skip to content

Commit 872b873

Browse files
author
Bart Koelman
authored
Update README.md
1 parent 289800c commit 872b873

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,25 @@ The [release notes](https://github.com/json-api-dotnet/JsonApiDotNetCore/release
66
But to see the effects, this repository contains an example ASP.NET API project.
77
By comparing the changes between branches in this repo, you can see how this example project was changed to work with the next major version.
88

9+
### Upgrade from v4 to v5
10+
11+
The diff for the upgrade of example project [from v4.0.0 to v5.0.0](https://github.com/json-api-dotnet/MigrationGuide/compare/release/4.0.0...release/5.0.0) shows how to convert with minimal change in behavior. It includes tests that assert on the response json.
12+
13+
This upgrade should be straightforward in most cases. Notable renames:
14+
15+
| JsonApiDotNetCore v4 | JsonApiDotNetCore v5 |
16+
| --- | --- |
17+
| `IResourceContextProvider` | `IResourceGraph` |
18+
| `ResourceContext` | `ResourceType` |
19+
| `RelationshipAttribute.Left/RightType` | `RelationshipAttribute.Left/RightType.ClrType` |
20+
| `ErrorDocument` | `Document` |
21+
| `AtomicOperationsDocument` | `Document` |
22+
| `Error` | `ErrorObject` |
23+
24+
925
### Upgrade from v3 to v4
1026

11-
The diff for upgrade of example project [from v3.1.0 to v4.0.0](https://github.com/json-api-dotnet/MigrationGuide/compare/release/3.1.0...release/4.0.0) shows how to convert with minimal change in behavior. It includes tests that assert on the response json.
27+
The diff for the upgrade of example project [from v3.1.0 to v4.0.0](https://github.com/json-api-dotnet/MigrationGuide/compare/release/3.1.0...release/4.0.0) shows how to convert with minimal change in behavior. It includes tests that assert on the response json.
1228

1329
Since v3, a lot of the internal workings have been optimized. Depending on how much custom code you wrote, the next table of renames may help to find back what you need.
1430

0 commit comments

Comments
 (0)