feat: add format attribute to AsyncOperation.Headers.Header (#1506) #1510
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
…lf#1506) - Add format field to @Header annotation with default empty string - Implement format processing in AsyncAnnotationUtil.getAsyncHeaders() - Add getFormat() helper method following existing pattern - Update tests and hash values due to header structure change The format field allows specifying AsyncAPI data type formats (e.g., int32, int64, date-time) for header values while maintaining type as 'string' per AsyncAPI specification.
✅ Deploy Preview for springwolf-ui canceled.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to Springwolf. Thanks a lot for creating your first pull request. Please check out our contributors guide and feel free to join us on discord.
timonback
reviewed
Nov 9, 2025
Member
timonback
left a comment
timonback
left a comment
There was a problem hiding this comment.
Looks great, Thank you @Haisia
We use our Kafka example also for show casing and indirectly as full integration test.
You mentioned that you used it for verification as well. Let's update the Kafka example (one header format is sufficient) to demonstrate this feature.
.../java/io/github/springwolf/core/asyncapi/scanners/common/annotation/AsyncAnnotationUtil.java
Show resolved
Hide resolved
- Change getFormat to use resolve->filter order for consistency - Remove unnecessary if block in getAsyncHeaders - Add format example to AnotherProducer in kafka example"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
Adds
formatfield to@AsyncOperation.Headers.Headerannotation to support AsyncAPI data type formats (e.g., int32, int64, date-time) per the AsyncAPI specification.Changes
formatattribute to@AsyncOperation.Headers.Headerannotation with JavadocgetFormat()helper method inAsyncAnnotationUtilgetAsyncHeaders()to process and set format fieldSwaggerSchemaUtil.mapSchemaObjectToSwagger()- uncommentedsetFormat()call that was preventing format from appearing in outputImplementation Note
During implementation, discovered that
SwaggerSchemaUtil.mapSchemaObjectToSwagger()hadsetFormat()commented out, preventing format from appearing in the final AsyncAPI output. This has been fixed.Testing
Tested with
springwolf-kafka-example:Example:
Output:
{ "user-id": { "type": "string", "format": "int32", "description": "User identifier" } }Resolves #1506