Docs: Python SDK - SaaS connection guide and authentication troubleshooting - #992
Open
aleksandarkovacevic30 wants to merge 1 commit into
Open
aleksandarkovacevic30 wants to merge 1 commit into
aleksandarkovacevic30 wants to merge 1 commit into
Conversation
- Add a Context settings reference table describing every setting and the URLs the SDK derives from domain/org_name. - Document connecting to CluedIn SaaS: the UI vs API host naming, token and GraphQL URL patterns, a working configuration example, and how to pin requests to the shared app. host. - Call out the common misconfigurations: "api_url": "app" and a /graphql (rather than /api/api/graphql) endpoint. - Explain boolean spelling differences between Python dicts and JSON files for verify_tls, and when disabling TLS verification is warranted. - Add a troubleshooting section covering invalid_username_or_password, client id not found, name resolution failures, connect timeouts, certificate verification errors, and 400/401 responses. - Update the minimum supported Python version to 3.10 and refresh last_modified. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012KCK5CtcdTxubpqnjxrvVD
This branch has not been deployed
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
1 participant
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.
What
Expands the CluedIn Python SDK playbook page (
docs/210-playbooks/data-engineering/010-python-sdk.md) with the information needed to connect to a CluedIn SaaS instance and to diagnose failures when it does not work.Changes
Contextsetting, its default, and the URLs the SDK derives fromdomain/org_name.<org>.<region>.saas.cluedin.com) vs the shared API host (app.<region>.saas.cluedin.com), the token and GraphQL URL patterns, a workingcluedin.jsonexample, and how to pin all requests to theapp.host."api_url": "app"(circulates in older notebooks and breaks every REST call withMissingSchema) and against pointinggql_api_urlat/graphqlinstead of/api/api/graphql.True/Falsein Python vstrue/falsein JSON forverify_tls, the fact that any non-truevalue disables verification, and when disabling it is actually appropriate.invalid_username_or_password,Client not found for client id,ConnectionError/NameResolutionError,ConnectTimeout,SSLCertVerificationError,400 Bad Requestfrom GraphQL, and401 Unauthorized.>=3.10,<4.0), andlast_modifiedrefreshed.Notes
Documentation only - no code or site configuration changes.