Skip to content

Conversation

devin-ai-integration[bot]
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Jun 27, 2025

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 and VECTORIZE_ORGANIZATION_ID) and provide complete generic white-label documentation that was referenced but missing.

Key Changes:

  • Missing Documentation: Created comprehensive docs/authentication/white-label/README.md with OAuth setup guides for Google Drive, Dropbox, and Notion
  • Environment Variables: Updated all remaining references from VECTORIZE_TOKENVECTORIZE_API_KEY and VECTORIZE_ORGVECTORIZE_ORGANIZATION_ID
  • Cross-Repository Consistency: Ensures vectorize-docs links to this repository work correctly by providing the missing generic white-label documentation
  • Platform-Specific Examples: Added multi-platform authentication component and token management examples
  • Security Best Practices: Included environment variable validation and secure token storage patterns

Review & Testing Checklist for Human

  • Verify all cross-repository links work correctly - Test that links from vectorize-docs multi-user-white-label.md to this repository's authentication/white-label/README.md resolve properly
  • Check environment variable consistency - Search for any remaining VECTORIZE_TOKEN or VECTORIZE_ORG references that might have been missed across all documentation files
  • Validate SDK function accuracy - Confirm that functions like createWhiteLabelGDriveConnector, GoogleDriveOAuth.startOAuth, etc. match the actual SDK API
  • Test authentication flow examples - Verify that the OAuth configuration examples and code snippets align with actual platform requirements and SDK behavior
  • Review security recommendations - Ensure the environment variable management and secure token storage patterns follow current best practices

Diagram

graph TB
    subgraph "vectorize-docs"
        A[multi-user-white-label.md]:::minor-edit
    end

    subgraph "vectorize-connect-sdk"
        B[authentication/white-label/README.md]:::major-edit
        C[authentication/white-label/google-drive.md]:::context
        D[authentication/white-label/dropbox.md]:::context
        E[authentication/white-label/notion.md]:::context
        F[environment-setup/white-label/README.md]:::context
        G[creating-connectors/white-label/README.md]:::context
        H[user-management/white-label/README.md]:::context
        I[frontend-implementation/white-label/README.md]:::context
        J[testing/white-label/README.md]:::context
    end

    A --> B
    B --> C
    B --> D  
    B --> E
    B --> F
    B --> G

    subgraph Legend
        L1[Major Edit]:::major-edit
        L2[Minor Edit]:::minor-edit
        L3[Context/No Edit]:::context
    end

    classDef major-edit fill:#90EE90
    classDef minor-edit fill:#87CEEB
    classDef context fill:#FFFFFF
Loading

Notes

  • Missing File Resolution: This PR fixes broken links from vectorize-docs by creating the missing authentication/white-label/README.md that was referenced but didn't exist
  • Environment Variable Migration: Completes the environment variable naming update across the vectorize-connect-sdk repository to maintain consistency with vectorize-docs and test-vectorize-connect-sdk
  • Documentation Completeness: All white-label README.md files now exist, providing complete generic documentation structure that supports the cross-repository linking strategy
  • OAuth Platform Coverage: The new authentication guide covers Google Drive, Dropbox, and Notion OAuth setup with platform-specific configuration details
  • Security Focus: Includes best practices for environment variable management and secure token handling in white-label implementations

Link to Devin run: https://app.devin.ai/sessions/62717860ec0c4624a96d84ca8c30b7f7
Requested by: [email protected]

…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]>
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

devin-ai-integration bot and others added 13 commits June 27, 2025 15:22
- 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]>
@DK09876 DK09876 requested a review from benfrank241 June 30, 2025 17:40
@benfrank241 benfrank241 merged commit e1810fa into main Jun 30, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant