Skip to content

Commit bb426c6

Browse files
author
Bart Koelman
committed
Addressed review feedback
1 parent 4f23fc2 commit bb426c6

File tree

5 files changed

+15
-15
lines changed

5 files changed

+15
-15
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,13 @@ public class Startup
8787
The following chart should help you pick the best version, based on your environment.
8888
See also our [versioning policy](./VERSIONING_POLICY.md).
8989

90-
| .NET version | EF Core version | JsonApiDotNetCore version |
91-
| ------------ | --------------- | ------------------------- |
92-
| Core 2.x | 2.x | 3.x |
93-
| Core 3.1 | 3.1 | 4.x |
94-
| Core 3.1 | 5 | 4.x |
95-
| 5 | 5 | 4.x or 5.x |
96-
| 6 | 6 | 5.x |
90+
| .NET version | Entity Framework Core version | JsonApiDotNetCore version |
91+
| ------------ | ----------------------------- | ------------------------- |
92+
| Core 2.x | 2.x | 3.x |
93+
| Core 3.1 | 3.1 | 4.x |
94+
| Core 3.1 | 5 | 4.x |
95+
| 5 | 5 | 4.x or 5.x |
96+
| 6 | 6 | 5.x |
9797

9898
## Contributing
9999

docs/internals/queries.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ _since v4.0_
55
The query pipeline roughly looks like this:
66

77
```
8-
HTTP --[ASP.NET]--> QueryString --[JADNC:QueryStringParameterReader]--> QueryExpression[] --[JADNC:ResourceService]--> QueryLayer --[JADNC:Repository]--> IQueryable --[EF Core]--> SQL
8+
HTTP --[ASP.NET]--> QueryString --[JADNC:QueryStringParameterReader]--> QueryExpression[] --[JADNC:ResourceService]--> QueryLayer --[JADNC:Repository]--> IQueryable --[Entity Framework Core]--> SQL
99
```
1010

1111
Processing a request involves the following steps:
@@ -22,7 +22,7 @@ Processing a request involves the following steps:
2222
- `JsonApiResourceService` contains no more usage of `IQueryable`.
2323
- `EntityFrameworkCoreRepository` delegates to `QueryableBuilder` to transform the `QueryLayer` tree into `IQueryable` expression trees.
2424
`QueryBuilder` depends on `QueryClauseBuilder` implementations that visit the tree nodes, transforming them to `System.Linq.Expression` equivalents.
25-
The `IQueryable` expression trees are executed by EF Core, which produces SQL statements out of them.
25+
The `IQueryable` expression trees are executed by Entity Framework Core, which produces SQL statements out of them.
2626
- `JsonApiWriter` transforms resource objects into json response.
2727

2828
# Example

docs/usage/extensibility/resource-definitions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ _since v3_
223223
You can define additional query string parameters with the LINQ expression that should be used.
224224
If the key is present in a query string, the supplied LINQ expression will be added to the database query.
225225

226-
Note this directly influences the Entity Framework Core `IQueryable`. As opposed to using `OnApplyFilter`, this enables the full range of EF Core operators.
226+
Note this directly influences the Entity Framework Core `IQueryable`. As opposed to using `OnApplyFilter`, this enables the full range of Entity Framework Core operators.
227227
But it only works on primary resource endpoints (for example: /articles, but not on /blogs/1/articles or /blogs?include=articles).
228228

229229
```c#

docs/usage/resources/nullability.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ public sealed class User : Identifiable<int>
2020
}
2121
```
2222

23-
This makes EF Core generate non-nullable columns. And model errors are returned when nullable fields are omitted.
23+
This makes Entity Framework Core generate non-nullable columns. And model errors are returned when nullable fields are omitted.
2424

2525
# Reference types
2626

2727
When the [nullable reference types](https://docs.microsoft.com/en-us/dotnet/csharp/nullable-references) (NRT) compiler feature is enabled, it affects both ASP.NET ModelState validation and Entity Framework Core.
2828

2929
## NRT turned off
3030

31-
When NRT is turned off, use `[Required]` on required attributes and relationships. This makes EF Core generate non-nullable columns. And model errors are returned when required fields are omitted.
31+
When NRT is turned off, use `[Required]` on required attributes and relationships. This makes Entity Framework Core generate non-nullable columns. And model errors are returned when required fields are omitted.
3232

3333
Example:
3434

@@ -56,9 +56,9 @@ public sealed class Label : Identifiable<int>
5656

5757
## NRT turned on
5858

59-
When NRT is turned on, use nullability annotations (?) on attributes and relationships. This makes EF Core generate non-nullable columns. And model errors are returned when non-nullable fields are omitted.
59+
When NRT is turned on, use nullability annotations (?) on attributes and relationships. This makes Entity Framework Core generate non-nullable columns. And model errors are returned when non-nullable fields are omitted.
6060

61-
The [EF Core guidance on NRT](https://docs.microsoft.com/en-us/ef/core/miscellaneous/nullable-reference-types) recommends to use constructor binding to initialize non-nullable properties, but JsonApiDotNetCore does not support that. For required navigation properties, it suggests to use a non-nullable property with a nullable backing field. JsonApiDotNetCore does not support that either. In both cases, just use the null-forgiving operator (!).
61+
The [Entity Framework Core guide on NRT](https://docs.microsoft.com/en-us/ef/core/miscellaneous/nullable-reference-types) recommends to use constructor binding to initialize non-nullable properties, but JsonApiDotNetCore does not support that. For required navigation properties, it suggests to use a non-nullable property with a nullable backing field. JsonApiDotNetCore does not support that either. In both cases, just use the null-forgiving operator (!).
6262

6363
When ModelState validation is turned on, to-many relationships must be assigned an empty collection. Otherwise an error is returned when they don't occur in the request body.
6464

docs/usage/resources/relationships.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public sealed class AppDbContext : DbContext
5353
}
5454
```
5555

56-
Which results in EF Core generating the next database objects:
56+
Which results in Entity Framework Core generating the next database objects:
5757
```sql
5858
CREATE TABLE "Engine" (
5959
"Id" integer GENERATED BY DEFAULT AS IDENTITY,

0 commit comments

Comments
 (0)