Fhaghbin/error #28987

fhaghbin-msft · 2024-05-06T16:27:32Z

Data Plane API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

Link to API Spec engagement record issue:

Is this review for (select one):

a private preview
a public preview
GA release

Change Scope

^{This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.}

Design Document:
Previous API Spec Doc:
Updated paths:

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

💬 Teams Channel
💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Open API validation tools were run on this PR. Go here to see how to fix errors
Spectral Linting

Guidelines & Specifications

Helpful Links

Schedule a data plane REST API spec review

Getting help

First, please carefully read through this PR description, from top to bottom.
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

- Usage: `npx get-suppressions <tool-name> <path-to-file>` - Returns: JSON array of suppressions, with specified tool name, applying to file (may be empty) - Example: `npm get-suppressions TypeSpecRequirement specification/foo/data-plane/Foo/stable/2023-01-01/Foo.json` - Fixes #28069

…ller (#28895) * Add transcription APIs to beta4 controller * Fix the spec file * Fix the json format

* update swagger with interrupt call media operation flag * ran prettier to fix indentation --------- Co-authored-by: Paresh Arvind Patil <papati@microsoft.com>

openapi-pipeline-app · 2024-05-06T16:27:36Z

Next Steps to Merge

⌛ Please wait. Next steps to merge this PR are being evaluated by automation. ⌛

openapi-pipeline-app · 2024-05-06T16:27:36Z

Swagger Validation Report

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

There are no breaking changes.

️⌛Breaking Change(Cross-Version) pending [Detail]

️⌛LintDiff pending [Detail]

️⌛Avocado pending [Detail]

️⌛SwaggerAPIView pending [Detail]

️⌛TypeSpecAPIView pending [Detail]

️⌛ModelValidation pending [Detail]

️⌛SemanticValidation pending [Detail]

️⌛SpellCheck pending [Detail]

️⌛PR Summary pending [Detail]

️⌛Automated merging requirements met pending [Detail]

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

openapi-pipeline-app · 2024-05-06T16:27:37Z

Swagger Generation Artifacts

️⌛ApiDocPreview pending [Detail]

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

openapi-pipeline-app · 2024-05-06T16:27:37Z

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

* Added beta4 * added readme * Adding Hold/Unhold (#28853) * added missing events (#28866) * Add transcription start, stop, update, get state APIs to beta4 controller (#28895) * Add transcription APIs to beta4 controller * Fix the spec file * Fix the json format * Update swagger with InterruptCallMediaOperation flag fix (#28925) * update swagger with interrupt call media operation flag * ran prettier to fix indentation --------- Co-authored-by: Paresh Arvind Patil <papati@microsoft.com> * Fix based on feedbacks (#28986) * Fhaghbin/error (#28987) * [suppressions.yaml] Create shared component "get-suppressions" (#28927) - Usage: `npx get-suppressions <tool-name> <path-to-file>` - Returns: JSON array of suppressions, with specified tool name, applying to file (may be empty) - Example: `npm get-suppressions TypeSpecRequirement specification/foo/data-plane/Foo/stable/2023-01-01/Foo.json` - Fixes #28069 * fix: Java/csharp model client names (#28978) * Added beta4 * added readme * Adding Hold/Unhold (#28853) * added missing events (#28866) * Add transcription start, stop, update, get state APIs to beta4 controller (#28895) * Add transcription APIs to beta4 controller * Fix the spec file * Fix the json format * Update swagger with InterruptCallMediaOperation flag fix (#28925) * update swagger with interrupt call media operation flag * ran prettier to fix indentation --------- Co-authored-by: Paresh Arvind Patil <papati@microsoft.com> * Fix format * Fix error --------- Co-authored-by: Mike Harder <mharder@microsoft.com> Co-authored-by: Asaf Levi <100200009+asaflevi-ms@users.noreply.github.com> Co-authored-by: Franko Morales <67804607+cochi2@users.noreply.github.com> Co-authored-by: arupdutta-msft <87995153+arupdutta-msft@users.noreply.github.com> Co-authored-by: Paresh Arvind Patil <patilaparesh@gmail.com> Co-authored-by: Paresh Arvind Patil <papati@microsoft.com> * Fix pretier (#28990) * Add BETA4 changes for transcription public preview (#28993) * Add beta4 transcription feedback rework * Add transcription beta4 examples * Fix prettier * Fix StopTranscription response code * Fix errors (#29005) * Fix spelling (#29006) * Fix the description (#29037) * Added suppression for LroExtension (#29072) * rename mediaStreamingUpdateResult to mediaStreamingUpdate (#29090) * [Call Automation] Create Connect interface (#29075) * update swagger and add sample for Connect * update description * add description for call locator * update description for connectFailed event * rename ConnectCall to Connect in example * update description * fix style * adding operation context * revert renaming mediaStreamingUpdateResult * fix example * make change to re-trigger pipelines * add back the rename from base branch --------- Co-authored-by: James Deng (ACS) <jamesdeng@microsoft.com> --------- Co-authored-by: Franko Morales <67804607+cochi2@users.noreply.github.com> Co-authored-by: arupdutta-msft <87995153+arupdutta-msft@users.noreply.github.com> Co-authored-by: Paresh Arvind Patil <patilaparesh@gmail.com> Co-authored-by: Paresh Arvind Patil <papati@microsoft.com> Co-authored-by: Mike Harder <mharder@microsoft.com> Co-authored-by: Asaf Levi <100200009+asaflevi-ms@users.noreply.github.com> Co-authored-by: elavarasid <101957302+elavarasidc@users.noreply.github.com> Co-authored-by: James Deng (ACS) <jamesdeng@microsoft.com>

* Added beta4 * added readme * Adding Hold/Unhold (Azure#28853) * added missing events (Azure#28866) * Add transcription start, stop, update, get state APIs to beta4 controller (Azure#28895) * Add transcription APIs to beta4 controller * Fix the spec file * Fix the json format * Update swagger with InterruptCallMediaOperation flag fix (Azure#28925) * update swagger with interrupt call media operation flag * ran prettier to fix indentation --------- Co-authored-by: Paresh Arvind Patil <papati@microsoft.com> * Fix based on feedbacks (Azure#28986) * Fhaghbin/error (Azure#28987) * [suppressions.yaml] Create shared component "get-suppressions" (Azure#28927) - Usage: `npx get-suppressions <tool-name> <path-to-file>` - Returns: JSON array of suppressions, with specified tool name, applying to file (may be empty) - Example: `npm get-suppressions TypeSpecRequirement specification/foo/data-plane/Foo/stable/2023-01-01/Foo.json` - Fixes Azure#28069 * fix: Java/csharp model client names (Azure#28978) * Added beta4 * added readme * Adding Hold/Unhold (Azure#28853) * added missing events (Azure#28866) * Add transcription start, stop, update, get state APIs to beta4 controller (Azure#28895) * Add transcription APIs to beta4 controller * Fix the spec file * Fix the json format * Update swagger with InterruptCallMediaOperation flag fix (Azure#28925) * update swagger with interrupt call media operation flag * ran prettier to fix indentation --------- Co-authored-by: Paresh Arvind Patil <papati@microsoft.com> * Fix format * Fix error --------- Co-authored-by: Mike Harder <mharder@microsoft.com> Co-authored-by: Asaf Levi <100200009+asaflevi-ms@users.noreply.github.com> Co-authored-by: Franko Morales <67804607+cochi2@users.noreply.github.com> Co-authored-by: arupdutta-msft <87995153+arupdutta-msft@users.noreply.github.com> Co-authored-by: Paresh Arvind Patil <patilaparesh@gmail.com> Co-authored-by: Paresh Arvind Patil <papati@microsoft.com> * Fix pretier (Azure#28990) * Add BETA4 changes for transcription public preview (Azure#28993) * Add beta4 transcription feedback rework * Add transcription beta4 examples * Fix prettier * Fix StopTranscription response code * Fix errors (Azure#29005) * Fix spelling (Azure#29006) * Fix the description (Azure#29037) * Added suppression for LroExtension (Azure#29072) * rename mediaStreamingUpdateResult to mediaStreamingUpdate (Azure#29090) * [Call Automation] Create Connect interface (Azure#29075) * update swagger and add sample for Connect * update description * add description for call locator * update description for connectFailed event * rename ConnectCall to Connect in example * update description * fix style * adding operation context * revert renaming mediaStreamingUpdateResult * fix example * make change to re-trigger pipelines * add back the rename from base branch --------- Co-authored-by: James Deng (ACS) <jamesdeng@microsoft.com> --------- Co-authored-by: Franko Morales <67804607+cochi2@users.noreply.github.com> Co-authored-by: arupdutta-msft <87995153+arupdutta-msft@users.noreply.github.com> Co-authored-by: Paresh Arvind Patil <patilaparesh@gmail.com> Co-authored-by: Paresh Arvind Patil <papati@microsoft.com> Co-authored-by: Mike Harder <mharder@microsoft.com> Co-authored-by: Asaf Levi <100200009+asaflevi-ms@users.noreply.github.com> Co-authored-by: elavarasid <101957302+elavarasidc@users.noreply.github.com> Co-authored-by: James Deng (ACS) <jamesdeng@microsoft.com>

mikeharder and others added 10 commits May 4, 2024 00:02

fix: Java/csharp model client names (#28978)

a8698bb

Added beta4

2d298ed

added readme

e72d485

Adding Hold/Unhold (#28853)

f32499e

added missing events (#28866)

ce3d636

Add transcription start, stop, update, get state APIs to beta4 contro…

284b57b

…ller (#28895) * Add transcription APIs to beta4 controller * Fix the spec file * Fix the json format

Update swagger with InterruptCallMediaOperation flag fix (#28925)

b4dfed6

* update swagger with interrupt call media operation flag * ran prettier to fix indentation --------- Co-authored-by: Paresh Arvind Patil <papati@microsoft.com>

Fix conflict

1997fae

Fix format

03a48c5

fhaghbin-msft requested review from weshaggard, mikeharder, konrad-jamrozik and a team as code owners May 6, 2024 16:27

fhaghbin-msft requested review from vicancy and scgbear and removed request for a team May 6, 2024 16:27

AzureRestAPISpecReview added data-plane TypeSpec Authored with TypeSpec labels May 6, 2024

Fix error

38cfcb2

fhaghbin-msft merged commit 2326e91 into callautomation/beta4 May 6, 2024
8 of 20 checks passed

fhaghbin-msft deleted the fhaghbin/error branch May 6, 2024 17:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fhaghbin/error #28987

Fhaghbin/error #28987

fhaghbin-msft commented May 6, 2024 •

edited by openapi-workflow-bot bot

Loading

openapi-pipeline-app bot commented May 6, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 6, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 6, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 6, 2024 •

edited

Loading

Fhaghbin/error #28987

Fhaghbin/error #28987

Conversation

fhaghbin-msft commented May 6, 2024 • edited by openapi-workflow-bot bot Loading

Data Plane API Specification Update Pull Request

PR review workflow diagram

API Info: The Basics

Change Scope

Viewing API changes

Suppressing failures

❔Got questions? Need additional info?? We are here to help!

Tooling

Guidelines & Specifications

Helpful Links

Getting help

openapi-pipeline-app bot commented May 6, 2024 • edited Loading

Next Steps to Merge

openapi-pipeline-app bot commented May 6, 2024 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented May 6, 2024 • edited Loading

Swagger Generation Artifacts

openapi-pipeline-app bot commented May 6, 2024 • edited Loading

fhaghbin-msft commented May 6, 2024 •

edited by openapi-workflow-bot bot

Loading

openapi-pipeline-app bot commented May 6, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 6, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 6, 2024 •

edited

Loading

openapi-pipeline-app bot commented May 6, 2024 •

edited

Loading