docs: SharePoint connector docs missing new auth flows, write support, and sharepoint:// URL scheme#1681
Merged
Merged
Conversation
…, and sharepoint:// URL scheme Fixes #1660 Updates the SharePoint connector documentation to reflect the object-store listing connector update: - Documents the four new auth flows beyond client_secret / bearer_token: authorization code, refresh token, device code, and SAML 2.0 bearer (RFC 7522), plus the supporting redirect_uri and scope parameters. - Adds write-side parameters sharepoint_conflict_behavior (default replace) and sharepoint_max_put_bytes (default 1 GiB), with limitations noting only replace is compatible with INSERT/COPY TO. - Documents the new sharepoint:// (double-slash) object-store URL scheme and the five drive forms (me / drives / sites / users / groups), and links the listing-table parameters reference. - Clarifies that sharepoint_client_id and sharepoint_tenant_id are Conditional (not required for bearer_token alone), and lists all six flows in the auth-exclusivity note. - Notes that write workflows additionally require Files.ReadWrite and Sites.ReadWrite.All Microsoft Graph scopes. Verified against spiceai/spiceai trunk (crates/data-connectors/connector-sharepoint/src/lib.rs and crates/data_components/src/sharepoint/{auth,object_store,url}.rs).
✅ Pull with Spice PassedPassing checks:
|
|
🚀 deployed to https://d328ca4f.spiceai-org-website.pages.dev |
lukekim
approved these changes
May 7, 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
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
Fixes #1660
Updates the SharePoint connector documentation to reflect the object-store listing connector revamp shipped in spiceai/spiceai#10473 — documenting the four new auth flows, the new
sharepoint://URL scheme, and the new write-side parameters.Changes
website/docs/components/data-connectors/sharepoint.mdsharepoint_redirect_uri(required withauth_code) andsharepoint_scope(defaults tohttps://graph.microsoft.com/.default).sharepoint_conflict_behavior(replace(default) /fail/rename) andsharepoint_max_put_bytes(default1073741824, i.e. 1 GiB), with a limitation note that onlyreplaceis compatible withINSERT INTO/COPY TO.sharepoint://URL scheme: New section documenting the five drive forms (me/drives/sites/users/groups), routing through DataFusion'sListingTable, and pointing readers to the standard listing-table parameters.Sites.Read.All,Files.Read.All,User.Read,GroupMember.Read.All) and the additionalFiles.ReadWrite/Sites.ReadWrite.Allneeded for write workflows.sharepoint_client_idandsharepoint_tenant_idfrom "Required" to "Conditional" — they're not required for thebearer_tokenflow. Updated the auth-exclusivity note to list all six flows.SELECTfrom a SharePoint site library,INSERT INTO,COPY TO Parquet,CREATE EXTERNAL TABLE, and binary blob round-trip viaCOPY TO (FORMAT binary).Reference
Verified against
spiceai/spiceaiatorigin/trunk:crates/data-connectors/connector-sharepoint/src/lib.rs—PARAMETERSregisters all eight new auth/write parameters;build_auth_from_paramsenforces "exactly one auth flow";parse_conflict_behaviorandparse_max_put_bytesprovide the write defaults.crates/data_components/src/sharepoint/auth/mod.rs—DEFAULT_SCOPE = "https://graph.microsoft.com/.default"; theSharepointAuthenum dispatches the six flows.crates/data_components/src/sharepoint/url.rs—SharepointUrl::from_urlparses the five drive kinds.crates/data_components/src/sharepoint/object_store.rs—DEFAULT_MAX_PUT_BYTES = 1024 * 1024 * 1024(1 GiB); onlyReplaceis honored byput/put_multipart.crates/data-connectors/connector-sharepoint/README.md— confirms the Microsoft Graph scopes for read-only vs write workflows.Test plan
cd website && npm run buildpasses locallywebsite/docs/only (per skill rule for new content)trunk