Skip to content

fix: allow excess protocol-specific fields on Binding (issue #735) #1228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tzh476 wants to merge 2 commits into
base: master
Choose a base branch
from
+18 −0
Open

fix: allow excess protocol-specific fields on Binding (issue #735) #1228

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e14e72
fix: allow excess protocol-specific fields on Binding (issue #735)
tzh476 Aug 23, 2026
e365630
chore: changeset for #735
tzh476 Aug 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/parser/src/spec-types/v2.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,8 @@ export interface CorrelationIDObject extends SpecificationExtensions {

export interface Binding {
bindingVersion?: string;
// protocol-specific binding fields (excess properties)
[propName: string]: any;
}

export interface SpecificationExtensions {
Expand Down
2 changes: 2 additions & 0 deletions packages/parser/src/spec-types/v3.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,6 +484,8 @@ export interface AsyncAPISchemaDefinition extends SpecificationExtensions {

export interface Binding {
bindingVersion?: string;
// protocol-specific binding fields (excess properties)
[propName: string]: any;
}

export interface SpecificationExtensions {
Expand Down
9 changes: 9 additions & 0 deletions packages/parser/test/models/v2/bindings.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,13 @@ describe('Bindings model', function () {
expect(bindings.extensions().get('x-anotherOne')?.value()).toEqual({ someKey: 123 });
});
});

describe('excess properties (issue #735)', function () {
it('should preserve protocol-specific excess fields on a binding value', function () {
const b = new Binding({ clientId: 'my-client', clean: true } as any, { asyncapi: {} as any, pointer: '', protocol: 'mqtt' });
const value = b.value() as Record<string, any>;
expect(value).toHaveProperty('clientId', 'my-client');
expect(value).toHaveProperty('clean', true);
});
});
});
Loading