Improve SearchClient docs, deprecate entry methods #695
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The create_entry and update_entry methods are misleadingly named. We may or may not be able to remove these aliasing APIs from the service, but we should at least discourage their use via the SDK. Redirect users of these methods to Ingest, which is the only behavior offered by all three of these APIs. Even if we were to support this operation in the SDK, having a single API with two methods is confusing because it suggests that there is some difference. Instead, we would probably want to implement `write_entry` if we need a succcessor method.
sirosen
requested review from
aaschaer,
ada-globus,
derek-globus and
kurtmckee
as code owners
kurtmckee
approved these changes
Mar 2, 2023
derek-globus
approved these changes
Mar 2, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The create_entry and update_entry methods are misleadingly named. We may or may not be able to remove these aliasing APIs from the service, but we should at least discourage their use via the SDK. Redirect users of these methods to Ingest, which is the only behavior offered by all three of these APIs.
Even if we were to support this operation in the SDK, having a single API with two methods is confusing because it suggests that there is some difference.
Instead, we would probably want to implement
write_entryif we need a succcessor method.📚 Documentation preview 📚: https://globus-sdk-python--695.org.readthedocs.build/en/695/