Add schema for ControlInfoData.json #1630
Open
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
marcelwgn
requested changes
Nov 2, 2024
| "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.
Suggested change
| "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.
Suggested change
| "description": "Name of the related control" | |
| "description": "ID of the related control" |
Add more description
|
@marcelwgn Did some changes to it, please review |
marcelwgn
approved these changes
Nov 5, 2024
|
/azp run |
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
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