feat(generator-asyncapi): add attachHeadersToSchema option#345
Merged
feat(generator-asyncapi): add attachHeadersToSchema option#345
Conversation
🦋 Changeset detectedLatest commit: a0ba207 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
…headers-to-schema
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.
What This PR Does
Adds a new
attachHeadersToSchemaboolean option to the AsyncAPI generator that combines message headers and payload into a single unified schema. When enabled, the generated schema wraps the original payload and headers underproperties.payloadandproperties.headersrespectively. This is useful for consumers who need header metadata alongside the message body.Changes Overview
Key Changes
attachHeadersToSchemaoption to the options schema and destructuringgetSchemaForMessagehelper that conditionally merges headersgetSchemaFromMessageParthelper to normalize nested schema formatsisJSONSchemaMessageguard to skip header attachment for non-JSON schemas (e.g., Avro)How It Works
When
attachHeadersToSchemaistrue, the generator checks if the message has headers and uses a JSON schema format. If both conditions are met, it wraps the payload and headers into a combined{ type: "object", properties: { headers, payload } }schema. For non-JSON schema formats (like Avro) or messages without headers, the original payload schema is returned unchanged.Breaking Changes
None. The option defaults to
false, so existing behavior is preserved.🤖 Generated with Claude Code