Rename the "Creating a Client" docs to "Connecting" and document OAuth - #597
Merged
Merged
Conversation
leoschwarz
force-pushed
the
docs/connecting-oauth
branch
from
August 13, 2026 12:51
411efba to
70fdf8b
Compare
leoschwarz
force-pushed
the
docs/connecting-oauth
branch
from
August 13, 2026 12:59
70fdf8b to
9fdb2df
Compare
…t OAuth The guide predated the OAuth work in 1.20.0: it covered only Bfabric.connect() with a login/password config file and connect_token() for webapps. The path most people use today — bfabric-cli login once, then plain Bfabric.connect(), which auto-routes on auth_method: oauth — was documented nowhere in the user guides, and connect_pkce / connect_device_code / connect_oauth / connect_pat / WebappClient.create had no user-facing coverage at all. Web service passwords are on their way out, so they are now a short legacy section rather than the lead. Also drops the experimental banner from the OAuth troubleshooting notes and fixes a stale Bfabric.from_url_token row in the integration notes — that method does not exist; the entry point is WebappClient.create. WebappClient is documented with its bfabric._oauth import because it has no public home yet; exporting it is a follow-up.
leoschwarz
force-pushed
the
docs/connecting-oauth
branch
from
August 13, 2026 13:42
9fdb2df to
2b6d861
Compare
leoschwarz
marked this pull request as ready for review
August 13, 2026 14:47
Collaborator
|
nice! |
Member
Author
|
I hope so too. I'm sure documentation can be improved further and plan to do so, but I was just checking it yesterday and noticed this is very outdated now. |
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.
user_guides/creating_a_client/→user_guides/connecting/) and update the inbound linksbfabric-cli loginfollowed byBfabric.connect()as the default way in, including theauth_method: oauthenvironment it writesconnect_pkce,connect_device_code,connect_pat,connect_oauthandWebappClient.create, which is documented with its publicfrom bfabric.oauth import WebappClientBfabric.from_url_tokenreference — that method does not exist🤖 Prepared with assistance from Claude Opus 5 via Claude Code.