Skip to content

[ENG-4255] docs(notifications): write.async.done sends error string instead of errors array #741

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jlimatampersand wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[ENG-4255] docs(notifications): write.async.done sends error string instead of errors array #741

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/notifications/notification-payloads.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,8 +344,7 @@ Note: `error` describes what went wrong during the triggered read.
"consumerName": "John Doe",
"objectName": "Account",
"success": true,
"successfulRecordIds": ["provider-record-id-1", "provider-record-id-2"],
"errors": []
"successfulRecordIds": ["provider-record-id-1", "provider-record-id-2"]
}
}
```
Expand All @@ -365,12 +364,13 @@ Note: `error` describes what went wrong during the triggered read.
"consumerName": "John Doe",
"objectName": "Account",
"success": true,
"successfulRecordIds": ["provider-record-id-1", "provider-record-id-2"],
"errors": []
"successfulRecordIds": ["provider-record-id-1", "provider-record-id-2"]
}
```

Note: For partial failures, `success` is `false` with both `successfulRecordIds` and `errors` populated.
Note: `error` is only present when the write failed. For partial failures, `success` is `false` with both
`successfulRecordIds` and `error` populated; when several records fail, their messages are joined into a
single string, for example `"field validation failed; duplicate record"`.
</Accordion>

<Accordion title="subscribe.create.success">
Expand Down
Loading