feat: better group+convenience function interop #770
Merged
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the interoperability between convenience functions and groups by ensuring that auto‐generated operation IDs and summaries are properly re‑generated when using groups. Key changes include:
- Adding tests in group_test.go to verify consistency between convenience and group behavior.
- Updating group.go to copy operation metadata and re‑generate IDs and summaries based on convenience hints.
- Modifying huma.go’s convenience function to annotate operations with metadata for later regeneration by groups.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| group_test.go | Adds tests to validate interop between convenience functions and groups. |
| group.go | Updates ModifyOperation to copy metadata and conditionally regenerate operation details. |
| huma.go | Adjusts the convenience function to generate and annotate operation metadata. |
Comments suppressed due to low confidence (2)
huma.go:2042
- [nitpick] Consider defining constants for metadata keys like '_convenience_id', '_convenience_id_out', '_convenience_summary', and '_convenience_summary_out' to improve maintainability and reduce the risk of typos.
operation.Metadata["_convenience_id"] = opID
group.go:146
- [nitpick] For consistency with the convenience function, consider using defined constants for the metadata keys in this regeneration logic.
if op.Metadata["_convenience_id"] == op.OperationID {
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #770 +/- ##
==========================================
+ Coverage 93.06% 93.10% +0.04%
==========================================
Files 23 23
Lines 5261 5296 +35
==========================================
+ Hits 4896 4931 +35
Misses 313 313
Partials 52 52 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
This PR fixes an issue where switching from full paths to
huma.Groupwhile using convenience functions breaks the resulting OpenAPI backward compatibility. Since these two things (convenience functions and groups) operate at different layers, the operation's metadata is used to communicate when auto-generated operation ID and summaries have been used, enabling groups to regenerate those values if they have not been modified.Fixes #754.