Skip to content

feat: configurable processing of circular reference#202

Open
412b wants to merge 2 commits intoasyncapi:masterfrom
412b:feature/more-fine-grained-control-over-dereference
Open

feat: configurable processing of circular reference#202
412b wants to merge 2 commits intoasyncapi:masterfrom
412b:feature/more-fine-grained-control-over-dereference

Conversation

@412b
Copy link
Copy Markdown

@412b 412b commented Jun 26, 2025

Description
This PR address missing feature/support of circular references in any way.
Intent is to keep default behavior as close as possible to previous one unless cases, when specific option is provided to handle circular references.

Related issue(s)
Resolves #201

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide 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.

@412b 412b force-pushed the feature/more-fine-grained-control-over-dereference branch from 46d69fb to 33cf973 Compare June 26, 2025 16:59
@412b
Copy link
Copy Markdown
Author

412b commented Jun 26, 2025

@Souvikns @aeworxet please take a look. docs to be updated, when the conceptual approach is accepted.
there are, of course, some drawbacks/compromises here, which are consequences of missing features in json-schema-ref-parser.

@412b 412b force-pushed the feature/more-fine-grained-control-over-dereference branch from 0cdfa24 to f2fb9e3 Compare June 27, 2025 15:46
@sonarqubecloud
Copy link
Copy Markdown

@sonarqubecloud
Copy link
Copy Markdown

@Souvikns
Copy link
Copy Markdown
Member

does @asyncapi/parser accepts this as a valid schema, can you validate it and comment the output.

@aeworxet
Copy link
Copy Markdown
Collaborator

This PR is not relevant at this time.

The NPM package @apidevtools/json-schema-ref-parser was updated to v14.2.1 to include the required functionality in #214.

Support for Node.js versions earlier than v24 was removed in #216, resulting in the release of MAJOR version 1.0.1.

A waiting period for users to adopt these changes is currently in effect.

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.

[FEATURE] Bundler to have more flexible and configurable behavior for circular refs

3 participants