Skip to content

Commit 7731785

Browse files
committed
Updated docs and CHANGELOG.md
[ci skip]
1 parent 7c60cd6 commit 7731785

6 files changed

+32
-6
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
55

66
## [Unreleased]
77

8+
### Added
9+
10+
- New `Resource\ItemLink` object; was seperated from `Link` object
11+
12+
### Fixed
13+
14+
- links and pagination are now parsed spec conform, see [#23](https://github.com/Art4/json-api-client/pull/23)
15+
816
## [0.6] - 2015-11-06
917

1018
### Added

docs/objects-document-link.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,4 @@ _[Symbols definition](objects-introduction.md#symbols)_
2020
? | last | - `null`<br />- `string` |
2121
? | prev | - `null`<br />- `string` |
2222
? | next | - `null`<br />- `string` |
23-
? | meta | [Meta object](objects-meta.md) |
2423
* | `string` | - `string`<br />- [Link object](objects-link.md) |

docs/objects-introduction.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ All possible objects and their hierarchical structure are listet below.
3232
1. [Error Source object](objects-error-source.md)
3333
1. [Link object](objects-link.md)
3434
1. [Document Link object](objects-document-link.md)
35+
1. [Resource Item Link object](objects-resource-item-link.md)
3536
1. [Relationship Link object](objects-relationship-link.md)
3637
1. [Error Link object](objects-error-link.md)
3738
1. [Jsonapi object](objects-jsonapi.md)

docs/objects-link.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@
66
The `Link` object represents a [links object](http://jsonapi.org/format/#document-links).
77

88
Property of:
9-
- [Resource Item object](objects-resource-item.md)
10-
- [Link object](objects-link.md)
9+
- [Document Link object](objects-document-link.md)
10+
- [Resource Item Link object](objects-resource-item-link.md)
11+
- [Relationship Link object](objects-relationship-link.md)
1112
- [Error Link object](objects-error-link.md)
1213

1314
### Properties
@@ -16,6 +17,5 @@ _[Symbols definition](objects-introduction.md#symbols)_
1617

1718
| Key | Value | Note
1819
--- | ---- | ----- | ----
19-
* | `string` | - `string`<br />- [Link object](objects-link.md) |
20-
? | href | `string` |
20+
1 | href | `string` |
2121
? | meta | [Meta object](objects-meta.md) |

docs/objects-relationship-link.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,4 @@ _[Symbols definition](objects-introduction.md#symbols)_
2020
? | last | - `null`<br />- `string` | Only exists if the parent relationship object represents a to-many relationship |
2121
? | prev | - `null`<br />- `string` | Only exists if the parent relationship object represents a to-many relationship |
2222
? | next | - `null`<br />- `string` | Only exists if the parent relationship object represents a to-many relationship |
23-
? | meta | [Meta object](objects-meta.md) |
2423
* | `string` | - `string`<br />- [Link object](objects-link.md) |

docs/objects-resource-item-link.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# ResourceItemLink
2+
[Back to Navigation](README.md)
3+
4+
## Description
5+
6+
The `ResourceItemLink` object represents a [links object inside a resource](http://jsonapi.org/format/#document-links).
7+
8+
Property of:
9+
- [Resource Item object](objects-resource-item.md)
10+
11+
### Properties
12+
13+
_[Symbols definition](objects-introduction.md#symbols)_
14+
15+
| Key | Value | Note
16+
--- | ---- | ----- | ----
17+
? | self | `string` |
18+
? | related | - `string`<br />- [Link object](objects-link.md) |
19+
* | `string` | - `string`<br />- [Link object](objects-link.md) |

0 commit comments

Comments
 (0)