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

Component Definitions: Questions and suggested changes to be triaged. #170

Open
leecalcote opened this issue Sep 5, 2024 · 0 comments
Open
Labels
issue/willfix This issue will be worked on kind/question Further information is requested

Comments

@leecalcote
Copy link
Member

leecalcote commented Sep 5, 2024

In context of a Component definition:

  1. Suggestion: Open a GitHub issue regarding the "format": "JSON" property to ensure that this means that the format of the for describing this component's schema source type component and the format of the component's configuration.

  2. Question: Why is the more important kind buried under "component":, while the less important displayName and description are at the top level?

  3. Question: Can you export a Kubernetes resource at a particular ResourceVersion?

  4. Suggestion: There is no need for model in the component schema given that we only register the component in context of the model.

  5. Suggestion: "version": "core.meshery.io/v1alpha1" is self-referential in the case of Meshery core components. This should be optional.

  6. Suggestion: Capability $refs need to be downsized to only include the smallest set of properties needed to uniquely identify the resprective capability, therein avoiding repeating ourselves. Systems, like Meshery, that offer these capabilities can then use the $ref to lookup the full capability definition and save API requests by intelligently offering the full capability definition upon GET of a Component.

@leecalcote leecalcote added kind/question Further information is requested issue/willfix This issue will be worked on labels Sep 5, 2024
@leecalcote leecalcote changed the title Questions and suggested changes to be triaged. Component Definitions: Questions and suggested changes to be triaged. Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
issue/willfix This issue will be worked on kind/question Further information is requested
Projects
None yet
Development

No branches or pull requests

1 participant