Skip to content

GODRIVER-3443 Remove internal APIs in migration guide. #1911

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

Merged
merged 2 commits into from
Jan 13, 2025

Conversation

qingyang-hu
Copy link
Collaborator

GODRIVER-3443

Summary

Remove internal APIs in the migration guide.

Background & Motivation

@qingyang-hu qingyang-hu requested review from prestonvasquez and removed request for matthewdale January 13, 2025 15:48
Comment on lines 506 to 511
The following fields were marked for internal use only and do not have replacement:

- `ClientOptions.AuthenticateToAnything`
- `FindOptions.OplogReplay`
- `FindOneOptions.OplogReplay`

Copy link
Member

Choose a reason for hiding this comment

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

It makes sense to remove OplogReplay from this list since it was added back to v2 with GODRIVER-3433, but AuthenticateToAnything was removed in v2 because it was internalized. Users migrating that are relying on that field (e.g.) could be confused if it's removal is not called out in the migration guide. Suggest the following:

ClientOptions.AuthenticateToAnything was marked for internal use in 1.x and does not have a replacement.

@mongodb-drivers-pr-bot mongodb-drivers-pr-bot bot added documentation Pull requests that update documentation or examples priority-3-low Low Priority PR for Review labels Jan 13, 2025
Copy link
Contributor

API Change Report

No changes found!

@qingyang-hu qingyang-hu merged commit c79e929 into mongodb:master Jan 13, 2025
27 of 35 checks passed
@matthewdale
Copy link
Collaborator

drivers-pr-bot please backport to release/2.0

mongodb-drivers-pr-bot bot pushed a commit that referenced this pull request Feb 19, 2025
matthewdale pushed a commit that referenced this pull request Feb 19, 2025
alcaeus added a commit that referenced this pull request Mar 4, 2025
* release/2.0:
  BUMP v2.0.1
  GODRIVER-3477 Bump golang.org/x/crypto from 0.29.0 to 0.31.0 [release/2.0] (#1952)
  GODRIVER-3284 Allow valid SRV hostnames with less than 3 parts. (#1898) [release/2.0] (#1949)
  GODRIVER-3452 MergeClientOptions returns object when given nil arguments (#1917) [release/2.0] (#1948)
  GODRIVER-3443 Remove internal APIs in migration guide. (#1911) [release/2.0] (#1951)
  GODRIVER-3470 Correct BSON unmarshaling logic for null values (#1924) [master] (#1945) [release/2.0] (#1947)
  Fix erroneous nil error return in FindOne. (#1926) [release/2.0] (#1944)
  GODRIVER-3298 Handle joined errors correctly in WithTransaction. (#1928) [release/2.0] (#1931)
  GODRIVER-3307 clone returned byte slice in MarshalValue (#1913) [release/2.0] (#1921)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Pull requests that update documentation or examples priority-3-low Low Priority PR for Review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants