-
Notifications
You must be signed in to change notification settings - Fork 629
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Add schema for ControlInfoData.json #1630
Open
HO-COOH
wants to merge
2
commits into
microsoft:main
Choose a base branch
from
HO-COOH:chore/control-info-data-schema
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| { | ||
| "$schema": "ControlInfoDataSchema.json", | ||
| "Groups": [ | ||
| { | ||
| "UniqueId": "Design_Guidance", | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-04/schema#", | ||
| "type": "object", | ||
| "properties": { | ||
| "Groups": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object", | ||
| "properties": { | ||
| "UniqueId": { | ||
| "type": "string", | ||
| "description": "Globally unique id of this group", | ||
| "uniqueItems": true | ||
| }, | ||
| "Title": { | ||
| "type": "string", | ||
| "description": "The name of the control group. Will be displayed on the control group page and navigation" | ||
| }, | ||
| "Subtitle": { | ||
| "type": "string", | ||
| "description": "Not used. Can leave empty" | ||
| }, | ||
| "Description": { | ||
| "type": "string", | ||
| "description": "Not used. Can leave empty" | ||
| }, | ||
| "ImagePath": { | ||
| "type": "string", | ||
| "description": "Not used. Can leave empty" | ||
| }, | ||
| "IconGlyph": { | ||
| "type": "string", | ||
| "description": "Glyph of this control group. Will be displayed as an icon for the NavigationViewItem of this control group" | ||
| }, | ||
| "ApiNamespace": { | ||
| "type": "string", | ||
| "description": "ApiNamespace of a control group is not used. Can leave empty" | ||
| }, | ||
| "IsSpecialSection": { | ||
| "type": "boolean", | ||
| "description": "Indicates that this section is not a regular control section but is added to the navigation differently", | ||
| "default": true | ||
| }, | ||
| "Folder": { | ||
| "type": "string", | ||
| "description": "Use to indicate a special child item for this folder. Only used when IsSpecialSection is true" | ||
| }, | ||
| "Items": { | ||
| "type": "array", | ||
| "description": "Individual control info", | ||
| "items": { | ||
| "type": "object", | ||
| "properties": { | ||
| "UniqueId": { | ||
| "type": "string", | ||
| "description": "Globally unique id of this control", | ||
| "uniqueItems": true | ||
| }, | ||
| "Title": { | ||
| "type": "string", | ||
| "description": "Name of this control. Will be displayed in the overview card and on top of the control page of this control" | ||
| }, | ||
| "ApiNamespace": { | ||
| "type": "string", | ||
| "description": "Namespace of this control will appear below the tile on the control's detail page'" | ||
| }, | ||
| "Subtitle": { | ||
| "type": "string", | ||
| "description": "Brief usage of this control. Will be displayed on the overview card of this control" | ||
| }, | ||
| "Description": { | ||
| "type": "string", | ||
| "description": "Description of this control. Will be displayed on the control page, below the Title of this control" | ||
| }, | ||
| "ImagePath": { | ||
| "type": "string", | ||
| "description": "An image icon of this control. Will be displayed on the overriew card of this control. Should be a uri starts with ms-appx:///Assets/ControlImages/..." | ||
| }, | ||
| "IconGlyph": { | ||
| "type": "string", | ||
| "description": "Not used. Leave empty" | ||
| }, | ||
| "Content": { | ||
| "type": "string", | ||
| "description": "Not used. Leave empty" | ||
| }, | ||
| "IsNew": { | ||
| "type": "boolean", | ||
| "default": true, | ||
| "description": "Whether this is a newly added control. If true, it will be displayed in the Recently Added Sample section on the main page and will have a dot on the overview card of this control" | ||
| }, | ||
| "IsUpdated": { | ||
| "type": "boolean", | ||
| "default": true, | ||
| "description": "Whether the example page of this control has been updated lately. If true, it will be displayed in the Recently Updated Sample section on the main page and will have a dot on the overview card of this control" | ||
| }, | ||
| "Docs": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "object", | ||
| "properties": { | ||
| "Title": { | ||
| "type": "string", | ||
| "description": "Link name that appears in the Documentation dropdown" | ||
| }, | ||
| "Uri": { | ||
| "type": "string", | ||
| "description": "Documentation link url" | ||
| } | ||
| }, | ||
| "required": [ "Title", "Uri" ] | ||
| }, | ||
| "description": "Add a link to the doc in the Documentation dropdown on the detail page of this control" | ||
| }, | ||
| "RelatedControls": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string", | ||
| "description": "ID of the related control" | ||
| }, | ||
| "description": "Array of names of the related control" | ||
| } | ||
| }, | ||
| "required": [ "UniqueId", "Title"] | ||
| } | ||
| } | ||
| }, | ||
| "required": [ "UniqueId", "Title", "Items" ] | ||
| } | ||
| } | ||
| } | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.