feat: new schema reference object to enable nonjson refs in future

[derberg]

PS. Let's pretend I created a branch in a fork, and not upstream, ok? 😅

---

Breaking Change

It must target 3.0

---

This PR is a result of:

• feat: rename $ref to ref #912 (comment)
• https://youtu.be/O4TQWBEaXy0?t=2213
• trying to make spec future-proof in case we would like to enable referencing schemas from nonJSON structures

What you see here is that Reference Object gets some more clarification and there is new Schema Reference Object that allows to have specification extensions.

[github-advanced-security]

You have successfully added a new SonarCloud configuration ``. As part of the setup process, we have scanned this repository and found no existing alerts. In the future, you will see all code scanning alerts on the repository Security tab.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[dalelane]

LGTM

[derberg]

keeping it open, but looks like it is not needed for 3.0 and will be done in 3.1

[github-actions]

This pull request has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation.

There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this pull request forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[jemacineiras]

Hi team,
Seeing this PR I am just curious about how AsyncApi V3 will handle Schemas Registry configuration for external schemas definition storage, like Avro, Protobuf or also Json Schema.
I had build some tools to generate code base on AsyncApi definition and some for testing, mostly of them support definition of schemas using the $Ref approach but then it came to have the schema definition in a place like Confluent Schema Registry, ApiCurio Schema Registry, Azure Schema Registry and so, I don't find it.
I was thinking about how it can be solved, and looks a complex problem since base on your infrastructure you can have one schema registry server, or several, base on your environments.
I think this is something it should be kept in mind, since mostly of the people share AsyncApi documents between applications in order to generate code base on (myself have a small tool who create code where you can combine OpenApi and AsyncAp definitions).
If you wish I can open a suggestion base on this PR.. a PR base on a PR.. looks naughty.
Can you give me any light about?

[github-actions]

This pull request has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation.

There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this pull request forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[derberg]

I'm closing it for now as it requires fresh look once we start working on it