docs(core): document jsonOptions server option and per-service form#35
Open
intech wants to merge 1 commit into
Open
docs(core): document jsonOptions server option and per-service form#35intech wants to merge 1 commit into
intech wants to merge 1 commit into
Conversation
Document the new `jsonOptions` option on `createServer()` for controlling Connect JSON serialization server-wide (e.g. `alwaysEmitImplicit: true`), plus the per-service `router.service()` form. Note the protobuf-es v2 field name (`alwaysEmitImplicit`, not the v1 `emitDefaultValues`). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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
Documents the new server-level
jsonOptionsoption oncreateServer()in the@connectum/corepackage guide, alongside the per-service form.jsonOptionscontrols Connect's JSON serialization server-wide. The most common use isalwaysEmitImplicit: true, which includes fields with implicit presence (proto3 scalar0, empty string/list, enum default) in JSON responses instead of omitting them. Because it is applied at the adapter level, it also covers framework-registered protocol services (healthcheck, reflection).The guide also documents the per-service alternative via the third argument of
router.service(), and notes the protobuf-es v2 field name (alwaysEmitImplicit, not the v1emitDefaultValues).Changes
en/packages/core.md: add thejsonOptionsrow to theCreateServerOptionstable and a new "JSON serialization" subsection with examples.Related
Documents the option added in Connectum-Framework/connectum#128.
🤖 Generated with Claude Code