Skip to content

fix: remove invalid x- fields from Kafka bindings in adeo example#1184

Closed
Anirudh-x wants to merge 1 commit intoasyncapi:masterfrom
Anirudh-x:fix/remove-invalid-x-fields-kafka-bindings-example
Closed

fix: remove invalid x- fields from Kafka bindings in adeo example#1184
Anirudh-x wants to merge 1 commit intoasyncapi:masterfrom
Anirudh-x:fix/remove-invalid-x-fields-kafka-bindings-example

Conversation

@Anirudh-x
Copy link
Copy Markdown


Fix: remove invalid x- fields from Kafka bindings in adeo example

Remove x-* extension fields from Kafka binding objects in the adeo-kafka-request-reply-asyncapi.yml example file.

The Kafka bindings JSON schema (v0.5.0) sets additionalProperties: false, which means x-* extension fields are not permitted inside Kafka binding objects — unlike core AsyncAPI objects that explicitly allow extensions.

The following invalid fields were removed:

  • x-key.subject.name.strategy from costingResponseChannel channel bindings
  • x-value.subject.name.strategy from costingResponseChannel channel bindings
  • x-value.subject.name.strategy from receiveACostingRequest operation bindings

The RecordNameStrategy context these fields described is already covered in the surrounding description prose, so no information is lost.


Related issue(s): #1164


Copilot AI review requested due to automatic review settings February 19, 2026 11:00
@sonarqubecloud
Copy link
Copy Markdown

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes invalid Kafka binding definitions in the adeo example file by removing x-extension fields that violate the Kafka bindings JSON schema v0.5.0. The schema specifies additionalProperties: false, which means x-* extension fields are not permitted within Kafka binding objects, unlike core AsyncAPI objects that explicitly allow extensions.

Changes:

  • Removed invalid x-key.subject.name.strategy and x-value.subject.name.strategy fields from the costingResponseChannel Kafka bindings
  • Removed invalid x-value.subject.name.strategy field from the receiveACostingRequest operation Kafka bindings
  • Changed quote style throughout the file from single to double quotes for $ref values and string literals

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

description: Kafka PRODUCTION cluster
security:
- $ref: '#/components/securitySchemes/sasl-ssl'
- $ref: "#/components/securitySchemes/sasl-ssl"
Copy link

Copilot AI Feb 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The quote style for $ref values has been changed from single quotes to double quotes throughout this file. However, all other AsyncAPI example files in the repository consistently use single quotes for $ref values. This change creates an inconsistency with the established convention. Consider reverting the quote style changes and keeping single quotes for $ref values (e.g., $ref: '#/...' instead of $ref: "#/...").

Copilot uses AI. Check for mistakes.
@wei123-web
Copy link
Copy Markdown

Hello! Just a heads up — a similar fix is already proposed in PR #1170.

@derberg
Copy link
Copy Markdown
Member

derberg commented Feb 24, 2026

Thanks for the contribution. I’m closing this PR because, while there is an existing issue, it was not approved or opened for contribution before the pull request was submitted.

Please make sure to follow the contribution guidelines, which explain when issues are considered ready for implementation and when pull requests are appropriate.

@derberg derberg closed this Feb 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants