azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

[Call Automation] 2024-06-15 BETA4

Open fhaghbin-msft opened this issue 1 year ago • 4 comments

Data Plane API - Pull Request

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.

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

Tooling

Guidelines & Specifications

Helpful Links

Checks stuck in `queued` state? 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.

fhaghbin-msft avatar Apr 17 '24 17:04 fhaghbin-msft

Next Steps to Merge

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

Swagger Validation Report

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

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

Rule Message
:warning: 1011 - AddingResponseCode The new version adds a response code '200'.
New: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L1326:11
:warning: 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
:warning: 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
:warning: 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
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 57 Warnings warning [Detail]
Compared specs (v2.2.2) new version base version
package-2024-06-15-preview package-2024-06-15-preview(2826421) default(main)

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

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

Rule Message Related RPC [For API reviewers]
:warning: OperationId OperationId should be of the form 'Noun_Verb'
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L247
:warning: ParameterNamesConvention header parameter name 'Repeatability-Request-ID' should be kebab case.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L262
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L277
:warning: SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L537
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L545
:warning: ParameterDescription Parameter should have a description.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L552
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L565
:warning: LroHeaders A 202 response should include an Operation-Location response header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L571
:warning: SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L583
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L591
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L612
:warning: LroHeaders A 202 response should include an Operation-Location response header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L618
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L638
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L659
:warning: LroHeaders A 202 response should include an Operation-Location response header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L665
:warning: SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L918
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L926
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L947
:warning: SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L953
:warning: SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L965
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L973
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L994
:warning: SuccessResponseBody All success responses except 202 & 204 should define a response body.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L1000
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L1020
:warning: ParameterDescription Parameter should have a description.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L1027
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L1040
:warning: LroHeaders A 202 response should include an Operation-Location response header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L1046
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L1066
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L1087
:warning: LroHeaders A 202 response should include an Operation-Location response header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L1093


The following errors/warnings exist before current PR submission:

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

Rule Message
:warning: SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L19
:warning: OperationId OperationId should be of the form 'Noun_Verb'
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L25
:warning: ParameterNamesConvention header parameter name 'Repeatability-Request-ID' should be kebab case.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L40
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L55
:warning: Post201Response Using post for a create operation is discouraged.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L61
:warning: OperationId OperationId should be of the form 'Noun_Verb'
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L82
:warning: ParameterNamesConvention header parameter name 'Repeatability-Request-ID' should be kebab case.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L97
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L112
:warning: SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L133
:warning: OperationId OperationId should be of the form 'Noun_Verb'
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L139
:warning: ParameterNamesConvention header parameter name 'Repeatability-Request-ID' should be kebab case.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L154
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L169
:warning: SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L187
:warning: OperationId OperationId should be of the form 'Noun_Verb'
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L193
:warning: ParameterNamesConvention header parameter name 'Repeatability-Request-ID' should be kebab case.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L208
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L223
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L305
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L317
:warning: SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L336
:warning: 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
:warning: OperationId OperationId for delete method should contain 'Delete'
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L342
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L344
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L356
:warning: SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L374
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L382
:warning: ParameterNamesConvention header parameter name 'Repeatability-Request-ID' should be kebab case.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L393
:warning: ErrorResponse Error response should contain a x-ms-error-code header.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L408
:warning: SummaryAndDescriptionMustNotBeSame The summary and description values should not be same.
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L426
:warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
Location: CallAutomation/preview/2024-06-15-preview/communicationservicescallautomation.json#L434
:warning: 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.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
Posted by Swagger Pipeline | How to fix these errors?

Generated ApiView

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

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

/azp run

fhaghbin-msft avatar May 06 '24 21:05 fhaghbin-msft

Azure Pipelines successfully started running 4 pipeline(s).

azure-pipelines[bot] avatar May 06 '24 21:05 azure-pipelines[bot]

@mikekistler I added Approved-Suppression on your behalf. This was needed because of SuppressionReviewRequired label which was needed because addition to suppresions section in README.md.

konrad-jamrozik avatar May 13 '24 18:05 konrad-jamrozik

PR validation pipeline can not start as the pull request is not merged or mergeable - most likely it has merge conflicts.

Merging on behalf of @mikekistler

heaths avatar May 28 '24 23:05 heaths