Skip to content

Commit c5a36f6

Browse files
Add version notes and interoperability warnings to documentation
Co-authored-by: bastianeicher <414366+bastianeicher@users.noreply.github.com>
1 parent 5179d57 commit c5a36f6

2 files changed

Lines changed: 6 additions & 0 deletions

File tree

docs/link-handling/link-header.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,9 @@ Link: </contacts{?name,email}>; rel="search"; templated=true
9393

9494
This combines the Link header mechanism with URI template support. While not part of RFC 8288, this extension provides a convenient way to express templated links without requiring HAL or another hypermedia format.
9595

96+
!!! warning
97+
The `templated=true` extension is not standard and may not be recognized by other HTTP clients or generic Link header parsers. If interoperability with non-TypedRest clients is important, consider using HAL for templated links instead.
98+
9699
When `templated=true` is present, use `LinkTemplate()` instead of `Link()`:
97100

98101
=== "C#"

docs/link-handling/serializers.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ To use the newer `System.Text.Json` serializer, install the `TypedRest.SystemTex
4343
dotnet add package TypedRest.SystemTextJson
4444
```
4545

46+
!!! note
47+
The `TypedRest.SystemTextJson` package version should match your main `TypedRest` package version. Both packages follow the same versioning scheme.
48+
4649
Then configure your endpoint:
4750

4851
=== "C#"

0 commit comments

Comments
 (0)