Repository navigation
fix(bankfeeds)!: Describe V2 partial failures so apps can branch on error.type - #856
Open
illanonline wants to merge 1 commit into
Open
illanonline wants to merge 1 commit into
illanonline wants to merge 1 commit into
Conversation
illanonline
force-pushed
the
FWFEED-44954-v2-partial-failure-contract
branch
from
October 20, 2026 06:34
a88104c to
b473683
Compare
illanonline
changed the title
illanonline
marked this pull request as ready for review
October 23, 2026 02:13
illanonline
force-pushed
the
FWFEED-44954-v2-partial-failure-contract
branch
from
October 23, 2026 02:19
d463e0f to
fc82f6f
Compare
illanonline
changed the title
illanonline
force-pushed
the
FWFEED-44954-v2-partial-failure-contract
branch
from
October 23, 2026 02:23
fc82f6f to
ea57a25
Compare
| openapi: 3.0.0 | ||
| info: | ||
| version: 19.1.0 | ||
| version: 2.0.0 |
Contributor
There was a problem hiding this comment.
This should be left as-is, it is updated by the release automation.
Contributor
Author
There was a problem hiding this comment.
Thanks, that was a sync overwrite. info.version is back to 19.1.0 (the same as master) in dc5f186, and our sync script now leaves the target's version alone so it can't happen again. The same push also names oo-many-requests alongside internal-error as a REJECTED item with a 500 in the descriptions.
…rror.type - Replace the four partial-failure types with five that each fix one recovery action: partial-failure-new-account-creation, partial-failure-new-account-existence-not-confirmed, partial-failure-previous-connection-deletion, partial-failure-connection-creation and partial-failure-connection-deletion - Add optional subtype, and accountId, accountName and connectionId on the error, so apps don't need to read title or detail - Item errors have no status property; the item's statusCode is the number (new ItemError schema) - A REJECTED item means nothing was written, or Xero confirmed that nothing took effect; the 409 recovery rule applies to the three create types - Describe item-level internal-error (REJECTED, 500) and the 207 Multi-Status response BREAKING CHANGE: Bank Feeds 2.0 (Beta) partial-failure error types are renamed and a fifth is added. partial-failure-account-created-but-not-connected is now partial-failure-new-account-creation, partial-failure-migration-can-be-reattempted is now partial-failure-previous-connection-deletion, partial-failure-connection-created-but-not-recorded is now partial-failure-connection-creation, and partial-failure-delete-can-be-reattempted is now partial-failure-connection-deletion. A NewAccount item that used to come back as a REJECTED internal-error with an account-may-exist hint is now partial-failure-new-account-existence-not-confirmed. The error of an item in a 2.0 bulk write response no longer has a status property; use the item's statusCode. Apps that match on the old type values must update them. Bank Feeds 2.0 is pre-GA. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
illanonline
force-pushed
the
FWFEED-44954-v2-partial-failure-contract
branch
from
October 27, 2026 02:36
ea57a25 to
dc5f186
Compare
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.
Updates
xero_bankfeeds_v2.yaml(Bank Feeds 2.0) so that partners can branch onerror.typeto handle a partial failure, without parsingtitleordetail.BREAKING CHANGE
This is a breaking change for Bank Feeds 2.0 (Beta) partners who match on the old partial-failure
error.typevalues, and the commit is marked with!and aBREAKING CHANGE:footer. 2.0 is pre-GA, so the rename is made now rather than after release.partial-failure-account-created-but-not-connectedpartial-failure-new-account-creationpartial-failure-migration-can-be-reattemptedpartial-failure-previous-connection-deletionpartial-failure-connection-created-but-not-recordedpartial-failure-connection-creationpartial-failure-delete-can-be-reattemptedpartial-failure-connection-deletionREJECTEDinternal-errorwith an account-may-exist hint indetailpartial-failure-new-account-existence-not-confirmed(new)Also breaking for generated clients: the
errorof an item in a 2.0 bulk write response no longer has astatusproperty (the item'sstatusCodeis the number), so it uses a newItemErrorschema. Thetypeenum changes accordingly: the four old values are removed andpartial-failure-new-account-existence-not-confirmedis added.Partner-facing change
error.type:partial-failure-new-account-creation: don't resend. Connecterror.accountIdwith ExistingAccount.partial-failure-new-account-existence-not-confirmed(new, NewAccount): the account may have been created and its id is unknown. Check whether an account namederror.accountNameexists. Connect it with ExistingAccount if it does, otherwise resend the NewAccount item. If the app involves its user, it can send them back to account selection instead.partial-failure-*type: resend the same item.feed-already-connected-in-current-organisationon the recovery request for the three create types means the earlier attempt was recorded.subtype(diagnostics only), andaccountId,accountNameandconnectionIdas fields on the error.REJECTEDitem means nothing was written, or Xero confirmed that nothing took effect. A4xxitem is corrected before it is sent again; a500item can be resent as it is.internal-errorandtoo-many-requests(REJECTED, 500), and the207 Multi-Statuswording.Based on the up-to-date
master(the earlier Bank Feeds V2 spec PR #849 is merged). Nomanifest.jsonchange is needed. semantic-release will bump the version for the breaking marker.