API: Missing documentation for reordering cards
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1.4k
- Forks
- 354
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 43
Description
The docs at https://deck.readthedocs.io/en/latest/API/ are missing documentation for the reorder endpoint (.../boards/{boardId}/stacks/{stackId}/cards/{cardId}/reorder). From the docs, it is not clear how 3rd party apps should implement drag-and-drop reordering, specifically:
- Changing the order of a card in a stack
- Moving a card from another stack to a specific position in the new stack
Assuming, that the request body should look like this
| name | type |
|---|---|
| order | number |
| stackId | number |
it is unclear, how the "order" should be estimated. Simply using a number between the orders of the two cards that the new card should be inserted does not work.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the API documentation at https://deck.readthedocs.io/en/latest/API/ and inspect the reorder endpoint /boards/{boardId}/stacks/{stackId}/cards/{cardId}/reorder. Document the request fields and ordering semantics for reordering within a stack and moving a card between stacks, including what a third-party app needs for drag-and-drop behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100