Skip to content

Commit 710b06d

Browse files
committed
docs: link methods in Etag section
Signed-off-by: Viktor Diezel <viktor.diezel@posteo.de>
1 parent 732e2b4 commit 710b06d

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

docs/API.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -101,14 +101,14 @@ curl -u admin:admin -X GET \
101101

102102
An ETag header is returned in order to determine if further child elements have been updated for the following endpoints:
103103

104-
- Fetch all user board `GET /api/v1.0/boards`
105-
- Fetch a single board `GET /api/v1.0/boards/{boardId}`
106-
- Fetch all stacks of a board `GET /api/v1.0/boards/{boardId}/stacks`
107-
- Fetch a single stacks of a board `GET /api/v1.0/boards/{boardId}/stacks/{stackId}`
108-
- Fetch a single card of a board `GET /api/v1.0/boards/{boardId}/stacks/{stackId}/cards/{cardId}`
109-
- Fetch attachments of a card `GET /api/v1.0/boards/{boardId}/stacks/{stackId}/cards/{cardId}/attachments`
110-
111-
If a `If-None-Match` header is provided and the requested element has not changed a `304` Not Modified response will be returned.
104+
- [List user boards](#list-boards)
105+
- [Get board by ID](#get-board)
106+
- [List board stacks](#list-stacks)
107+
- [Get stack by ID](#get-stack)
108+
- [Get card by ID](#get-card)
109+
- [List card attachments](#list-attachments)
110+
111+
If a `If-None-Match` header is provided and the requested element has not changed a `304 Not Modified` response will be returned.
112112

113113
Changes of child elements will propagate to their parents and also cause an update of the ETag which will be useful for determining if a sync is necessary on any client integration side. As an example, if a label is added to a card, the ETag of all related entities (the card, stack and board) will change.
114114

0 commit comments

Comments
 (0)