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.

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

[Call Automation] Create Connect interface #29075

Merged
merged 12 commits into from
May 16, 2024

Conversation

elavarasidc
Copy link
Member

@elavarasidc elavarasidc commented May 11, 2024

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.

spec_pr_review_workflow_diagram

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.

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.

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

Tooling

Guidelines & Specifications

Helpful Links

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.

@elavarasidc elavarasidc requested a review from a team as a code owner May 11, 2024 01:07
@elavarasidc elavarasidc requested review from tg-msft and bexxx and removed request for a team May 11, 2024 01:07
Copy link

openapi-pipeline-app bot commented May 11, 2024

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Copy link

openapi-pipeline-app bot commented May 11, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 4 Warnings warning [Detail]
Compared specs (v0.10.8) new version base version
communicationservicescallautomation.json 2024-06-15-preview(9392d99) 2024-04-15(main)
communicationservicescallautomation.json 2024-06-15-preview(9392d99) 2023-06-15-preview(main)

The following breaking changes are detected by comparison with the latest preview version:

Rule Message
⚠️ 1011 - AddingResponseCode The new version adds a response code '200'.
New: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L1326:11
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'cognitiveServicesEndpoint' renamed or removed?
New: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L1666:7
Old: CallAutomation/preview/2023-06-15-preview/communicationservicescallautomation.json#L1218:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'cognitiveServicesEndpoint' renamed or removed?
New: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L2006:7
Old: CallAutomation/preview/2023-06-15-preview/communicationservicescallautomation.json#L1336:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'toneInfo' renamed or removed?
New: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L3731:7
Old: CallAutomation/preview/2023-06-15-preview/communicationservicescallautomation.json#L2617:7
️⚠️LintDiff: 3 Warnings warning [Detail]
Compared specs (v2.2.2) new version base version
package-2024-06-15-preview package-2024-06-15-preview(9392d99) package-2024-06-15-preview(callautomation/beta4)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L247
⚠️ ParameterNamesConvention header parameter name 'Repeatability-Request-ID' should be kebab case.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L262
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L277


The following errors/warnings exist before current PR submission:

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

Rule Message
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L19
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L25
⚠️ ParameterNamesConvention header parameter name 'Repeatability-Request-ID' should be kebab case.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L40
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L55
⚠️ Post201Response Using post for a create operation is discouraged.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L61
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L82
⚠️ ParameterNamesConvention header parameter name 'Repeatability-Request-ID' should be kebab case.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L97
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L112
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L133
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L139
⚠️ ParameterNamesConvention header parameter name 'Repeatability-Request-ID' should be kebab case.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L154
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L169
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L187
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L193
⚠️ ParameterNamesConvention header parameter name 'Repeatability-Request-ID' should be kebab case.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L208
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L223
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L305
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L317
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L336
⚠️ DeleteInOperationName 'DELETE' operation 'CallConnection_HangupCall' should use method name 'Delete'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L342
⚠️ OperationId OperationId for delete method should contain 'Delete'
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L342
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L344
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L356
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L374
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L382
⚠️ ParameterNamesConvention header parameter name 'Repeatability-Request-ID' should be kebab case.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L393
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L408
⚠️ SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L426
⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L434
⚠️ ParameterNamesConvention header parameter name 'Repeatability-Request-ID' should be kebab case.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L454
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️⌛Automated merging requirements met pending [Detail]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented May 11, 2024

Swagger Generation Artifacts

️🔄ApiDocPreview inProgress [Detail]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented May 11, 2024

Generated ApiView

Language Package Name ApiView Link
Swagger CallAutomation https://apiview.dev/Assemblies/Review/224ad4b2fcd84615af973cc42c3c423a?revisionId=553aadeaccda4f638581fff4e31278c0

@mikekistler mikekistler linked an issue May 15, 2024 that may be closed by this pull request
@elavarasidc elavarasidc merged commit 7679971 into callautomation/beta4 May 16, 2024
27 of 29 checks passed
@elavarasidc elavarasidc deleted the callautomation/beta4-connect branch May 16, 2024 19:01
heaths pushed a commit that referenced this pull request May 28, 2024
* 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 <[email protected]>

* 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 <[email protected]>

* Fix format

* Fix error

---------

Co-authored-by: Mike Harder <[email protected]>
Co-authored-by: Asaf Levi <[email protected]>
Co-authored-by: Franko Morales <[email protected]>
Co-authored-by: arupdutta-msft <[email protected]>
Co-authored-by: Paresh Arvind Patil <[email protected]>
Co-authored-by: Paresh Arvind Patil <[email protected]>

* 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) <[email protected]>

---------

Co-authored-by: Franko Morales <[email protected]>
Co-authored-by: arupdutta-msft <[email protected]>
Co-authored-by: Paresh Arvind Patil <[email protected]>
Co-authored-by: Paresh Arvind Patil <[email protected]>
Co-authored-by: Mike Harder <[email protected]>
Co-authored-by: Asaf Levi <[email protected]>
Co-authored-by: elavarasid <[email protected]>
Co-authored-by: James Deng (ACS) <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[ACS Call Automation ] API Review
2 participants