-
Notifications
You must be signed in to change notification settings - Fork 0
Update environment variable names: VECTORIZE_TOKEN → VECTORIZE_API_KEY, VECTORIZE_ORG → VECTORIZE_ORGANIZATION_ID #19
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
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
…Y, VECTORIZE_ORG → VECTORIZE_ORGANIZATION_ID - Updated API documentation and type definitions - Updated Google Drive and Dropbox guide examples - Updated all code examples to use new variable names - Ensures consistent naming across SDK documentation Co-Authored-By: [email protected] <[email protected]>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
- Create step-based folder structure: environment-setup/, creating-connectors/, authentication/, user-management/, frontend-implementation/, testing/ - Each step has vectorize/ and white-label/ approaches with detailed examples - Add platform-specific guides for Google Drive and Dropbox in white-label approach - Add deprecation notices to existing platform-specific folders - Update general-guide.md to reference new step-based structure - Maintain backward compatibility with legacy guides Co-Authored-By: [email protected] <[email protected]>
…nectors - Add connector type constants for each platform (GOOGLE_DRIVE_OAUTH_MULTI, DROPBOX_OAUTH_MULTI, NOTION_OAUTH_MULTI) - Include platform-specific examples for createVectorizeConnector and createSourceConnector - Add frontend usage examples for each connector type - Include dynamic connector creation pattern - Enhance error handling with platform-specific error messages - Provide comprehensive code examples for all three supported platforms Co-Authored-By: [email protected] <[email protected]>
…latform-specific functions - Replace createVectorizeConnector with createVectorizeGDriveConnector for Google Drive - Replace createVectorizeConnector with createVectorizeDropboxConnector for Dropbox - Use createSourceConnector for Notion connectors (no specific function exists) - Update all import statements to match actual SDK exports - Fix API route implementation to use correct function signatures - Update frontend examples and error handling with correct function calls - Remove platformType parameter from platform-specific functions Co-Authored-By: [email protected] <[email protected]>
…ic functions - Replace createSourceConnector with createVectorizeNotionConnector for Vectorize Notion connectors - Update API documentation to include createVectorizeNotionConnector and createWhiteLabelNotionConnector - Add Notion token utilities (exchangeNotionCodeForTokens, refreshNotionToken) to API docs - Update test mocks to use createVectorizeNotionConnector instead of createSourceConnector - Fix import statements to import correct Notion functions - Update all code examples to use actual SDK exports Co-Authored-By: [email protected] <[email protected]>
- Add createWhiteLabelNotionConnector example alongside Google Drive and Dropbox - Include proper parameter structure with clientId and clientSecret - Update White Label connector creation section to be platform-specific Co-Authored-By: [email protected] <[email protected]>
- Add comprehensive API documentation for createVectorizeNotionConnector, createWhiteLabelNotionConnector, manageNotionUser, exchangeNotionCodeForTokens, and refreshNotionToken - Create detailed White Label Notion connector guide with OAuth setup, user management, and error handling - Add comprehensive testing guide for White Label Notion connectors with unit tests, integration tests, and manual testing checklists - Update NotionConnectorType.WHITE_LABEL to use 'NOTION_OAUTH_WHITE_LABEL' for consistency - Add Notion guide reference to White Label connector overview - Update Vectorize testing guide with Notion connector examples and error handling tests - All documentation now uses correct platform-specific functions instead of generic createSourceConnector Co-Authored-By: [email protected] <[email protected]>
- Move docs/google-drive/ and docs/dropbox/ folders to docs/legacy-docs/ - Update reference in general-guide.md to point to new legacy-docs paths - Preserve new step-based documentation structure (creating-connectors/, authentication/, etc.) - Mark legacy guides as deprecated in favor of step-based approach Co-Authored-By: [email protected] <[email protected]>
…box, and Notion - Add platform-specific authentication guides for Vectorize approach - Add platform-specific authentication guides for White-Label approach - Include OAuth configuration, token validation, and credential setup examples - Update main authentication README files with platform-specific references - All examples use updated environment variable names (VECTORIZE_API_KEY, VECTORIZE_ORGANIZATION_ID) - Provide complete component examples and error handling patterns Co-Authored-By: [email protected] <[email protected]>
…entation and testing - Add Google Drive, Dropbox, and Notion frontend implementation examples for both Vectorize and White-Label approaches - Add comprehensive testing documentation with unit tests, integration tests, and manual testing checklists for all platforms - Update README files to reference platform-specific guides - Include performance testing examples and error handling patterns - All examples use updated environment variables (VECTORIZE_API_KEY, VECTORIZE_ORGANIZATION_ID) Co-Authored-By: [email protected] <[email protected]>
- Add Google Drive and Dropbox White-Label frontend implementation guides - Add comprehensive testing documentation for Google Drive and Dropbox White-Label approaches - Include unit tests, integration tests, OAuth flow tests, and performance tests - Add manual testing checklists and error scenario coverage - All examples use updated environment variables (VECTORIZE_API_KEY, VECTORIZE_ORGANIZATION_ID) - Complete the platform-specific documentation structure for all guide sections Co-Authored-By: [email protected] <[email protected]>
- Fix README files to properly reference platform-specific guides - Add Notion White-Label frontend implementation guide - Clean up duplicate platform-specific examples sections - All documentation now includes proper cross-references to platform-specific guides - Complete the comprehensive documentation structure for all guide sections Co-Authored-By: [email protected] <[email protected]>
- Create comprehensive white-label authentication documentation - Includes OAuth setup for Google Drive, Dropbox, and Notion - Provides multi-platform authentication component examples - Uses updated environment variables (VECTORIZE_API_KEY, VECTORIZE_ORGANIZATION_ID) - Follows same structure as vectorize approach authentication guide - Fixes broken links from vectorize-docs multi-user-white-label.md Co-Authored-By: [email protected] <[email protected]>
benfrank241
approved these changes
Jun 30, 2025
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.
Add missing authentication/white-label/README.md and update environment variables
Summary
This PR completes the comprehensive Multi OAuth connectors documentation overhaul by creating the missing
authentication/white-label/README.md
file and updating environment variable names across the vectorize-connect-sdk repository. The changes ensure consistency with the updated variable naming (VECTORIZE_API_KEY
andVECTORIZE_ORGANIZATION_ID
) and provide complete generic white-label documentation that was referenced but missing.Key Changes:
docs/authentication/white-label/README.md
with OAuth setup guides for Google Drive, Dropbox, and NotionVECTORIZE_TOKEN
→VECTORIZE_API_KEY
andVECTORIZE_ORG
→VECTORIZE_ORGANIZATION_ID
Review & Testing Checklist for Human
VECTORIZE_TOKEN
orVECTORIZE_ORG
references that might have been missed across all documentation filescreateWhiteLabelGDriveConnector
,GoogleDriveOAuth.startOAuth
, etc. match the actual SDK APIDiagram
Notes
Link to Devin run: https://app.devin.ai/sessions/62717860ec0c4624a96d84ca8c30b7f7
Requested by: [email protected]