Skip to content

Conversation

mcmorisi
Copy link
Collaborator

@mcmorisi mcmorisi commented Jan 24, 2025

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

  • Is this free of any warnings or errors in the RST?
  • Did you run a spell-check?
  • Did you run a grammar-check?
  • Are all the links working?
  • Are the facets and meta keywords accurate?

Copy link

netlify bot commented Jan 24, 2025

Deploy Preview for docs-csharp ready!

Name Link
🔨 Latest commit ffd3c3f
🔍 Latest deploy log https://app.netlify.com/sites/docs-csharp/deploys/6797bccdfd79780008585726
😎 Deploy Preview https://deploy-preview-439--docs-csharp.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.


- 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>`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
more about GUID serialization, see :ref:`<csharp-guids>`.
more about GUID serialization, see the :ref:`csharp-guids` guide.

@mcmorisi mcmorisi requested a review from rstam January 24, 2025 15:01
interfaces directly.

- The driver requires applications to explicitly configure how to serialize GUIDs
by using the ``GuidSerializationProvider`` and ``ObjectSerializer`` classes. To learn
Copy link
Collaborator

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.

@mcmorisi mcmorisi requested a review from rstam January 27, 2025 17:05
Copy link
Collaborator

@rstam rstam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mcmorisi mcmorisi merged commit fed7023 into mongodb:master Jan 27, 2025
6 checks passed
@mcmorisi mcmorisi deleted the DOCSP-46065-v3-guids branch January 27, 2025 17:42
mcmorisi added a commit that referenced this pull request Jan 27, 2025
mcmorisi added a commit that referenced this pull request Jan 27, 2025
mongoKart pushed a commit to mongoKart/docs-csharp that referenced this pull request May 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants