docs: sync documentation with current API (automated)#130
Open
rmad17 wants to merge 4 commits into
Open
Conversation
…tions, fix broken RAR code block
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
Automated documentation drift fix. 15 findings addressed (2 P1 · 7 P2 · 6 P3-D stubs).
Changes
README.md— fixpoetry install→poetry add(P1, wrong Poetry subcommand)README.md— fix unquoted dict keyredirect_uri:→"redirect_uri":(P1, PythonNameErroron copy-paste)README.md— add missingstore_optionsto 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 importfrom auth_server.server_client→from auth0_server_python.auth_server.server_client(P2)examples/InteractiveLogin.md— replace rawdictcalls withStartInteractiveLoginOptions(...)in sections 2, 3, 4, 5, 6 (P2,AttributeErrorin typed integrations)examples/InteractiveLogin.md— fix broken/unclosed code block in section 5 RAR example (P2,SyntaxError)examples/ConfigureStore.md— replacestart_login()/complete_login()withstart_interactive_login()/complete_interactive_login()(P2, wrong method names forServerClient)examples/RetrievingData.md— remove trailing semicolons from Python code examples (P3)examples/RetrievingData.md— fixloginHint→login_hintin option description (P3)Full Drift Report
README.mdpoetry install auth0-server-pythonis wrong — should bepoetry addREADME.mdredirect_uri:causesNameErrorin PythonREADME.mdstore_options— silently breaks cookie-based storesexamples/InteractiveLogin.mdfrom auth_server.server_clientmissing package prefixexamples/InteractiveLogin.mdstart_interactive_login({...})with raw dict — must useStartInteractiveLoginOptionsexamples/InteractiveLogin.mdSyntaxErrorexamples/ConfigureStore.mdstart_login()/complete_login()are non-existent method names onServerClientexamples/RetrievingData.mdget_user();andget_session();+ camelCaseserverClientexamples/RetrievingData.mdloginHintshould belogin_hint(snake_case)README.mdstublogout— no documentation in any fileREADME.mdstubget_token_by_refresh_token— no documentation in any fileREADME.mdstubget_token_for_connection— no documentation in any fileREADME.mdstubbackchannel_authentication— mid-level CIBA method undocumentedREADME.mdstubinitiate_backchannel_authentication— low-level CIBA primitive undocumentedREADME.mdstubbackchannel_authentication_grant— low-level CIBA primitive undocumented🤖 Generated with syncing-docs skill