Skip to content

docs: sync documentation with current API (automated)#130

Open
rmad17 wants to merge 4 commits into
mainfrom
docs/sync-2026-07-01
Open

docs: sync documentation with current API (automated)#130
rmad17 wants to merge 4 commits into
mainfrom
docs/sync-2026-07-01

Conversation

@rmad17

@rmad17 rmad17 commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Summary

Automated documentation drift fix. 15 findings addressed (2 P1 · 7 P2 · 6 P3-D stubs).

Changes

  • README.md — fix poetry installpoetry add (P1, wrong Poetry subcommand)
  • README.md — fix unquoted dict key redirect_uri:"redirect_uri": (P1, Python NameError on copy-paste)
  • README.md — add missing store_options to login/callback route examples (P2)
  • README.md — add 6 P3-D TODO stubs for undocumented public methods (logout, get_token_by_refresh_token, get_token_for_connection, backchannel_authentication, initiate_backchannel_authentication, backchannel_authentication_grant)
  • examples/InteractiveLogin.md — fix import from auth_server.server_clientfrom auth0_server_python.auth_server.server_client (P2)
  • examples/InteractiveLogin.md — replace raw dict calls with StartInteractiveLoginOptions(...) in sections 2, 3, 4, 5, 6 (P2, AttributeError in typed integrations)
  • examples/InteractiveLogin.md — fix broken/unclosed code block in section 5 RAR example (P2, SyntaxError)
  • examples/ConfigureStore.md — replace start_login()/complete_login() with start_interactive_login()/complete_interactive_login() (P2, wrong method names for ServerClient)
  • examples/RetrievingData.md — remove trailing semicolons from Python code examples (P3)
  • examples/RetrievingData.md — fix loginHintlogin_hint in option description (P3)
Full Drift Report
# Severity File Issue
1 P1 README.md poetry install auth0-server-python is wrong — should be poetry add
2 P1 README.md Unquoted dict key redirect_uri: causes NameError in Python
3 P2 README.md Login/callback examples omit store_options — silently breaks cookie-based stores
4 P2 examples/InteractiveLogin.md Wrong import: from auth_server.server_client missing package prefix
5 P2 examples/InteractiveLogin.md start_interactive_login({...}) with raw dict — must use StartInteractiveLoginOptions
6 P2 examples/InteractiveLogin.md Unclosed brace in section 5 RAR code block causes SyntaxError
7 P2 examples/ConfigureStore.md start_login()/complete_login() are non-existent method names on ServerClient
8 P3 examples/RetrievingData.md Trailing semicolons on get_user(); and get_session(); + camelCase serverClient
9 P3 examples/RetrievingData.md loginHint should be login_hint (snake_case)
10 P3-D README.md stub logout — no documentation in any file
11 P3-D README.md stub get_token_by_refresh_token — no documentation in any file
12 P3-D README.md stub get_token_for_connection — no documentation in any file
13 P3-D README.md stub backchannel_authentication — mid-level CIBA method undocumented
14 P3-D README.md stub initiate_backchannel_authentication — low-level CIBA primitive undocumented
15 P3-D README.md stub backchannel_authentication_grant — low-level CIBA primitive undocumented

🤖 Generated with syncing-docs skill

@rmad17 rmad17 requested a review from a team as a code owner July 1, 2026 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant