docs(ai-agents): add OAuth credential override documentation#74057
docs(ai-agents): add OAuth credential override documentation#74057Ian Alton (ian-at-airbyte) wants to merge 4 commits intomasterfrom
Conversation
Co-Authored-By: ian.alton@airbyte.io <ian.alton@airbyte.io>
🤖 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:
|
👋 Greetings, Airbyte Team Member!Here are some helpful tips and reminders for your convenience. 💡 Show Tips and TricksPR Slash CommandsAirbyte Maintainers (that's you!) can execute the following slash commands on your PR:
📚 Show Repo GuidanceHelpful Resources
|
|
Deploy preview for airbyte-docs ready! ✅ Preview Built with commit fe66b9c. |
There was a problem hiding this comment.
On second thought, let's not document this on this page. I'd prefer to keep the quick start as quick and simple as possible. They have other ways to learn.
There was a problem hiding this comment.
…view feedback Co-Authored-By: ian.alton@airbyte.io <ian.alton@airbyte.io>
|
I'm kind of confused by the order of operations on /ai-agents/platform/authenticate/hosted. We show three options here:
I don't think this is properly explained at a higher level, at least not for the SDK. What if I want to use the SDK for API/Oauth authentication without using my own OAuth app? Is that now possible? (IE there are 3 ways, with two complete options for each way, SDK and API)? |
|
Good point — the three subsections are actually mixing two different concerns:
So the new section isn't really a third "way to create a connector" — it's an orthogonal configuration step. That probably explains the confusion. A few options for how to fix this: A) Move the OAuth app override section out of "Creating connectors with credentials" into its own top-level heading (e.g. between "Creating connectors with credentials" and "Security considerations"), since it's a separate operation. B) Add a brief intro paragraph under "Creating connectors with credentials" explaining the two auth methods (tokens vs OAuth), then keep the OAuth app override as a subsection but add a note that it's an optional org-level configuration, not a third auth method. C) Add Python SDK examples to the first two sections as well, so all three are consistent. (Though I'm not sure the SDK currently has a direct equivalent for the connector-creation curl calls — I'd need to check.) Which direction do you prefer? Happy to implement whichever approach you think reads best. |
|
OK, so my confusion makes sense to me now. We actually don't want to talk about this at all on the main auth page. We already reference building your own OAuth flow from there. If I understand correctly, it makes the most sense to JUST update the "Build your own OAuth flow" page, right? I can't think of another context in which you would use this. |
… review feedback Co-Authored-By: ian.alton@airbyte.io <ian.alton@airbyte.io>
|
Makes sense — removed the entire section from |
docs/ai-agents/platform/authenticate/build-auth/build-your-own.md
Outdated
Show resolved
Hide resolved
docs/ai-agents/platform/authenticate/build-auth/build-your-own.md
Outdated
Show resolved
Hide resolved
…w feedback Co-Authored-By: ian.alton@airbyte.io <ian.alton@airbyte.io>
|
/ai-docs-review
|
Aldo Gonzalez (aldogonzalez8)
left a comment
There was a problem hiding this comment.
APPROVED
What
Documents the OAuth credential override feature introduced in airbytehq/sonar#2587, which allows organizations to replace Airbyte-managed OAuth app credentials with their own via
configure_oauth_app_parameters(). Addresses airbytehq/airbyte-internal-issues#15826 (item 4).How
Updates
docs/ai-agents/platform/authenticate/build-auth/build-your-own.md:<Tabs>to add a Python SDK tab alongside the existing API tab.credentials=None) and API (DELETEendpoint) examples.Review guide
docs/ai-agents/platform/authenticate/build-auth/build-your-own.md— The<Tabs>/<TabItem>components rely on imports already present at the top of the file. Verify the Python SDK examples use correct model names (e.g.HubspotOAuthCredentials) that match what airbytehq/sonar#2587 generates.Review checklist
<Tabs>imports exist at top ofbuild-your-own.md(should already be there from existing content).configure_oauth_app_parameters()API and model names match the sonar PR implementation.DELETEendpoint path matches the actual API.User Impact
Users following the "Build your own OAuth flow" guide can now see Python SDK examples alongside curl, and learn how to remove an override. Previously, only curl examples existed and the removal flow was undocumented.
Can this PR be safely reverted and rolled back?
Updates since last revision
tutorial-hosted.mdper review feedback — keeping the quickstart as simple as possible.hosted.mdper review feedback — this feature belongs exclusively on the "Build your own OAuth flow" page.Link to Devin run: https://app.devin.ai/sessions/fe1e9e0ab40a43488b60419db5daf417
Requested by: Ian Alton (@ian-at-airbyte)