Skip to content

Commit dab463f

Browse files
committed
make the docs cleaner
1 parent b1d4215 commit dab463f

19 files changed

+53
-77
lines changed

docs/objects-attributes.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,16 @@
55

66
The `Attributes` object represents the [attributes object](http://jsonapi.org/format/#document-resource-object-attributes) of a resource object.
77

8-
- extends: [Meta object](objects-meta.md)
9-
- extended by:
10-
- property of: [Resource Item object](objects-resource-item.md)
8+
Property of:
9+
- [Resource Item object](objects-resource-item.md)
1110

1211
### Properties
1312

1413
_[Symbols definition](objects-introduction.md#symbols)_
1514

1615
| Key | Value | Note
1716
--- | ---- | ----- | ----
18-
* | `string` | mixed |
17+
* | `string` | `mixed` |
1918
! | type | | already used in [Resource Item object](objects-resource-item.md) |
2019
! | id | | already used in [Resource Item object](objects-resource-item.md) |
2120
! | relationships | | reserved by spec for future use |

docs/objects-document-link.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@
55

66
The `DocumentLink` represents a [links object inside the top level document](http://jsonapi.org/format/#document-top-level).
77

8-
- extends: [Link object](objects-link.md)
9-
- extended by:
10-
- property of: [Document object](objects-document.md)
8+
Property of:
9+
- [Document object](objects-document.md)
1110

1211
### Properties
1312

docs/objects-document.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@
55

66
The `Document` object represents the [Top Level](http://jsonapi.org/format/#document-top-level) of a JSON API response. You can create it using [Utils\Helper](utils-helper.md).
77

8-
- extends:
9-
- extended by:
10-
- property of:
8+
Property of: _none_
119

1210
### Properties
1311

docs/objects-error-collection.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@
55

66
The `ErrorCollection` represents [an array of error objects](http://jsonapi.org/format/#error-objects).
77

8-
- extends:
9-
- extended by:
10-
- property of: [Document object](objects-document.md)
8+
Property of:
9+
- [Document object](objects-document.md)
1110

1211
### Properties
1312

docs/objects-error-link.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@
55

66
The `ErrorLink` represents a [links object inside an error object](http://jsonapi.org/format/#error-objects).
77

8-
- extends: [Link object](objects-link.md)
9-
- extended by:
10-
- property of: [Error object](objects-error.md)
8+
Property of:
9+
- [Error object](objects-error.md)
1110

1211
### Properties
1312

docs/objects-error-source.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@
55

66
The `ErrorSource` object represents the [error source object](http://jsonapi.org/format/#error-objects) inside an error object.
77

8-
- extends:
9-
- extended by:
10-
- property of: [Error object](objects-error.md)
8+
Property of:
9+
- [Error object](objects-error.md)
1110

1211
### Properties
1312

docs/objects-error.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@
55

66
The `Error` object represents the [error object](http://jsonapi.org/format/#error-objects).
77

8-
- extends:
9-
- extended by:
10-
- property of: [Error Collection object](objects-error-collection.md)
8+
Property of:
9+
- [Error Collection object](objects-error-collection.md)
1110

1211
### Properties
1312

docs/objects-jsonapi.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@
55

66
The `Jsonapi` object represents a [jsonapi object](http://jsonapi.org/format/#document-links) inside the top level document object.
77

8-
- extends:
9-
- extended by:
10-
- property of: [Document object](objects-document.md)
8+
Property of:
9+
- [Document object](objects-document.md)
1110

1211
### Properties
1312

docs/objects-link.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,10 @@
55

66
The `Link` object represents a [links object](http://jsonapi.org/format/#document-links).
77

8-
- extends:
9-
- extended by:
10-
- [Document Link object](objects-document-link.md)
11-
- [Relationship Link object](objects-relationship-link.md)
12-
- [Error Link object](objects-error-link.md)
13-
- [Pagination Link object](objects-pagination-link.md)
14-
- property of:
15-
- [Resource Item object](objects-resource-item.md)
16-
- [Link object](objects-link.md)
17-
- [Error Link object](objects-error-link.md)
8+
Property of:
9+
- [Resource Item object](objects-resource-item.md)
10+
- [Link object](objects-link.md)
11+
- [Error Link object](objects-error-link.md)
1812

1913
### Properties
2014

docs/objects-meta.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,13 @@
55

66
The `Meta` object represents a [meta object](http://jsonapi.org/format/#document-meta).
77

8-
- extends:
9-
- extended by: [Attributes object](objects-attributes.md)
10-
- property of:
11-
- [Document object](objects-document.md)
12-
- [Resource Identifier object](objects-resource-identifier.md)
13-
- [Relationship object](objects-relationship.md)
14-
- [Error object](objects-error.md)
15-
- [Link object](objects-link.md)
16-
- [Jsonapi object](objects-jsonapi.md)
8+
Property of:
9+
- [Document object](objects-document.md)
10+
- [Resource Identifier object](objects-resource-identifier.md)
11+
- [Relationship object](objects-relationship.md)
12+
- [Error object](objects-error.md)
13+
- [Link object](objects-link.md)
14+
- [Jsonapi object](objects-jsonapi.md)
1715

1816
### Properties
1917

docs/objects-pagination-link.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,9 @@
55

66
The `PaginationLink` represents a [pagination object](http://jsonapi.org/format/#fetching-pagination).
77

8-
- extends: [Link object](objects-link.md)
9-
- extended by:
10-
- property of:
11-
- [Document Link object](objects-document-link.md)
12-
- [Relationship Link object](objects-relationship-link.md)
8+
Property of:
9+
- [Document Link object](objects-document-link.md)
10+
- [Relationship Link object](objects-relationship-link.md)
1311

1412
### Properties
1513

docs/objects-relationship-collection.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@
55

66
The `RelationshipCollection` object represents the [an object that holds the relationship objects](http://jsonapi.org/format/#document-resource-object-relationships) from a resource object.
77

8-
- extends:
9-
- extended by:
10-
- property of: [Resource Item object](objects-resource-item.md)
8+
Property of:
9+
- [Resource Item object](objects-resource-item.md)
1110

1211
### Properties
1312

docs/objects-relationship-link.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@
55

66
The `RelationhipLink` represents a [links object inside a relationship object](http://jsonapi.org/format/#document-resource-object-relationships).
77

8-
- extends: [Link object](objects-link.md)
9-
- extended by:
10-
- property of: [Relationship object](objects-relationship.md)
8+
Property of:
9+
- [Relationship object](objects-relationship.md)
1110

1211
### Properties
1312

docs/objects-relationship.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@
55

66
The `Relationship` object represents the [relationship object](http://jsonapi.org/format/#document-resource-object-relationships) inside a relationship collection.
77

8-
- extends:
9-
- extended by:
10-
- property of: [Relationship Collection object](objects-relationship-collection.md)
8+
Property of:
9+
- [Relationship Collection object](objects-relationship-collection.md)
1110

1211
### Properties
1312

docs/objects-resource-collection.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@
55

66
The `Resource\Collection` represents [an array of resource objects, an array of resource identifier objects, or an empty array, for requests that target resource collections](http://jsonapi.org/format/#document-top-level). It implements the `Resource\ResourceInterface`.
77

8-
- extends:
9-
- extended by: [Resource Identifier Collection object](objects-resource-identifier-collection.md)
10-
- property of: [Document object](objects-document.md)
8+
Property of:
9+
- [Document object](objects-document.md)
1110

1211
### Properties
1312

docs/objects-resource-identifier-collection.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@
55

66
The `Resource\IdentifierCollection` is a [Resource Collection object](objects-resource-collection.md) that is either empty or holds only [Resource Identifier object](objects-resource-identifier.md)s. It implements the `Resource\ResourceInterface`.
77

8-
- extends: [Resource Collection object](objects-resource-collection.md)
9-
- extended by:
10-
- property of: [Relationship object](objects-relationship.md)
8+
Property of:
9+
- [Relationship object](objects-relationship.md)
1110

1211
### Properties
1312

docs/objects-resource-identifier.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,10 @@
55

66
The `Resource\Identifier` represents a [resource identifier object](http://jsonapi.org/format/#document-resource-identifier-objects). It implements the `Resource\ResourceInterface`.
77

8-
- extends:
9-
- extended by: [Resource Item object](objects-resource-item.md)
10-
- property of:
11-
- [Document object](objects-document.md)
12-
- [Relationship object](objects-relationship.md)
8+
Property of:
9+
- [Document object](objects-document.md)
10+
- [Relationship object](objects-relationship.md)
11+
- [Resource Identifier Collection object](objects-resource-identifier-collection.md)
1312

1413
### Properties
1514

docs/objects-resource-item.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,19 @@
55

66
The `Resource\Item` represents a [resource object](http://jsonapi.org/format/#document-resource-objects). It implements the `Resource\ResourceInterface`.
77

8-
- extends: [Resource Identifier object](objects-resource-identifier.md)
9-
- extended by:
10-
- property of: [Document object](objects-document.md)
8+
Property of:
9+
- [Document object](objects-document.md)
10+
- [Resource Collection object](objects-resource-collection.md)
1111

1212
### Properties
1313

1414
_[Symbols definition](objects-introduction.md#symbols)_
1515

1616
| Key | Value | Note
1717
--- | ---- | ----- | ----
18+
1 | type | `string` |
19+
1 | id | `string` |
20+
? | meta | [Meta object](objects-meta.md) |
1821
? | attributes | [Attributes object](objects-attributes.md) |
1922
? | relationships | [Relationship Collection object](objects-relationship-collection.md) |
2023
? | links | [Link object](objects-link.md) |

docs/objects-resource-nullresource.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,9 @@
55

66
The `Resource\NullResource` represents a [`null` inside the top level data](http://jsonapi.org/format/#document-top-level). It implements the `Resource\ResourceInterface`.
77

8-
- extends:
9-
- extended by:
10-
- property of:
11-
- [Document object](objects-document.md)
12-
- [Relationship object](objects-relationship.md)
8+
Property of:
9+
- [Document object](objects-document.md)
10+
- [Relationship object](objects-relationship.md)
1311

1412
### Properties
1513

0 commit comments

Comments
 (0)