-
Notifications
You must be signed in to change notification settings - Fork 26
DOCSP-46065: GUID serialization breaking change note #439
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
Conversation
✅ Deploy Preview for docs-csharp ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
source/upgrade/v3.txt
Outdated
|
||
- The driver requires applications to explicitly configure how to serialize GUIDs | ||
by using the ``GuidSerializationProvider`` and ``ObjectSerializer`` classes. To learn | ||
more about GUID serialization, see :ref:`<csharp-guids>`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
more about GUID serialization, see :ref:`<csharp-guids>`. | |
more about GUID serialization, see the :ref:`csharp-guids` guide. |
source/upgrade/v3.txt
Outdated
interfaces directly. | ||
|
||
- The driver requires applications to explicitly configure how to serialize GUIDs | ||
by using the ``GuidSerializationProvider`` and ``ObjectSerializer`` classes. To learn |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think GuidSerializationProvider
is a typo, there is no such class.
You probably meant GuidSerializer
.
It might also be worth mentioning that you need to "register" your configured GuidSerializer
if you want it to apply globally everywhere in your application. Guid
serialization can also be configured on a case by case basis without registering a GuidSerializer
.
Registering a global GuidSerializer
is only safe for NEW applications. For old applications it might be safe but the application writer is then responsible for verifying that all Guids in their application have in fact been serialized the same way in the past.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
(cherry picked from commit fed7023)
(cherry picked from commit fed7023)
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-46065
Staging Links
https://deploy-preview-439--docs-csharp.netlify.app/upgrade/v3/
Self-Review Checklist