docs: Deepen the Endpoints and APIs section with verified 4.0 behavior#693
Open
developerjamiu wants to merge 1 commit into
Open
docs: Deepen the Endpoints and APIs section with verified 4.0 behavior#693developerjamiu wants to merge 1 commit into
developerjamiu wants to merge 1 commit 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.
Deep review and rework of the Endpoints & APIs section. Every technical claim was verified against the Serverpod 4.0.0-beta.0 source, a project created with the 4.0.0-beta.0 CLI, and, for the new examples, integration tests against a running server.
Structure
Corrections
getServerUrl()with theSERVER_URLdefine,assets/config.json, and platform-aware localhost. The previous guidance taught a hand-rolled pattern with a different variable name than the framework reads.StateError; logs accumulating in memory until close), the deprecatedfutureCallWithDelayreplaced with the typedfutureCallsbuilder, and the non-compiling testing example replaced with a pointer to the testing docs.withSessionis now the primary manual-session pattern.SerializableExceptionis abstract); replaced with a generated-exception example validated by integration tests in both directions. An inverted inStream/outStream sentence fixed.authenticationRevokedis now documented, andpostMessageis awaited in examples.Additions (all verified in source)
MethodStreamExceptiontypes with when each is thrown.sendAsRawandlogSessionsendpoint flags,session.serverpod, storagedeleteFile/getPublicUrls/storeFile(expiration:), the upload-progress limitation, the 413 request-size failure mode, anddynamicplus vector and geography types in the parameter list.Also touched