docs(migration): add MIGRATION.md for functional-options API break#323
Merged
Conversation
) PRs #235, #236, #249, #254 replaced struct-config constructors with functional options across server, gateway, audit, auth, config, adminclient, and schema. The Config / ServiceConfig / RecorderConfig / GatewayConfig structs are removed without backward-compat shims (alpha). This document records before/after for each affected constructor and the list of With...() options, so SDK consumers and embedders know what to update when bumping versions. Closes #275 Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
zeevdr
force-pushed
the
docs/275-functional-options-migration
branch
from
965bdec to
d61f586
Compare
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
PRs #235, #236, #249, #254 swept every public service constructor from struct-config to functional options. The old
Config/ServiceConfig/RecorderConfig/GatewayConfigstructs are removed and there is no backward-compatibility shim (alpha policy).This adds
MIGRATION.mdat the repo root documenting before/after for each affected constructor and the full list ofWith...()options:internal/server—New,NewGateway(gateway-side options carry aGatewayprefix to disambiguate from same-package server options)internal/audit—NewUsageRecorderinternal/auth—NewInterceptorinternal/config—NewServicesdk/adminclient—Newinternal/schema—NewServiceThe pattern rule recorded at the bottom: required arguments stay positional; only optional arguments use
With...()options.Closes #275
Test plan
make testgreen🤖 Generated with Claude Code