Update from code changes: document Enterprise OAuth authentication#290
Open
mintlify[bot] wants to merge 2 commits into
Open
Update from code changes: document Enterprise OAuth authentication#290mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Update from code changes updated this PR. Added TypeScript OAuth examples to the Enterprise Authentication page Source PRs
|
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
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.
Summary
Adds an Authentication page under LanceDB Enterprise covering API key and OAuth options for both Python and TypeScript clients, documenting
OAuthConfig/OAuthFlowTypeonconnect_async(Python) andconnect(TypeScript).Changes
enterprise/authentication.mdxpage with API key and OAuth sectionsCodeGroupblockssnake_case(Python) andcamelCase(TypeScript) namesdocs.jsonContext
Upstream changes expose OAuth connection config through the async Python connect path and the TypeScript connect path, including support for Azure Managed Identity and a client-secret-redacted config object. The docs note that, in Python, OAuth flows through
connect_asyncwhile synchronousconnectcontinues to use API keys; in TypeScript, OAuth is available directly onconnect.Update history
OAuthConfig/OAuthFlowTypeexposed viaconnect_async, including Client Credentials and Azure Managed Identity examples. Source: feat(python): expose OAuth connection config lancedb#3586oauthConfigoption. Source: feat(node): expose OAuth connection config lancedb#3587