Create board: Make labels and stacks optional for REST API
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 1.4k
- Forks
- 354
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 43
Description
How to use GitHub
- Please use the 👍 reaction to show that you are affected by the same issue.
- Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this issue.
- Subscribe to receive notifications on status change and new comments.
Is your feature request related to a problem? Please describe.
For the Android app, we want to implement the "Clone board" feature. The problem here is, that the endpoint for creating boards is also creating the default labels and stacks aka lists. Since we have kind-of offline capabilities, I'd like to clone the board locally and sync it any time after that.
The problem here is, that if the createBoard is fired (which has to happen first), the server already creates the labels and stacks. When i try to created the labels, the following might happen:
{"status":400,"message":"title must be unique"}
Spock would say: "logical.". The default labels might still be there in the cloned board.
Describe the solution you'd like
What about some fancy optional query params? Something like this:
curl -X GET 'https://<user>:<password>@<domain/index.php/apps/deck/api/v1.0/boards?sampleTags=false&sampleStacks=false' -H 'Accept: application/json' -H 'OCS-APIRequest: true' -H 'Content-Type: application/json;charset=utf-8' | jq
Describe alternatives you've considered
Deleting the samples right after creation. But I think captain obvious knows, why this is only a workaround.
CC:
@stefan-niedermann
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 at the REST API createBoard endpoint and trace how board creation adds the default labels and stacks. Check the existing board-creation behavior and API request handling, then verify that optional controls can suppress those defaults for cloning while normal creation remains unchanged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100