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

Make compatiblewith an URI and improve description #281

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

Fannon
Copy link
Contributor

@Fannon Fannon commented Mar 19, 2025

Fixes #276

  • make it a URI
  • MUST reference/represent an xRegistry model definition

TODO

  • How to make it a spec-defined optional attribute?
  • Can we deep-link to a model group like "endpoints"?
  • What would be the final links to the official xRegistry standardized models?

@duglin
Copy link
Contributor

duglin commented Mar 19, 2025

didn't you want to make this a top-level optional attribute instead of a label?

@Fannon
Copy link
Contributor Author

Fannon commented Mar 20, 2025

didn't you want to make this a top-level optional attribute instead of a label?

I did the change now. Also added it to the model.json files. Is it correct in that way? Looks like I broke some python script.

As URI, I went with the github raw file links

}, ?
"createdat": "TIMESTAMP",
"modifiedat": "TIMESTAMP",
"modelversion": "1.0", ?
Copy link
Contributor

Choose a reason for hiding this comment

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

this needs to be "STRING"
and the next one "URI"
because at this point in the spec we're just defining the abstract model. I don't think we want to imply that these are the values they MUST be for all implementations.

Also, I think these needs to be under "model", not at the root of the registry

@@ -3,6 +3,8 @@
"endpoints": {
"singular": "endpoint",
"plural": "endpoints",
"modelversion": "1.0",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
"modelversion": "1.0",
"modelversion": "0.5",

Fannon and others added 7 commits March 21, 2025 14:22
Signed-off-by: Simon Heimler <[email protected]>
Signed-off-by: Simon Heimler <[email protected]>
Signed-off-by: Simon Heimler <[email protected]>
Signed-off-by: Simon Heimler <[email protected]>
Signed-off-by: Simon Heimler <[email protected]>
@Fannon Fannon force-pushed the improve-compatiblewith-description branch from d6302bf to dfde835 Compare March 21, 2025 13:23

- Constraints:
- OPTIONAL.
- Only applicable on model definition.
Copy link
Contributor

Choose a reason for hiding this comment

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

you can delete the above line


- Constraints:
- OPTIONAL.
- Only applicable on model definition.
Copy link
Contributor

Choose a reason for hiding this comment

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

you can delete the above line

- Only applicable on model definition.
- Does not imply runtime validation of the claim.

- examples:
Copy link
Contributor

Choose a reason for hiding this comment

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

Examples:
(cap E)

"modelversion": "1.0", ?
"compatiblewith": "https://github.com/xregistry/spec/blob/main/schema/spec.md", ?
"STRING": "STRING" *
"STRING": "STRING" *
Copy link
Contributor

Choose a reason for hiding this comment

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

outdent 2 spaces

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.

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