Fix #60: resolve $ref in response headers pointing to #/components/he…#72
Merged
RobertoPrevato merged 1 commit intomainfrom Mar 7, 2026
Merged
Fix #60: resolve $ref in response headers pointing to #/components/he…#72RobertoPrevato merged 1 commit intomainfrom
RobertoPrevato merged 1 commit intomainfrom
Conversation
…aders/ Response header definitions using $ref (e.g. $ref: '#/components/headers/foo') were passed to Jinja templates unresolved, causing an UndefinedError when the template accessed .schema or .description. Added get_response_headers() method to OpenAPIV3DocumentationHandler that calls _resolve_opt_ref() on each header value before returning the dict. Updated both mkdocs and markdown request-responses templates to call this method instead of iterating definition.headers directly. Added regression test with a fixture (example9-openapi.yaml) covering both $ref headers and inline headers in the same response. Co-authored-by: Copilot <[email protected]>
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.
…aders/
Response header definitions using $ref (e.g. $ref: '#/components/headers/foo') were passed to Jinja templates unresolved, causing an UndefinedError when the template accessed .schema or .description.
Added get_response_headers() method to OpenAPIV3DocumentationHandler that calls _resolve_opt_ref() on each header value before returning the dict. Updated both mkdocs and markdown request-responses templates to call this method instead of iterating definition.headers directly.
Added regression test with a fixture (example9-openapi.yaml) covering both $ref headers and inline headers in the same response.