Skip to content

Commit e3a1aa6

Browse files
committed
Updated docs
refs #31
1 parent 732e99d commit e3a1aa6

10 files changed

+16
-16
lines changed

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
### Objects:
44
* [Introduction](objects-introduction.md)
55
* [Document object](objects-document.md)
6-
* [Resource NullResource object](objects-resource-nullresource.md)
6+
* [Resource Null object](objects-resource-null.md)
77
* [Resource Identifier object](objects-resource-identifier.md)
88
* [Resource Item object](objects-resource-item.md)
99
* [Resource Collection object](objects-resource-collection.md)

docs/objects-document.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ _[Symbols definition](objects-introduction.md#symbols)_
1313

1414
| Key | Value | Note
1515
--- | ---- | ----- | ----
16-
# | data | - [Resource NullResource object](objects-resource-nullresource.md)<br />- [Resource Identifier object](objects-resource-identifier.md)<br />- [Resource Item object](objects-resource-item.md)<br />- [Resource Collection object](objects-resource-collection.md) | not allowed, if 'errors' exists
16+
# | data | - [Resource Null object](objects-resource-null.md)<br />- [Resource Identifier object](objects-resource-identifier.md)<br />- [Resource Item object](objects-resource-item.md)<br />- [Resource Collection object](objects-resource-collection.md) | not allowed, if 'errors' exists
1717
# | errors | [Error Collection object](objects-error-collection.md) | not allowed, if 'data' exists
1818
# | meta | [Meta object](objects-meta.md) |
1919
? | jsonapi | [Jsonapi object](objects-jsonapi.md) |

docs/objects-introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ All possible objects and their hierarchical structure are listed below.
1919
### All objects
2020

2121
1. [Document object](objects-document.md)
22-
1. [Resource NullResource object](objects-resource-nullresource.md)
22+
1. [Resource Null object](objects-resource-null.md)
2323
1. [Resource Identifier object](objects-resource-identifier.md)
2424
1. [Resource Item object](objects-resource-item.md)
2525
1. [Resource Collection object](objects-resource-collection.md)

docs/objects-relationship.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,5 @@ _[Symbols definition](objects-introduction.md#symbols)_
1515
| Key | Value | Note
1616
--- | ---- | ----- | ----
1717
# | links | [Relationship Link object](objects-relationship-link.md) |
18-
# | data | - [Resource NullResource object](objects-resource-nullresource.md)<br />- [Resource Identifier object](objects-resource-identifier.md)<br />- [Resource Identifier Collection object](objects-resource-identifier-collection.md) |
18+
# | data | - [Resource Null object](objects-resource-null.md)<br />- [Resource Identifier object](objects-resource-identifier.md)<br />- [Resource Identifier Collection object](objects-resource-identifier-collection.md) |
1919
# | meta | [Meta object](objects-meta.md) |

docs/objects-resource-collection.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Resource\Collection
1+
# ResourceCollection
22
[Back to Navigation](README.md)
33

44
## Description
55

6-
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).
6+
The `ResourceCollection` 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).
77

88
Property of:
99
- [Document object](objects-document.md)

docs/objects-resource-identifier-collection.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Resource\IdentifierCollection
1+
# ResourceIdentifierCollection
22
[Back to Navigation](README.md)
33

44
## Description
55

6-
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.
6+
The `ResourceIdentifierCollection` is a [Resource Collection object](objects-resource-collection.md) that is either empty or holds only [Resource Identifier object](objects-resource-identifier.md)s.
77

88
Property of:
99
- [Relationship object](objects-relationship.md)

docs/objects-resource-identifier.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Resource\Identifier
1+
# ResourceIdentifier
22
[Back to Navigation](README.md)
33

44
## Description
55

6-
The `Resource\Identifier` represents a [resource identifier object](http://jsonapi.org/format/#document-resource-identifier-objects).
6+
The `ResourceIdentifier` represents a [resource identifier object](http://jsonapi.org/format/#document-resource-identifier-objects).
77

88
Property of:
99
- [Document object](objects-document.md)

docs/objects-resource-item-link.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Resource\ItemLink
1+
# ResourceItemLink
22
[Back to Navigation](README.md)
33

44
## Description
55

6-
The `Resource\ItemLink` object represents a [links object inside a resource](http://jsonapi.org/format/#document-links).
6+
The `ResourceItemLink` object represents a [links object inside a resource](http://jsonapi.org/format/#document-links).
77

88
Property of:
99
- [Resource Item object](objects-resource-item.md)

docs/objects-resource-item.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Resource\Item
1+
# ResourceItem
22
[Back to Navigation](README.md)
33

44
## Description
55

6-
The `Resource\Item` represents a [resource object](http://jsonapi.org/format/#document-resource-objects).
6+
The `ResourceItem` represents a [resource object](http://jsonapi.org/format/#document-resource-objects).
77

88
Property of:
99
- [Document object](objects-document.md)

docs/objects-resource-nullresource.md renamed to docs/objects-resource-null.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# Resource\NullResource
1+
# ResourceNull
22
[Back to Navigation](README.md)
33

44
## Description
55

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

88
Property of:
99
- [Document object](objects-document.md)

0 commit comments

Comments
 (0)