[FEATURE] Headers schema support in `AsyncAPIInputProcessor`

[matthew-inamdar]

Why do we need this improvement?

We have a use-case where we need both the payload and headers of a message defined in our AsyncAPI spec to have types generated.

Currently, only message payloads have types generated.

I am proposing that the AsyncAPIInputProcessor supports optionally including headers schemas during its AsynAPI spec traversal as part of the process() function:

modelina/src/processors/AsyncAPIInputProcessor.ts

Lines 131 to 141 in 9af5b60

	for (const message of messages) {
	const payload = message.payload();
	if (!payload) {
	continue;
	}
	// Add each individual message payload as a separate model
	addToInputModel(payload);
	oneOf.push(payload.json());
	}

How will this change help?

For use-cases where headers schemas need to be typed for code-gen.

Screenshots

No response

How could it be implemented/designed?

Currently, the AsyncAPI takes no specific input processor options:

modelina/src/models/ProcessorOptions.ts

Lines 9 to 18 in 9af5b60

	export interface ProcessorOptions {
	asyncapi?: ParseOptions;
	openapi?: OpenAPIInputProcessorOptions;
	typescript?: TypeScriptInputProcessorOptions;
	jsonSchema?: JsonSchemaProcessorOptions;
	/**
	* @deprecated Use the `jsonSchema` options instead of `interpreter`
	*/
	interpreter?: InterpreterOptions;
	}

A new AsyncAPIInputProcessorOptions type should be created which accepts an includeHeaders?: bool field.

When explicitly set to true, the AsyncAPIInputProcessor will also include message headers alongside message payloads.

🚧 Breaking changes

No

👀 Have you checked for similar open issues?

• I checked and didn't find a similar issue

🏢 Have you read the Contributing Guidelines?

• I have read the Contributing Guidelines

Are you willing to work on this issue?

Yes I am willing to submit a PR!

[github-actions]

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️