Skip to content

Commit

Permalink
Fixed: documentation for Related Records is broken #86
Browse files Browse the repository at this point in the history
  • Loading branch information
rizen committed Apr 11, 2024
1 parent 846f665 commit 8327611
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 5 deletions.
1 change: 1 addition & 0 deletions docs/change-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ outline: deep
* Updated existing code to use filesystem utils.
* Implemented: add warning when someone generates web or rest without a record #91
* Implemented: user id in statistics and add clipboard copy #88
* Fixed: documentation for Related Records is broken #86

## 2024-04-10
* Implemented: filterQualifier: true should be in the examples for all relation ids #96
Expand Down
6 changes: 1 addition & 5 deletions docs/subsystems/rest.md
Original file line number Diff line number Diff line change
Expand Up @@ -414,7 +414,7 @@ You can then in-turn call the URI provided by each relationship to fetch the ite
Likewise you can request related objects (those with relationship type of parent) be included directly in the result by adding the name of the related record relationship like `includeRelated=user as a parameter:

```
GET /article/xxx?includeRelated=user&includeMeta=true
GET /article/xxx?includeRelated=user
```

Response:
Expand All @@ -432,10 +432,6 @@ Response:
"props" : {
"id" : "xxx",
...
},
"meta" : {
"displayName" : "Andy Dufresne",
...
}
}
}
Expand Down

0 comments on commit 8327611

Please sign in to comment.