docgen: align online mode field metadata with --file mode#926
Merged
Conversation
adminSchemaToDocgen now maps every documentation-relevant property the admin client carries — info, title, example(s), externalDocs, tags, format, readOnly, writeOnce, sensitive, and version_description — so a schema fetched from the server documents identically to one read with --file. adminclient.FieldConstraints gains AllowedSchemes, which the proto carries but the SDK dropped, mapped in both grpctransport directions. A reflection-based drift test fails whenever a future adminclient property is neither mapped nor explicitly recorded as non-documentation metadata. Closes #912 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
adminSchemaToDocgendropped Info, Title, Example, Examples, ExternalDocs, Tags, Format, ReadOnly, WriteOnce, Sensitive, VersionDescription, and AllowedSchemes that--filemode renders. Online mode now maps the full admin-client surface, structured to read in parallel withschemaFromYAML.FieldConstraints.allowed_schemes; adminclient and grpctransport now carry it both directions.Test plan
make test— all modules pass./scripts/check-coverage.sh— cmd/decree 87.4% (≥86.1), sdk/adminclient 98.3% (≥97.7); changed grpctransport functions at 100% pergo tool cover -funcmake lint-goclean;go build/go vetclean in touched modulese2e,e2e upgrade,stress,chaos,integration,exampleacross all examples modulesCloses #912