ahtlon/deck
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update API.md

Browse Source 
Just some minor text improvements.
This commit is contained in:
Andrew
2020-05-25 17:52:41 +10:00
committed by GitHub
parent 69b0c8ba39
commit 5f3fc11b46
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/API.md
View File

@@ -1,5 +1,5 @@
The REST API provides access for authenticated users to their data inside the Deck app. To get a better understand of Decks data models and their relations, please have a look at the [data structure](structure.md) documentation.
The REST API provides access for authenticated users to their data inside the Deck app. To get a better understanding of Decks data models and their relations, please have a look at the [data structure](structure.md) documentation.
# Prequisited
@@ -687,7 +687,7 @@ The request can fail with a bad request response for the following reasons:
- The user is not part of the board
### PUT /boards/{boardId}/stacks/{stackId}/cards/{cardId}/unassignUser - Assign a user to a card
### PUT /boards/{boardId}/stacks/{stackId}/cards/{cardId}/unassignUser - Unassign a user from a card
#### Request parameters
@@ -701,7 +701,7 @@ The request can fail with a bad request response for the following reasons:
| Parameter | Type | Description |
| --------- | ------- | --------------------------------------- |
| userId | String | The user id to assign to the card |
| userId | String | The user id to unassign from the card |
#### Response
@@ -947,7 +947,7 @@ For now only `deck_file` is supported as an attachment type.
# OCS API
The following endpoints are available tough the Nextcloud OCS endpoint, which is available at `/ocs/v2.php/apps/deck/api/v1.0/`.
The following endpoints are available through the Nextcloud OCS endpoint, which is available at `/ocs/v2.php/apps/deck/api/v1.0/`.
This has the benefit that both the web UI as well as external integrations can use the same API.
## Comments