Skip to content

Commit c94a5d2

Browse files
committed
Added symbols definition
1 parent 5d2796f commit c94a5d2

19 files changed

+38
-0
lines changed

docs/objects-attributes.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ The `Attributes` object represents the [attributes object](http://jsonapi.org/fo
1111

1212
### Properties
1313

14+
_[Symbols definition](objects-introduction.md#symbols)_
15+
1416
| Key | Value | Note
1517
--- | ---- | ----- | ----
1618
* | `string` | mixed |

docs/objects-document-link.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ The `DocumentLink` represents a [links object inside the top level document](htt
1111

1212
### Properties
1313

14+
_[Symbols definition](objects-introduction.md#symbols)_
15+
1416
| Key | Value | Note
1517
--- | ---- | ----- | ----
1618
? | self | `string` |

docs/objects-document.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ The `Document` object represents the [Top Level](http://jsonapi.org/format/#docu
1111

1212
### Properties
1313

14+
_[Symbols definition](objects-introduction.md#symbols)_
15+
1416
| Key | Value | Note
1517
--- | ---- | ----- | ----
1618
# | 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

docs/objects-error-collection.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ The `ErrorCollection` represents [an array of error objects](http://jsonapi.org/
1111

1212
### Properties
1313

14+
_[Symbols definition](objects-introduction.md#symbols)_
15+
1416
| Key | Value | Note
1517
--- | ---- | ----- | ----
1618
+ | `integer` | [Error object](objects-error.md) |

docs/objects-error-link.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ The `ErrorLink` represents a [links object inside an error object](http://jsonap
1111

1212
### Properties
1313

14+
_[Symbols definition](objects-introduction.md#symbols)_
15+
1416
| Key | Value | Note
1517
--- | ---- | ----- | ----
1618
1 | about | - `string`<br />- [Link object](objects-link.md) |

docs/objects-error-source.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ The `ErrorSource` object represents the [error source object](http://jsonapi.org
1111

1212
### Properties
1313

14+
_[Symbols definition](objects-introduction.md#symbols)_
15+
1416
| Key | Value | Note
1517
--- | ---- | ----- | ----
1618
? | pointer | `string` |

docs/objects-error.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ The `Error` object represents the [error object](http://jsonapi.org/format/#erro
1111

1212
### Properties
1313

14+
_[Symbols definition](objects-introduction.md#symbols)_
15+
1416
| Key | Value | Note
1517
--- | ---- | ----- | ----
1618
? | id | `string` |

docs/objects-introduction.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ All possible objects and their hierarchical structure are listet below.
77

88
### Symbols
99

10+
_[Symbols definition](objects-introduction.md#symbols)_
11+
1012
| Symbol | Description |
1113
| ------ | ----------- |
1214
| # | at least one of these properties is required |

docs/objects-jsonapi.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ The `Jsonapi` object represents a [jsonapi object](http://jsonapi.org/format/#do
1111

1212
### Properties
1313

14+
_[Symbols definition](objects-introduction.md#symbols)_
15+
1416
| Key | Value | Note
1517
--- | ---- | ----- | ----
1618
? | version | `string` | Default: `"1.0"`

docs/objects-link.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ The `Link` object represents a [links object](http://jsonapi.org/format/#documen
1818

1919
### Properties
2020

21+
_[Symbols definition](objects-introduction.md#symbols)_
22+
2123
| Key | Value | Note
2224
--- | ---- | ----- | ----
2325
* | `string` | - `string`<br />- [Link object](objects-link.md) |

docs/objects-meta.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ The `Meta` object represents a [meta object](http://jsonapi.org/format/#document
1717

1818
### Properties
1919

20+
_[Symbols definition](objects-introduction.md#symbols)_
21+
2022
| Key | Value | Note
2123
--- | ---- | ----- | ----
2224
* | `string` | `mixed` |

docs/objects-pagination-link.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ The `PaginationLink` represents a [pagination object](http://jsonapi.org/format/
1313

1414
### Properties
1515

16+
_[Symbols definition](objects-introduction.md#symbols)_
17+
1618
| Key | Value | Note
1719
--- | ---- | ----- | ----
1820
? | first | - `null`<br />- `string` |

docs/objects-relationship-collection.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ The `RelationshipCollection` object represents the [an object that holds the rel
1111

1212
### Properties
1313

14+
_[Symbols definition](objects-introduction.md#symbols)_
15+
1416
| Key | Value | Note
1517
--- | ---- | ----- | ----
1618
* | `string` | [Relationship object](objects-relationship.md) | not allowed, if already used in parents [Attributes object](objects-attributes.md) property)

docs/objects-relationship-link.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ The `RelationhipLink` represents a [links object inside a relationship object](h
1111

1212
### Properties
1313

14+
_[Symbols definition](objects-introduction.md#symbols)_
15+
1416
| Key | Value | Note
1517
--- | ---- | ----- | ----
1618
# | self | `string` |

docs/objects-relationship.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ The `Relationship` object represents the [relationship object](http://jsonapi.or
1111

1212
### Properties
1313

14+
_[Symbols definition](objects-introduction.md#symbols)_
15+
1416
| Key | Value | Note
1517
--- | ---- | ----- | ----
1618
# | links | [Relationship Link object](objects-relationship-link.md) |

docs/objects-resource-collection.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ The `Resource\Collection` represents [an array of resource objects, an array of
1313

1414
### Properties
1515

16+
_[Symbols definition](objects-introduction.md#symbols)_
17+
1618
| Key | Value | Note
1719
--- | ---- | ----- | ----
1820
* | `integer` | - [Resource Identifier object](objects-resource-identifier.md)<br />- [Resource Item object](objects-resource-item.md) | Contains only [Resource Identifier object](objects-resource-identifier.md), if the collection is a property of a [Relationship object](objects-relationship.md)

docs/objects-resource-identifier.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ The `Resource\Identifier` represents a [resource identifier object](http://jsona
1313

1414
### Properties
1515

16+
_[Symbols definition](objects-introduction.md#symbols)_
17+
1618
| Key | Value | Note
1719
--- | ---- | ----- | ----
1820
1 | type | `string` |

docs/objects-resource-item.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ The `Resource\Item` represents a [resource object](http://jsonapi.org/format/#do
1111

1212
### Properties
1313

14+
_[Symbols definition](objects-introduction.md#symbols)_
15+
1416
| Key | Value | Note
1517
--- | ---- | ----- | ----
1618
? | attributes | [Attributes object](objects-attributes.md) |

docs/objects-resource-nullresource.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ The `Resource\NullResource` represents a [`null` inside the top level data](http
1313

1414
### Properties
1515

16+
_[Symbols definition](objects-introduction.md#symbols)_
17+
1618
| Key | Value | Note
1719
--- | ---- | ----- | ----
1820
_This object has no properties._

0 commit comments

Comments
 (0)