docs: Correct the legacy Authentication pages for 4.0 - #732
Open
developerjamiu wants to merge 2 commits into
Open
docs: Correct the legacy Authentication pages for 4.0#732developerjamiu wants to merge 2 commits into
developerjamiu wants to merge 2 commits into
Conversation
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.
Final PR of the Authentication section pass, following #728, #729, and #731. This one covers the legacy section, the two upgrading guides, and two small consistency follow-ups from #731.
Legacy pages (correctness only, no restructuring)
Every claim on the nine legacy pages was verified against the framework source. The legacy
serverpod_authmodule still ships at 4.0.0-beta.1 (relocated tomodules/legacy/in the monorepo), so the pages are corrected to match that release:signOutmethod and status endpoint were removed in 3.0; the info boxes now say so and point atsignOutDevice/signOutAllDevices. ThelegacyUserSignOutBehaviorconfig row is gone. Client snippets assign the key manager to theauthKeyProviderfield instead of the removed constructor parameter.AuthenticationInfocalls (String identifier, requiredauthId),UserAuthentication.signInUser(missing Session argument), thepasswordHashValidator/passwordHashGeneratorexamples (current signature andPasswordValidationResult), the Apple button import (pointed at the email package), staleawaits on the now-synchronoussession.authenticatedandisUserSignedIngetters, and import standardization on theserverpod_auth_server.dartentrypoint.passwordResetExpirationTimeis 15 minutes (was documented as 24h),allowUnsecureRandomdefaults to the safe behavior (the page described the opposite),validationCodeLengthdocuments the real warn-below-8/throw-below-4 behavior, and the firebase key path and image-generator defaults are filled in.^1.x.xpins replaced with 4.0.0-beta.1 across the section.Upgrading guides
serverpod_authpackages in lockstep, and move off the deprecatedauthenticationKeyManagerparameter toauthKeyProvider(deprecated at beta.1, removed after).Follow-ups from #731