Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add custom speech apis #13013

Merged
merged 35 commits into from
Mar 9, 2021
Merged

Add custom speech apis #13013

merged 35 commits into from
Mar 9, 2021

Conversation

bexxx
Copy link
Member

@bexxx bexxx commented Feb 17, 2021 •
edited
Loading

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

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.

@bexxx bexxx requested a review from yangyuan as a code owner February 17, 2021 15:45
@openapi-workflow-bot
Copy link

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

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

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

    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.

    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]

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

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

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

    @openapi-workflow-bot
    Copy link

    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.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
     If you need further help, please feedback via swagger feedback."

    @bexxx bexxx requested a review from ArcturusZhang as a code owner February 17, 2021 17:03
    @bexxx bexxx requested a review from qiaozha as a code owner February 17, 2021 17:38
    @bexxx
    Copy link
    Member Author

    bexxx commented Mar 5, 2021

    @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
    Copy link
    Member Author

    bexxx commented Mar 7, 2021

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

    @anuchandy anuchandy merged commit e95bfe1 into Azure:master Mar 9, 2021
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    @bexxx @mkarmark
    Add custom speech apis (Azure#13013)
    6e05978 
    * Add custom speech apis

* make prettier

* Fix spelling issues and add custom words

* Provide readme.md

* added go and js sdk

* adding typescript

* make tag more verbose

* fix duplicate schema names

* do not use anonymous type

* name dictionaries

* Extract inline schemas

* prettify again

* do not leak internal enum values

* suppress v2 incorrectly cased property names

* add suppressions for linter and clean up v2 schema

* fix go tags

* more go readme cleanups

* remove sdk generation

* do not use allof for schema references.

* adding examples

* prettify

* remove spaces in example file names

* use correct examples extension name

* Added updated examples

* Fix file name

* Fix 204 response body

* more fixes and prettier

* Fix response example

* moar fixes

* fix json issue

* remove secret

* add health status example

* fixed encoding

* fix upload examples
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @anuchandy anuchandy anuchandy approved these changes

    @yangyuan yangyuan Awaiting requested review from yangyuan yangyuan is a code owner

    @ArcturusZhang ArcturusZhang Awaiting requested review from ArcturusZhang

    @qiaozha qiaozha Awaiting requested review from qiaozha

    Assignees

    @anuchandy anuchandy

    Labels
    FixS360
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @bexxx @anuchandy