Add schema for ControlInfoData.json#1630
Conversation
marcelwgn
left a comment
marcelwgn
left a comment
There was a problem hiding this comment.
Love the idea of adding a schema for this file. One thing about the descriptions, I think ideally we want to first name the intention of the property and then explain where it is used (if it is necessary to do that at all)
| "uniqueItems": true | ||
| }, | ||
| "Title": { | ||
| "type": "string", |
There was a problem hiding this comment.
I would probably write something like "The name of the control group. Will be displayed on the control group page and navigation".
Same for the other descriptions, I think ideally we should tell the intention of the property and then tell where it is being used.
| }, | ||
| "IsSpecialSection": { | ||
| "type": "boolean", | ||
| "description": "Special section is hard-coded in NavigationRootPage.xaml", |
There was a problem hiding this comment.
| "description": "Special section is hard-coded in NavigationRootPage.xaml", | |
| "description": "Indicates that this section is not a regular control section but is added to the navigation differently", |
| "type": "array", | ||
| "items": { | ||
| "type": "string", | ||
| "description": "Name of the related control" |
There was a problem hiding this comment.
| "description": "Name of the related control" | |
| "description": "ID of the related control" |
Add more description
|
@marcelwgn Did some changes to it, please review |
marcelwgn
left a comment
marcelwgn
left a comment
There was a problem hiding this comment.
Looks good to me, thank you for these changes!
|
/azp run |
1 similar comment
|
/azp run |
<!--- Provide a general summary of your changes in the Title above --> ## Description Same as #1630 ## Motivation and Context <!--- Why is this change required? What problem does it solve? --> <!--- If it fixes an open issue, please link to the issue here. --> ## How Has This Been Tested? Manual ## Screenshots (if appropriate): ## Types of changes <!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change)
3 participants
Description
I added a schema file for the
ControlInfoData.jsonto make adding new control / control group to it simpler. Now you get nice intellisense for all properties and error message for missing required ones. The schema should be automatically picked up by any reasonable editors.Motivation and Context
I just happens to know this.
How Has This Been Tested?
The current file reports no mismatch for this schema.
Screenshots (if appropriate):
Types of changes