Contextual REST companions#1513
Open
sebaciv wants to merge 3 commits into
Open
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.
Adds contextual and custom-implicits REST companion APIs to udash-rest, together with their ScalaDoc, unit tests, and guide documentation.
New companions
Contextual APIs — let a server-side method implementation receive request-scoped context (e.g. the authenticated user) that never appears in the client-facing interface:
Custom-implicits companions — packaged companion sets bound to a user-supplied implicits bundle, so custom serialization/schema is threaded into macro derivation without per-shape boilerplate:
Supporting helpers: RestNamedValueEnumCompanion, HasRestSchema, RestFlattenedStructure, CaseNameValidatingCodec.
Documentation (ScalaDoc)
Tests
Unit tests for the new companions (run on JVM, cross-compile on JS):
The tests deliberately use a type with no default serialization whose codec/schema is provided only through injected implicits — verifying that a custom implicits bundle is actually collected by the derivation macros.
Guide (rest.md)