Skip to content
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.

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

Document that using the sourceData header is not supported #76

Open
Nephery opened this issue Feb 25, 2021 · 0 comments
Open

Document that using the sourceData header is not supported #76

Nephery opened this issue Feb 25, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Nephery
Copy link
Collaborator

Nephery commented Feb 25, 2021

When ErrorMessages are published to error channels, we include the sourceData header to contain the raw XMLMessage.

The README should be updated to indicate that users must not use the sourceData header in their application code. This object is owned by the binder, NOT the application.

It is only provided in the ErrorMessage for debugging purposes, and modifying or performing actions on this object is not supported and may result in the binder failing to process messages and handle errors.

@Nephery Nephery added the documentation Improvements or additions to documentation label Feb 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant