Bulk doc update of Speech to text API v3.0

[bexxx]

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

1. What's the purpose of the update?
   • new service onboarding
   • new API version
   • update existing version for new feature
   • update existing version to fix swagger quality issue in s360
   • Other, please clarify: Documentation and example updates
2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
   Code is already deployed, this is just a doc update.
3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
   ASAP
4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
   • SDK of .NET (need service team to ensure code readiness)
   • SDK of Python
   • SDK of Java
   • SDK of Js
   • SDK of Go
   • PowerShell
   • CLI
   • Terraform
   • No, no need to refresh for updates in this PR

Contribution checklist:

• I commit to follow the Breaking Change Policy of "no breaking changes"
• I have reviewed the documentation for the workflow.
• Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

• Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

  • Adding new API(s)
  • Adding a new API version
  • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
  • Adding a new service

• Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

• If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

• Removing API(s) in stable version
• Removing properties in stable version
• Removing API version(s) in stable version
• Updating API in stable or public preview version with Breaking Change Validation errors
• Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

[openapi-workflow-bot]

Hi, @bexxx Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

[openapi-workflow-bot]

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

[openapi-pipeline-app]

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]

• Compared Swaggers (Based on Oad v0.8.11)
  • current:stable/v3.0/speechtotext.json compared with base:stable/v3.0/speechtotext.json

Rule	Message
❌ 1011 - AddingResponseCode	The new version adds a response code '503'. New: SpeechToText/stable/v3.0/speechtotext.json#L6158:11

️⚠️LintDiff: 0 Warnings warning [Detail]

• Linted configuring files (Based on source branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
  • Speech/SpeechToText/readme.md tag:release_3_0
• Linted configuring files (Based on target branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
  • Speech/SpeechToText/readme.md tag:release_3_0

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v3.0/speechtotext.json#L6227
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v3.0/speechtotext.json#L6392
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v3.0/speechtotext.json#L6534
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v3.0/speechtotext.json#L6665
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v3.0/speechtotext.json#L6890
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v3.0/speechtotext.json#L7061
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v3.0/speechtotext.json#L7211
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v3.0/speechtotext.json#L7424
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v3.0/speechtotext.json#L7591
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v3.0/speechtotext.json#L7779
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v3.0/speechtotext.json#L7956

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

• The following tags are being changed in this PR
• cognitiveservices/data-plane/Speech/SpeechToText/readme.md#release_3_0

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/Speech/SpeechToText/readme.md",
"tag":"release_3_0",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/Speech/SpeechToText/readme.md",
"tag":"release_3_0",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|

The following errors/warnings exist before current PR submission:

|:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/Speech/SpeechToText/readme.md",
"tag":"release_3_0",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app]

Swagger pipeline restarted successfully, please wait for status update in this comment.

[openapi-workflow-bot]

Hi @bexxx, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

[bexxx]

@jhendrixMSFT the "new" response code was always returned and missed to be documented when the initial v3.0 swagger version was published.

So currently we could break customers by sending unexpected response codes and we try fixing this by documenting the one.
This is used mainly during our rollouts to see whether we can swap the deployments to a new version, I could not monitor external requests against this route. The route is a healthcheck, not core functionality.

[ghost]

Hi, @bexxx. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

[mkistler]

I really believe the 503 response is incorrect and should be changed, but I'm willing to listen to a good explanation of why that's not the case.

[mikekistler]

Looks good. 👍

[jhendrixMSFT]

I just noticed these changes are in a stable swagger. @johanste is this acceptable? Has the service been deployed yet?

[Fraegle]

@jhendrixMSFT

I just noticed these changes are in a stable swagger. @johanste is this acceptable? Has the service been deployed yet?

The service is already deployed with this behavior. We just missed to document it in Swagger.

[bexxx]

@jhendrixMSFT how can we close on this?
The function here has been approved after the explanation that this is the health route. We also have a breaking change approval from the azure review board. What else is blocking the merge of this PR? Thanks.