fix: document error codes added by group modifiers - #1090
Open
stareezy-1 wants to merge 1 commit into
Open
Conversation
defineErrors ran before OperationDocumenter, so error codes appended by group modifiers were never written into op.Responses, while Tags, Security, and Middlewares (read directly by AddOperation) were. Move the error definition to the innermost document step, after all modifiers have run.
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
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
Fixes #878
Problem
When a group modifier appends to
op.Errors, the generated OpenAPI document does not include the new error responses — whileTags,Security, andMiddlewareschanges from the same modifier are reflected correctly.Root cause:
huma.RegistercalleddefineErrors(which consumesop.Errorsintoop.Responses) before invokingOperationDocumenter, where group modifiers run. The other fields are read directly from the operation byAddOperationafter the modifiers, which is why they worked.Reproduction:
Fix
Move the error definition to the innermost document step — after all group modifiers have run and immediately before
AddOperation:Register(plain API path): calldefineOperationErrorsright beforeAddOperation.Group.DocumentOperation: call it at the end of the modifier chain, before delegating or adding.defineOperationErrorshelper preserves the previous 422/500 auto-append behavior, using the documented operation state (op.RequestBody,op.Parameters) as the equivalent condition.Tests
TestGroupModifierErrorsDocumentedregisters an operation in a group whose modifier adds401and asserts:401(modifier-added)422/500(auto-appended)Tagsfrom modifierAll existing tests continue to pass (
go test -race ./...).