Remove openapi_config property
#369
Merged
Conversation
This file contains hidden or 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
austin-denoble
approved these changes
Jul 19, 2024
Comment on lines
216
to
+217
| if kwargs.get("openapi_config", None): | ||
| warnings.warn( | ||
| "Passing openapi_config is deprecated and will be removed in a future release. Please pass settings such as proxy_url, proxy_headers, ssl_ca_certs, and ssl_verify directly to the Pinecone constructor as keyword arguments. See the README at https://github.com/pinecone-io/pinecone-python-client for examples.", | ||
| DeprecationWarning, | ||
| raise Exception( |
Contributor
There was a problem hiding this comment.
Ah, so the part that checks for the kwarg of this is part of the underlying generated code implementation? That's annoying.
Collaborator
Author
There was a problem hiding this comment.
The whole bucket of kwargs gets passed around in various places, so to be sure nobody has formed a dependency on these internals (so we can safely refactor later) we need to explicitly check and throw right at the entry point.
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.
Problem
We want to remove the
openapi_configconfig property because we don't want generated openapi stuff in the public interface. This is a holdover from the v2 days ofpinecone.init()but has never been documented; I would be surprised if anyone is actually using it.Solution
Type of Change