fix: remove invalid x- fields from Kafka bindings in adeo example#1184
fix: remove invalid x- fields from Kafka bindings in adeo example#1184Anirudh-x wants to merge 1 commit intoasyncapi:masterfrom
Conversation
|
There was a problem hiding this comment.
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.strategyandx-value.subject.name.strategyfields from thecostingResponseChannelKafka bindings - Removed invalid
x-value.subject.name.strategyfield from thereceiveACostingRequestoperation 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" |
There was a problem hiding this comment.
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: "#/...").
|
Hello! Just a heads up — a similar fix is already proposed in PR #1170. |
|
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. |



Fix: remove invalid x- fields from Kafka bindings in adeo example
Remove
x-*extension fields from Kafka binding objects in theadeo-kafka-request-reply-asyncapi.ymlexample file.The Kafka bindings JSON schema (v0.5.0) sets
additionalProperties: false, which meansx-*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.strategyfromcostingResponseChannelchannel bindingsx-value.subject.name.strategyfromcostingResponseChannelchannel bindingsx-value.subject.name.strategyfromreceiveACostingRequestoperation bindingsThe RecordNameStrategy context these fields described is already covered in the surrounding
descriptionprose, so no information is lost.Related issue(s): #1164