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.

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

Merged
merged 2 commits into from
Jan 13, 2025
Merged

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

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1fd8fa1
GODRIVER-3443 Remove internal APIs in migration guide.
qingyang-hu Dec 17, 2024
a354e5c
address the review feedback.
qingyang-hu Jan 13, 2025
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
6 changes: 0 additions & 6 deletions docs/migration-2.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -503,12 +503,6 @@ mongo.WithSession(context.TODO(),sess,func(ctx context.Context) error {

## Options Package

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.

The following fields were removed because they are no longer supported by the server

- `FindOptions.Snapshot` (4.0)
Expand Down
Loading