Skip to content

Commit c184efe

Browse files
author
Bart Koelman
committed
Clarified documentation; fixed broken link
1 parent 78e09be commit c184efe

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

docs/usage/options.md

+3
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ options.MaximumPageNumber = new PageNumber(50);
3939
options.IncludeTotalResourceCount = true;
4040
```
4141

42+
To retrieve the total number of resources on secondary and relationship endpoints, the reverse of the relationship must to be available. For example, in `GET /customers/1/orders`, both the relationships `[HasMany] Customer.Orders` and `[HasOne] Order.Customer` must be defined.
43+
If `IncludeTotalResourceCount` is set to `false` (or the inverse relationship is unavailable on a non-primary endpoint), best-effort paging links are returned instead. This means no `last` link and the `next` link only occurs when the current page is full.
44+
4245
## Relative Links
4346

4447
All links are absolute by default. However, you can configure relative links.

docs/usage/resources/nullability.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Properties on a resource class can be declared as nullable or non-nullable. This affects both ASP.NET ModelState validation and the way Entity Framework Core generates database columns.
44

5-
ModelState validation is enabled by default since v5.0. In earlier versions, it can be enabled in [options](~/usage/options.md#enable-modelstate-validation).
5+
ModelState validation is enabled by default since v5.0. In earlier versions, it can be enabled in [options](~/usage/options.md#modelstate-validation).
66

77
# Value types
88

0 commit comments

Comments
 (0)