search

meshery / meshery

Meshery, the cloud native manager
https://meshery.io
Apache License 2.0
5.55k stars 1.71k forks source link

[MeshModel]: Comment - Review validation rules #8495

Open leecalcote opened 1 year ago

leecalcote commented 1 year ago

Current Situation

I made a "Comment" in a design and added a number of entries. This resulted in a validation error (with no details of the error).

Proposed Change

Ensure strings validation logic. Investigate mismatch of field's Comment(2) (description) to comment-1 (index).

Schema Reference

Screenshot 2023-08-16 at 12 24 18 PM

Contributor Guides and Handbook

How to make updates to MeshModel

Instructions for Models

  1. Forthcoming

Instructions for Components

While the default shape for new components is a circle, each component should be considered for its best-fit shape.

  1. Review and familiarize with the available set of predefined relationship types. Refer the Cytoscape node types for a list of possible shapes.
  2. Propose a specific shape, best-suited to visually represent the Component. Example - Deployment as a pentagon.
  3. Proposee a specific icon, best-suited to visually represent the Component. Example - DaemonSet as a skull icon.

Instructions for Relationships

  1. Identify the relationship and any specific constraints to be enforced between the two specific components, their models or potentially other components, models, or environmental considerations.
  2. Propose a specific visual representation for the relationship. Visual representation examples: 1.1. Hierarchical 1.1. Sibling 1.1. Binding
  3. Prospose the appropriate relationship type, using one of the predefined set of relationship types or suggest a new relationship where an existing type does not fit.
  4. Create a Relationship Definition (yaml). See the Relationship Schema in MeshModel and examples.
  5. Create a policy for evaluation of the relationship (rego). See examples.

Instructions for Policies

  1. Forthcoming
stale[bot] commented 10 months ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] commented 8 months ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.