REST API Docs: missing parameter in "update cards"
Open
Nobody has claimed this yet.
docs
feature: api
technical debt
- Dominant language
- JavaScript
- Stars
- 1.4k
- Forks
- 354
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 43
Description
Hi,
It seems like the REST API docs are missing a parameter for the request body when updating a Card:
listed parameters:
| Paramter | Type | Description |
|---|---|---|
| title | String | The title of the card, maximum length is limited to 255 characters |
| type | String | Type of the card (for later use) use 'plain' for now |
| order | Integer | Order for sorting the stacks |
| description | String | (optional) The markdown description of the card |
| duedate | timestamp | (optional) The duedate of the card or null |
missing parameter:
| Paramter | Type | Description |
|---|---|---|
| owner | Dict | "owner": {"primaryKey": "admin", "uid": "admin", "displayname": "Administrator"} |
Sorry if I am wrong here!
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 REST API documentation's Cards section at the linked API page and compare the update-card request body with the documented parameters. Document the owner parameter with its type and example, and consider the issue done when the update-card body lists all supported parameters accurately.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100