Skip to content

Commit 24baadd

Browse files
committed
try to make headers unique
1 parent 8d18be6 commit 24baadd

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -146,11 +146,11 @@ An `Entity` needs to be specialized on four generic types. The first is the `Ent
146146

147147
#### `Meta`
148148

149-
The second generic specialization on `Entity` is `Meta`. This is described in its own section [below](#meta). All `Meta` at any level of a JSON API Document follow the same rules.
149+
The second generic specialization on `Entity` is `Meta`. This is described in its own section [below](#jsonapi.meta). All `Meta` at any level of a JSON API Document follow the same rules.
150150

151151
#### `Links`
152152

153-
The third generic specialization on `Entity` is `Links`. This is described in its own section [below](#links). All `Links` at any level of a JSON API Document follow the same rules, although the **SPEC** makes different suggestions as to what types of links might live on which parts of the Document.
153+
The third generic specialization on `Entity` is `Links`. This is described in its own section [below](#jsonnapi.links). All `Links` at any level of a JSON API Document follow the same rules, although the **SPEC** makes different suggestions as to what types of links might live on which parts of the Document.
154154

155155
#### `IdType`
156156

@@ -322,7 +322,7 @@ You can always use `NoMetadata` if this JSON API feature is not needed.
322322

323323
#### `LinksType`
324324

325-
The third generic type of a `JSONAPIDocument` is a `Links` struct. `Links` are described in their own section [below](#links).
325+
The third generic type of a `JSONAPIDocument` is a `Links` struct. `Links` are described in their own section [below](#jsonapi.links).
326326

327327
#### `IncludeType`
328328

@@ -346,19 +346,19 @@ You can supply any `JSONAPI.Meta` type as the metadata type of the API descripti
346346

347347
The final generic type of a `JSONAPIDocument` is the `Error`. You should create an error type that can decode all the errors you expect your `JSONAPIDocument` to be able to decode. As prescribed by the **SPEC**, these errors will be found in the root document member `errors`.
348348

349-
### `Meta`
349+
### `JSONAPI.Meta`
350350

351351
A `Meta` struct is totally open-ended. It is described by the **SPEC** as a place to put any information that does not fit into the standard JSON API Document structure anywhere else.
352352

353353
You can specify `NoMetadata` if the part of the document being described should not contain any `Meta`.
354354

355-
### `Links`
355+
### `JSONAPI.Links`
356356

357357
A `Links` struct must contain only `Link` properties. Each `Link` property can either be a `URL` or a `URL` and some `Meta`. Each part of the document has some suggested common `Links` to include but generally any link can be included.
358358

359359
You can specify `NoLinks` if the part of the document being described should not contain any `Links`.
360360

361-
### `RawIdType`
361+
### `JSONAPI.RawIdType`
362362

363363
If you want to create new `JSONAPI.Entity` values and assign them Ids then you will need to conform at least one type to `CreatableRawIdType`. Doing so is easy; here are two example conformances for `UUID` and `String` (via `UUID`):
364364
```

0 commit comments

Comments
 (0)