-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Add notes about untrusted data in System.Speech API docs #12058
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
Add notes about untrusted data in System.Speech API docs #12058
Conversation
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.
Pull Request Overview
This PR adds security documentation notes about handling untrusted data across various System.Speech API documentation files. The changes use include files to provide consistent warnings about security considerations when working with external data sources.
- Adds untrusted data warnings to speech synthesis and recognition classes
- Replaces existing security guidance with standardized include notes
- Applies appropriate note types (class-level, instance-level, and interface-level warnings)
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| xml/System.Speech.Synthesis/SpeechSynthesizer.xml | Adds class-level untrusted data warnings for lexicon-related methods |
| xml/System.Speech.Synthesis/PromptBuilder.xml | Adds class-level untrusted data warnings for prompt building methods |
| xml/System.Speech.Synthesis/FilePrompt.xml | Adds instance-level untrusted data warnings to class and constructor documentation |
| xml/System.Speech.Synthesis.TtsEngine/TtsEngineSsml.xml | Adds class-level untrusted data warnings for AddLexicon and RemoveLexicon methods |
| xml/System.Speech.Synthesis.TtsEngine/ITtsEngineSite.xml | Adds interface-level untrusted data warning to LoadResource method |
| xml/System.Speech.Recognition/Grammar.xml | Replaces existing security guidance with instance-level untrusted data warnings across multiple constructors |
| xml/System.Speech.Recognition.SrgsGrammar/SrgsRuleRef.xml | Adds instance-level untrusted data warnings to class and multiple constructors |
| xml/System.Speech.Recognition.SrgsGrammar/SrgsDocument.xml | Adds instance-level untrusted data warning to XmlBase property documentation |
Co-authored-by: Copilot <[email protected]>
pranav-gupta-msft
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.
LGTM
No description provided.