Add custom speech apis by bexxx · Pull Request #13013 · Azure/azure-rest-api-specs

bexxx · 2021-02-17T15:45:03Z

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.

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: add swagger for existing GA APIs to this repo
When you are targeting to deploy new service/feature to public regions? APIs are GA already.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
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
- 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 · 2021-02-17T15:45:06Z

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. vsswagger@microsoft.com

openapi-workflow-bot · 2021-02-17T15:45:07Z

In the Window Period to fix mismatches between swagger and service, when PR is labelled with “FixS360”, breaking change can be approved by PR assignee; the Azure Breaking Change Board is no longer required to approve the PR. Please ensure to clarify what s360 action items to be solved, and @ mention PR assignee for awareness. Please check this wiki Window to Fix Broken for more details.

openapi-pipeline-app · 2021-02-17T16:12:41Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️LintDiff: 20 Warnings warning [Detail]

Only 10 items are listed, please refer to log for more details.

Linted configuring files (Based on source branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- Speech/SpeechToText/readme.md tag:release_3_0
- Speech/SpeechToText/readme.md tag:release_2_0
Linted configuring files (Based on target branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- Speech/SpeechToText/readme.md tag:default

Rule	Message
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v2.0/speechtotext.json#L4905
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v2.0/speechtotext.json#L5091
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v2.0/speechtotext.json#L5318
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v2.0/speechtotext.json#L5444
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v2.0/speechtotext.json#L5501
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v2.0/speechtotext.json#L5584
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v2.0/speechtotext.json#L5619
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v2.0/speechtotext.json#L5726
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v2.0/speechtotext.json#L5766
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: SpeechToText/stable/v3.0/speechtotext.json#L6218

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

Validation passes for Avocado.

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

️⚠️[Staging] SDK Track2 Validation: 2 Warnings warning [Detail]

The following tags are being changed in this PR

Rule	Message
⚠️ PreCheck/CheckDuplicateSchemas	"readme":"cognitiveservices/data-plane/Speech/SpeechToText/readme.md", "tag":"release_2_0", "details":"Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail."
⚠️ PreCheck/CheckDuplicateSchemas	"readme":"cognitiveservices/data-plane/Speech/SpeechToText/readme.md", "tag":"release_3_0", "details":"Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail."

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

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

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

openapi-pipeline-app · 2021-02-17T16:12:42Z

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

openapi-workflow-bot · 2021-02-17T16:14:25Z

Hi @bexxx, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

bexxx · 2021-03-05T06:16:34Z

@anuchandy This is an existing service (both versions are GA, v2 is now on the deprecation train) and we've been asked to publish the swaggers in this repo. The checks are green now. Please start reviewing the changes. Thanks!

bexxx · 2021-03-07T10:42:23Z

@anuchandy This PR is final from our side. Please merge in when possible. Thanks a lot!

Add custom speech apis

961e99d

bexxx requested a review from yangyuan as a code owner February 17, 2021 15:45

openapi-assignment-bot bot assigned anuchandy Feb 17, 2021

openapi-workflow-bot bot added the FixS360 label Feb 17, 2021

bexxx added 2 commits February 17, 2021 17:02

make prettier

07226d2

Fix spelling issues and add custom words

be05477

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Feb 17, 2021

bexxx added 2 commits February 17, 2021 17:46

Provide readme.md

d8c1b95

added go and js sdk

5a3156e

bexxx requested a review from ArcturusZhang as a code owner February 17, 2021 17:03

adding typescript

a1478e9

bexxx requested a review from qiaozha as a code owner February 17, 2021 17:38

make tag more verbose

a80a372

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Feb 18, 2021

fix duplicate schema names

9f06074

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Feb 18, 2021

do not use anonymous type

92cddc4

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Feb 18, 2021

name dictionaries

763c0b2

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Feb 18, 2021

Extract inline schemas

039edfa

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Mar 3, 2021

more fixes and prettier

b06a349

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Mar 3, 2021

Fix response example

f071c46

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Mar 3, 2021

moar fixes

2667849

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Mar 3, 2021

fix json issue

d63f9ef

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Mar 4, 2021

remove secret

9687c95

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Mar 4, 2021

add health status example

8e358d4

openapi-pipeline-app bot removed the CI-FixRequiredOnFailure label Mar 4, 2021

fixed encoding

35bdb34

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Mar 4, 2021

fix upload examples

dea9bc4

anuchandy approved these changes Mar 7, 2021

View reviewed changes

anuchandy merged commit e95bfe1 into Azure:master Mar 9, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add custom speech apis#13013

Add custom speech apis#13013
anuchandy merged 35 commits intoAzure:masterfrom
bexxx:bexxx/addCustomSpeechApis

bexxx commented Feb 17, 2021 •

edited

Loading

Uh oh!

openapi-workflow-bot bot commented Feb 17, 2021

Uh oh!

openapi-workflow-bot bot commented Feb 17, 2021

Uh oh!

openapi-pipeline-app bot commented Feb 17, 2021 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Feb 17, 2021 •

edited

Loading

Uh oh!

openapi-workflow-bot bot commented Feb 17, 2021

Uh oh!

bexxx commented Mar 5, 2021

Uh oh!

bexxx commented Mar 7, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

bexxx commented Feb 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot bot commented Feb 17, 2021

Uh oh!

openapi-workflow-bot bot commented Feb 17, 2021

Uh oh!

openapi-pipeline-app bot commented Feb 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented Feb 17, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openapi-workflow-bot bot commented Feb 17, 2021

Uh oh!

bexxx commented Mar 5, 2021

Uh oh!

bexxx commented Mar 7, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

bexxx commented Feb 17, 2021 •

edited

Loading

openapi-pipeline-app bot commented Feb 17, 2021 •

edited

Loading

openapi-pipeline-app bot commented Feb 17, 2021 •

edited

Loading