Removed Model and Internal postfix, added events in swagger #14639
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @navali-msft Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
"readme":"communication/data-plane/CallingServer/readme.md", "tag":"default", "details":"swagger-document/compose - FAILED" |
|
"readme":"communication/data-plane/CallingServer/readme.md", "tag":"default", "details":"Error: '$.paths["/calling/calls"].post.parameters' has incompatible values (---- name: callRequest in: body description: Create call request. required: true schema: $ref: '#/definitions/CreateCallRequest'- name: api-version in: query description: Version of API to invoke." |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: CallingServer/preview/2021-04-15-preview1/communicationservicescallingserver.json#L17 |
|
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: CallingServer/preview/2021-05-28-preview2/communicationservicescallingserver.json#L17 |
|
"readme":"communication/data-plane/CallingServer/readme.md", "tag":"default", "details":"swagger-document/compose - FAILED" |
|
"readme":"communication/data-plane/CallingServer/readme.md", "tag":"default", "details":"Error: '$.paths["/calling/calls"].post.parameters' has incompatible values (---- name: callRequest in: body description: Create call request. required: true schema: $ref: '#/definitions/CreateCallRequestInternal'- name: api-version in: query description: Version of API to invoke." |
| The operation 'Call_HangupCall' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: CallingServer/preview/2021-04-15-preview1/communicationservicescallingserver.json#L78 |
|
| The operation 'Call_DeleteCall' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: CallingServer/preview/2021-04-15-preview1/communicationservicescallingserver.json#L132 |
|
| The operation 'Call_PlayAudio' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: CallingServer/preview/2021-04-15-preview1/communicationservicescallingserver.json#L186 |
|
| The operation 'Conversation_JoinCall' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: CallingServer/preview/2021-04-15-preview1/communicationservicescallingserver.json#L318 |
|
| The operation 'Conversation_PlayAudio' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: CallingServer/preview/2021-04-15-preview1/communicationservicescallingserver.json#L384 |
|
| The operation 'Conversation_InviteParticipants' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: CallingServer/preview/2021-04-15-preview1/communicationservicescallingserver.json#L450 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️❌[Staging] SpellCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Unknown word (unhold), please fix the error or add words to ./custom-words.txt path: CallingServer/preview/2021-04-15-preview1/communicationservicescallingserver.json#L1322:10 |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Generation Artifacts
|
zihzhan-msft
reviewed
Jun 2, 2021
...data-plane/CallingServer/preview/2021-04-15-preview1/communicationservicescallingserver.json
Show resolved
Hide resolved
| } | ||
| } | ||
| }, | ||
| "CancelAllMediaOperationsRequest": { |
There was a problem hiding this comment.
if there is just operationContext in it, can we remove this request object?
| "tone": { | ||
| "$ref": "#/definitions/ToneValue" | ||
| } | ||
| } |
There was a problem hiding this comment.
Let's discuss about how to make the EventType as enum type.
anuchandy
pushed a commit
that referenced
this pull request
Jun 16, 2021
* Adding Communication CallingServer API preview1. * Updated the Swagger to add PlayAudio api for out-call scenario (#14578) * Updated the servercalling swagger with playAudio api for out-call * Fixed a typo Co-authored-by: Paresh Arvind Patil <[email protected]> * Add preview0 swagger for .net sdk. * Update SDK Swagger preview0 * Update swagger api version. * Update swagger api version. * Removed Model and Internal postfix, added events in swagger (#14639) * Removed Model and Internal postfix, added events in swagger * update the title * Add swagger for version 2021-06-15 (#14720) * Updated swagger with version 2021-06-15 * Fix the Communication.Common definitions path * Removed old swagger * Added unhold to list of custom-word * Update readme file accourding to new swagger. * update responses model suffix to result * Removed error responses and consumes/produces values from all the apis. Changed invite participant to add participant. Other model name related changes. * Added examples for all the apis. * Removed error responses from example * Added back error response type, added response body for add participant operation * Fix join call example * Update the examples Co-authored-by: Paresh Arvind Patil <[email protected]> Co-authored-by: Paresh Arvind Patil <[email protected]> Co-authored-by: navali-msft <[email protected]> Co-authored-by: Naveed Ali <[email protected]>
asager
pushed a commit
to asager/azure-rest-api-specs
that referenced
this pull request
Jun 24, 2021
* Adding Communication CallingServer API preview1. * Updated the Swagger to add PlayAudio api for out-call scenario (Azure#14578) * Updated the servercalling swagger with playAudio api for out-call * Fixed a typo Co-authored-by: Paresh Arvind Patil <[email protected]> * Add preview0 swagger for .net sdk. * Update SDK Swagger preview0 * Update swagger api version. * Update swagger api version. * Removed Model and Internal postfix, added events in swagger (Azure#14639) * Removed Model and Internal postfix, added events in swagger * update the title * Add swagger for version 2021-06-15 (Azure#14720) * Updated swagger with version 2021-06-15 * Fix the Communication.Common definitions path * Removed old swagger * Added unhold to list of custom-word * Update readme file accourding to new swagger. * update responses model suffix to result * Removed error responses and consumes/produces values from all the apis. Changed invite participant to add participant. Other model name related changes. * Added examples for all the apis. * Removed error responses from example * Added back error response type, added response body for add participant operation * Fix join call example * Update the examples Co-authored-by: Paresh Arvind Patil <[email protected]> Co-authored-by: Paresh Arvind Patil <[email protected]> Co-authored-by: navali-msft <[email protected]> Co-authored-by: Naveed Ali <[email protected]>
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* Adding Communication CallingServer API preview1. * Updated the Swagger to add PlayAudio api for out-call scenario (Azure#14578) * Updated the servercalling swagger with playAudio api for out-call * Fixed a typo Co-authored-by: Paresh Arvind Patil <[email protected]> * Add preview0 swagger for .net sdk. * Update SDK Swagger preview0 * Update swagger api version. * Update swagger api version. * Removed Model and Internal postfix, added events in swagger (Azure#14639) * Removed Model and Internal postfix, added events in swagger * update the title * Add swagger for version 2021-06-15 (Azure#14720) * Updated swagger with version 2021-06-15 * Fix the Communication.Common definitions path * Removed old swagger * Added unhold to list of custom-word * Update readme file accourding to new swagger. * update responses model suffix to result * Removed error responses and consumes/produces values from all the apis. Changed invite participant to add participant. Other model name related changes. * Added examples for all the apis. * Removed error responses from example * Added back error response type, added response body for add participant operation * Fix join call example * Update the examples Co-authored-by: Paresh Arvind Patil <[email protected]> Co-authored-by: Paresh Arvind Patil <[email protected]> Co-authored-by: navali-msft <[email protected]> Co-authored-by: Naveed Ali <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
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.
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.
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.