Skip to content

Conversation

@ralish
Copy link
Contributor

@ralish ralish commented Sep 27, 2025

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

  • Schema updated (if necessary)

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.
Copy link
Member

@carlos-zamora carlos-zamora left a 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?

@ralish
Copy link
Contributor Author

ralish commented Sep 30, 2025

@microsoft-github-policy-service agree

Copy link
Member

@carlos-zamora carlos-zamora left a 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!

@ralish
Copy link
Contributor Author

ralish commented Oct 3, 2025

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:

  • Permit null for the language settings (consistent with the default)
  • Add the missing experimental.rainbowSuggestions setting (added in v1.22)

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!

@DHowett
Copy link
Member

DHowett commented Oct 3, 2025

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.

@DHowett DHowett merged commit fc2d107 into microsoft:main Oct 3, 2025
6 checks passed
@ralish ralish deleted the schema-fixes branch October 25, 2025 04:11
@github-project-automation github-project-automation bot moved this to To Cherry Pick in 1.24 Servicing Pipeline Dec 17, 2025
@github-project-automation github-project-automation bot moved this to To Cherry Pick in 1.23 Servicing Pipeline Dec 17, 2025
@DHowett DHowett moved this from To Cherry Pick to Cherry Picked in 1.23 Servicing Pipeline Dec 17, 2025
@DHowett DHowett moved this from To Cherry Pick to Cherry Picked in 1.24 Servicing Pipeline Dec 17, 2025
DHowett pushed a commit that referenced this pull request Dec 17, 2025
## 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
DHowett pushed a commit that referenced this pull request Dec 17, 2025
## 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Cherry Picked
Status: Cherry Picked

Development

Successfully merging this pull request may close these issues.

3 participants