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

Clarification: Should compatiblewith just be a label or a top-level property in the meta-model? #276

Open
Fannon opened this issue Mar 7, 2025 · 1 comment · May be fixed by #281
Open
Labels
AddToSpec v1 Required to be resolved for v1

Comments

@Fannon
Copy link
Contributor

Fannon commented Mar 7, 2025

The compatiblewith feature is currently just a label in the metamodel and not a top-level property of the metamodel.

The information that a model is compatible to a shared model understanding is really important to get interoperability beyond the own xRegistry scope and make a shared ecosystem around the model standard possible.

I wonder if this is obvious enough, as understanding that one model in xRegistry A is compatible with another Model in xRegistry B (usually via the same shared model contract, e.g. the CNCF Domain Specific Specifications) is crucial.

It would be helpful if a model export / import can carry this information and that the implications of it are clear to the xRegistry admins. Not sure if the current solution via labels is good enough for this or not, @duglin could judge better.

What I worry about: Let's say a company hosts their own xRegistry server and imports the message definitions model and customize it. How would an external xRegistry or consumer know that the model is compatible with their own understanding? It is possible to customize models in a way that they are not interoperable anymore. In that case, it would not be possible to use a shared ecosystem around that model (like we can do for OpenAPI / AsyncAPI).

@duglin duglin added the v1 Required to be resolved for v1 label Mar 13, 2025
@duglin
Copy link
Contributor

duglin commented Mar 18, 2025

Proposal:

  • make it a URI
  • MUST reference/represent an xRegistry model definition
  • make it a spec-defined optional attribute

@Fannon Fannon linked a pull request Mar 19, 2025 that will close this issue
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
AddToSpec v1 Required to be resolved for v1
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants