Improve golang type documentation and examples #631
+78
−105
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
Enhanced Go struct tags throughout pkg/api/v0/types.go and pkg/model/types.go to better align with the OpenAPI specification: - Added comprehensive doc tags with detailed field descriptions - Added example tags showing valid values for fields - Added format tags (uri, date-time) for better type specification - Added pattern and enum tags for validation constraints - Added placeholder field to Input struct matching OpenAPI spec - Removed redundant comments in favor of inline struct tags These changes improve code clarity and make the types more self-documenting, while maintaining compatibility with the OpenAPI schema definitions.
|
Most of this came from diffing the specs with: # Start the server
make dev-compose
# Wait for server to be ready, then fetch and compare
curl -s http://localhost:8080/openapi.yaml | yq -o json | jq -S > /tmp/localhost-openapi.json
yq -o json docs/reference/api/openapi.yaml | jq -S > /tmp/docs-openapi.json
diff -u /tmp/docs-openapi.json /tmp/localhost-openapi.json > schemas.diffAnd then going through and trying to align these as much as possible |
domdomegg
force-pushed
the
adamj/improve-golang-type-docs
branch
from
eefda60 to
5246f8d
Compare
Updated test expectations to align with actual Huma framework behavior where schema validation occurs before handler execution: - Changed expected status from 400 to 422 (Unprocessable Entity) - Updated error message checks to match Huma's pattern validation error - Fixed "invalid token" test to use valid server name format Schema validation in Huma happens at the framework level before the handler function runs, so invalid server names (with multiple slashes, no slashes, etc.) return 422 with pattern matching errors rather than custom 400 errors. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
domdomegg
force-pushed
the
adamj/improve-golang-type-docs
branch
from
5246f8d to
3ee0672
Compare
|
I have no idea why go is panicking now: https://github.com/modelcontextprotocol/registry/actions/runs/18327735919/job/52196150090?pr=631 Stacktrace not very helpful, and the changes really don't seem like they would cause this. |
rdimitrov
previously approved these changes
Oct 8, 2025
rdimitrov
dismissed
their stale review
I had this opened on the file changes and missed the failing checks
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.
Enhanced Go struct tags throughout
pkg/api/v0/types.goandpkg/model/types.goto better align with the OpenAPI specification.Changes
doctags with detailed field descriptions matching OpenAPIexampletags showing valid values for fields (e.g.,"io.github.user/weather","npx")formattags (uri,date-time) for better type specificationpatternandenumtags for validation constraintsplaceholderfield toInputstruct matching OpenAPI specThese changes improve code clarity and make the types more self-documenting, while maintaining compatibility with the OpenAPI schema definitions in
docs/reference/api/openapi.yaml.