-
Notifications
You must be signed in to change notification settings - Fork 9k
Minor fixes to the settings schema #19387
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Specifically: - answerbackMessage Permit null type (corresponds to the default value). - compatibility.input.forceVT Add missing setting (previously "experimental.input.forceVT"). - rendering.graphicsAPI Add missing "automatic" enumeration value.
carlos-zamora
left a comment
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.
Thanks for doing this! Can you update the deprecated key below?
|
@microsoft-github-policy-service agree |
carlos-zamora
left a comment
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.
Cross-referenced with settings model serialization code. Added a few suggestions for clarity.
Thank you so much for doing this!
|
Sorry for the extra commits but I noticed a couple of additional issues in the schema after updating to v1.23.12681. Since this isn't merged yet I've just added them in rather than open a separate PR. The additional two commits:
I'd also be open to performing a broader tidy-up of the settings schema as it's a bit of a mess, but that would result in a lot of churn in the diff (even if the net changes aren't necessarily significant), so I'll avoid doing that unless there's actual interest. I'm a big fan of having the JSON schema though and wish more projects adopted them for settings documentation and validation! |
|
Thanks so much for doing this! I would love for somebody to take a close look at our schema. It is often an afterthought unfortunately, and it should be a first class UI. |
## Summary of the Pull Request Fixes a couple of minor issues in the settings schema which can result in erroneous settings validation failures. ## References and Relevant Issues None ## Detailed Description of the Pull Request / Additional comments - `answerbackMessage` Permit `null` type (corresponds to the default value). - `compatibility.input.forceVT` Add missing setting (previously was `experimental.input.forceVT`). - `rendering.graphicsAPI` Add missing `automatic` enumeration value. - Mark several settings as deprecated using the same format and direct the user to the updated settings to use. ## Validation Steps Performed Tested updated schema against configuration with above settings present. ## PR Checklist - [X] Schema updated (if necessary) --------- Co-authored-by: Carlos Zamora <carlos.zamora@microsoft.com> (cherry picked from commit fc2d107) Service-Card-Id: PVTI_lADOAF3p4s4AxadtzgirMyY Service-Version: 1.23
## Summary of the Pull Request Fixes a couple of minor issues in the settings schema which can result in erroneous settings validation failures. ## References and Relevant Issues None ## Detailed Description of the Pull Request / Additional comments - `answerbackMessage` Permit `null` type (corresponds to the default value). - `compatibility.input.forceVT` Add missing setting (previously was `experimental.input.forceVT`). - `rendering.graphicsAPI` Add missing `automatic` enumeration value. - Mark several settings as deprecated using the same format and direct the user to the updated settings to use. ## Validation Steps Performed Tested updated schema against configuration with above settings present. ## PR Checklist - [X] Schema updated (if necessary) --------- Co-authored-by: Carlos Zamora <carlos.zamora@microsoft.com> (cherry picked from commit fc2d107) Service-Card-Id: PVTI_lADOAF3p4s4BBcTlzgirMyU Service-Version: 1.24
Summary of the Pull Request
Fixes a couple of minor issues in the settings schema which can result in erroneous settings validation failures.
References and Relevant Issues
None
Detailed Description of the Pull Request / Additional comments
answerbackMessagePermit
nulltype (corresponds to the default value).compatibility.input.forceVTAdd missing setting (previously was
experimental.input.forceVT).rendering.graphicsAPIAdd missing
automaticenumeration value.Validation Steps Performed
Tested updated schema against configuration with above settings present.
PR Checklist