Design schema #97
Merged
Design schema #97
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MUzairS15
commented
Jul 4, 2024
MUzairS15
force-pushed
the
MUzairS15/designschema-draft
branch
from
52aa0bb
to
92162e1
Compare
Signed-off-by: MUzairS15 <[email protected]>
Signed-off-by: MUzairS15 <[email protected]>
Signed-off-by: MUzairS15 <[email protected]>
MUzairS15
force-pushed
the
MUzairS15/designschema-draft
branch
from
92162e1
to
cf48705
Compare
|
Updated. |
leecalcote
reviewed
Jul 17, 2024
leecalcote
reviewed
Jul 17, 2024
leecalcote
reviewed
Jul 17, 2024
leecalcote
reviewed
Jul 17, 2024
Comment on lines
+73
to
+86
| "type": "object", | ||
| "description": "Optional selectors used to define relationships which should not be created / is restricted.", | ||
| "required": [ | ||
| "to", | ||
| "from" | ||
| ], | ||
| "properties": { | ||
| "from": { | ||
| "$ref": "./selectors.json#/definitions/from" | ||
| }, | ||
| "to": { | ||
| "$ref": "./selectors.json#/definitions/to" | ||
| } | ||
| } |
There was a problem hiding this comment.
This can be replaced with a selector $ref.
| "description": "Reusable relationships selectors schema elements", | ||
| "$comment": "Sets of selectors are interpreted as a locical OR, while sets of allow/deny are interpreted a logical AND.", | ||
| "definitions": { | ||
| "from": { |
There was a problem hiding this comment.
Consolidate "from" and "to" into a single selector definition.
leecalcote
reviewed
Jul 17, 2024
| "additionalProperties": false, | ||
| "properties": { | ||
| "kind": { | ||
| "type": "string" |
leecalcote
reviewed
Jul 17, 2024
| } | ||
| } | ||
| }, | ||
|
|
There was a problem hiding this comment.
Relationships required? Can be nil?
A valid design can just have one component with no relationships.
Is there value in requiring relationships?
leecalcote
reviewed
Jul 17, 2024
schemas/constructs/core.json
Outdated
| }, | ||
| "declarationID": { | ||
| "$ref": "#/definitions/uuid", | ||
| "description": "Uniquely identifies the component/relationship declaration in the deisgn file." |
There was a problem hiding this comment.
Remove declarationID entirely.
leecalcote
reviewed
Jul 17, 2024
leecalcote
reviewed
Jul 17, 2024
| "description": "Specifies the version of the definition." | ||
| }, | ||
| "kind": { | ||
| "$ref": "./core.json#/definitions/inputString", | ||
| "$ref": "../core.json#/definitions/inputString", | ||
| "description": "Kind of the Relationship.", | ||
| "enum": [ | ||
| "hierarchical", |
There was a problem hiding this comment.
Do these enums need to be Capitalized?
leecalcote
reviewed
Jul 17, 2024
Signed-off-by: Lee Calcote <[email protected]>
leecalcote
reviewed
Jul 17, 2024
schemas/constructs/core.json
Outdated
Comment on lines
30
to
33
| "declarationID": { | ||
| "$ref": "#/definitions/uuid", | ||
| "description": "Uniquely identifies the component/relationship declaration in the deisgn file." | ||
| }, |
There was a problem hiding this comment.
Suggested change
| "declarationID": { | |
| "$ref": "#/definitions/uuid", | |
| "description": "Uniquely identifies the component/relationship declaration in the deisgn file." | |
| }, |
leecalcote
reviewed
Jul 17, 2024
| "description": "Model of the component. Learn more at https://docs.meshery.io/concepts/models" | ||
| }, | ||
| "declarationID": { | ||
| "$ref": "../core.json#/definitions/declarationID" |
There was a problem hiding this comment.
Suggested change
| "$ref": "../core.json#/definitions/declarationID" | |
| "$ref": "../core.json#/definitions/uuid" |
leecalcote
reviewed
Jul 17, 2024
| "additionalProperties": false, | ||
| "properties": { | ||
| "declarationID": { | ||
| "$ref": "../core.json#/definitions/declarationID" |
There was a problem hiding this comment.
Suggested change
| "$ref": "../core.json#/definitions/declarationID" | |
| "$ref": "../core.json#/definitions/uuid" |
leecalcote
reviewed
Jul 17, 2024
| "type": "object", | ||
| "additionalProperties": false, | ||
| "properties": { | ||
| "declarationID": { |
There was a problem hiding this comment.
Suggested change
| "declarationID": { | |
| "declarationID": { | |
| "description": "Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design) or as an instance (i.e. view)." |
leecalcote
reviewed
Jul 17, 2024
| "$ref": "../v1beta1/model.json", | ||
| "description": "Model of the component. Learn more at https://docs.meshery.io/concepts/models" | ||
| }, | ||
| "declarationID": { |
There was a problem hiding this comment.
Suggested change
| "declarationID": { | |
| "declarationID": { | |
| "description": "Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design) or as an instance (i.e. view)." |
leecalcote
reviewed
Jul 17, 2024
leecalcote
reviewed
Jul 17, 2024
| "description": "List of component declarations", | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "./component.json" |
There was a problem hiding this comment.
Shouldn't this have a schemaVersion reference?
leecalcote
reviewed
Jul 17, 2024
| "id": { | ||
| "description": "Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design)." | ||
| "$ref": "../core.json#/definitions/uuid" | ||
| }, | ||
| "schemaVersion": { | ||
| "$ref": "../v1alpha2/core.json#/definitions/versionString", |
There was a problem hiding this comment.
Suggested change
| "$ref": "../v1alpha2/core.json#/definitions/versionString", | |
| "$ref": "../core.json#/definitions/versionString", |
Signed-off-by: Lee Calcote <[email protected]>
Signed-off-by: Lee Calcote <[email protected]>
Signed-off-by: Lee Calcote <[email protected]>
Signed-off-by: Lee Calcote <[email protected]>
leecalcote
reviewed
Jul 17, 2024
| "properties": { | ||
| "declarationID": { | ||
| "$ref": "../core.json#/declarationID" | ||
| }, |
There was a problem hiding this comment.
@MUzairS15, @aabidsofi19, @humblenginr, what is this ID in context of the fact that there is a component ID on line 87?
Signed-off-by: Lee Calcote <[email protected]>
Signed-off-by: Mohd Uzair <[email protected]>
Signed-off-by: Lee Calcote <[email protected]>
Signed-off-by: Lee Calcote <[email protected]>
leecalcote
reviewed
Jul 25, 2024
Signed-off-by: Lee Calcote <[email protected]>
Signed-off-by: Lee Calcote <[email protected]>
This was referenced Jul 25, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Notes for Reviewers
This PR fixes #102 #103 #104
Signed commits