Card steps and cards: partial updates - #431
Merged
Merged
Conversation
Updating a step or a card no longer clears the parameters you omit. An omitted parameter is left unchanged; send "due_on": null to clear the due date and "assignee_ids": [] to remove all assignees. A step's title is now optional on update.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updating a card table step or card is becoming a true partial update on the JSON API: parameters you omit are left unchanged, instead of being cleared.
Steps (
PUT /card_tables/steps/{id}.json): previously this update replaced the whole step — any oftitle,due_on, orassignee_idsyou omitted was cleared, andtitlewas required. Now each of them may be omitted independently and keeps its current value.Cards (
PUT /card_tables/cards/{id}.json): previously omittingdue_oncleared the card's due date even when you only meant to change something else. Now an omitteddue_onis left unchanged, matching the other parameters.To clear a value, send it explicitly:
"due_on": null"assignee_ids": []Creating a step is unchanged:
titleis still required.These docs describe the new behavior and will merge when it reaches production.
Synced from bc3
doc/api/byscript/api/sync_to_bc3_api— not a hand-edit.