Minor fixes to the settings schema#19387
Minor fixes to the settings schema#19387DHowett merged 6 commits intomicrosoft:mainfrom ralish:schema-fixes
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.
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.
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