fix: Remove incorrect SSH key authentication claim from SFTP docs#1722
Merged
Conversation
The FTP/SFTP comparison table claimed SFTP supports "Username/password or SSH keys" for authentication. The SFTP connector only defines user and pass parameters — no SSH key file or passphrase parameters exist. Changed to "Username/password" to match the implementation.
✅ Pull with Spice PassedPassing checks:
|
|
🚀 deployed to https://5284b42b.spiceai-org-website.pages.dev |
lukekim
approved these changes
May 13, 2026
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
2 participants
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
The FTP/SFTP comparison table claimed SFTP supports "Username/password or SSH keys" for authentication. The SFTP connector (
connector-sftp/src/lib.rs) only definescomponent("user")andcomponent("pass")parameters — no SSH key file or passphrase parameters exist in the code.Changes
Changed SFTP authentication column from "Username/password or SSH keys" to "Username/password" in both vNext and v1.11.x docs (2 files).
Reference
Verified against spiceai/spiceai at
trunk—crates/data-connectors/connector-sftp/src/lib.rsPARAMETERS array (lines 62-70). Confirmed no SSH-related parameters viagrep -rn 'ssh\|SSH\|identity_file\|private_key' crates/data-connectors/connector-sftp/src/(no results).