Skip to content

Commit

Permalink
Update recommendations to account for relationships object
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanresnick authored and dgeb committed May 19, 2015
1 parent 68bc78b commit 33f61a7
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions recommendations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,28 +61,28 @@ As described in the base specification, there are two URLs that can be exposed
for each relationship:

* the "relationship URL" - a URL for the relationship itself, which is
identified with the `"self"` key in a link object. This URL allows the
identified with the `"self"` key in a relationship object. This URL allows the
client to directly manipulate the relationship. For example, it would allow
a client to remove an `author` from a `post` without deleting the `people`
resource itself.

* the "related resource URL" - a URL for the related resource(s), which is
identified with the `"related"` key within a link object. When fetched, it
identified with the `"related"` key within a relationship object. When fetched, it
returns the related resource object(s) as the response's primary data.

It is recommended that a relationship URL be formed by appending `/links/` and
the name of the relationship to the resource's URL.
It is recommended that a relationship URL be formed by appending `/relationships/`
and the name of the relationship to the resource's URL.

For example, a photo's `comments` relationship will have the URL:

```text
/photos/1/links/comments
/photos/1/relationships/comments
```

And a photo's `photographer` relationship will have the URL:

```text
/photos/1/links/photographer
/photos/1/relationships/photographer
```

It is recommended that a related resource URL be formed by appending the name
Expand Down

0 comments on commit 33f61a7

Please sign in to comment.