Skip to content
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.

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

Add support for using $ref and local files at any place in the asyncapi file #937

Closed
eivindga opened this issue May 23, 2023 · 8 comments
Closed
Labels
💡 Proposal (RFC 1) RFC Stage 1 (See CONTRIBUTING.md)

Comments

@eivindga
Copy link

eivindga commented May 23, 2023

Maintaining one big asyncapi-file with markdown, examples etc. is a major headache when it starts to grow. We have a lot of apis and developers who make frequent changes, and this causes a lot of additional work.

Please consider adding support for $ref (or another tag) to include local external files at any place in the structure, to improve maintainability.

Also see issue:
asyncapi/generator#963

@eivindga eivindga added the 💡 Proposal (RFC 1) RFC Stage 1 (See CONTRIBUTING.md) label May 23, 2023
@github-actions
Copy link

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.

@jonaslagoni
Copy link
Sponsor Member

Additional related issue: #778

@jonaslagoni
Copy link
Sponsor Member

Related to #868

@berry120
Copy link

berry120 commented Jun 9, 2023

Adding my use case to this one - we have one team who maintains a lot of separate APIs, and so there's many common elements between the different asyncapi docs that have to be duplicated (or pre-processed separately) without this functionality. Things like team contacts, reusable components like the server security scheme, etc.

@amelluk
Copy link

amelluk commented Jun 15, 2023

Related to asyncapi/parser-js#797 - adding my use case too. this feature is essential for us, when describing large apis

@baxterjo
Copy link

Adding my use case to this

@jonaslagoni
Copy link
Sponsor Member

Similar issue to #778

@smoya
Copy link
Member

smoya commented Mar 22, 2024

Closing in favour of #778

@smoya smoya closed this as completed Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💡 Proposal (RFC 1) RFC Stage 1 (See CONTRIBUTING.md)
Projects
None yet
Development

No branches or pull requests

6 participants