GA3 Changes #29119
Open
GA3 Changes #29119
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
amariwest-msft
requested review from
JeffreyRichter and
weidongxu-microsoft
and removed request for
a team
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
|
| Rule | Message |
|---|---|
|
"new":"https://github.com/Azure/azure-rest-api-specs/blob/156ff363e44f764ddd8a0a6adcd371610240ba15/specification/communication/data-plane/CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/communication/data-plane/CallAutomation/stable/2023-03-06/communicationservicescallautomation.json", "details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 20 lines of stack trace follow, indexed. First line should contain AutoRest command line invocation details. Remaining lines should contain the main message reported by AutoRest. ==================== 1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@Azure+oad@0.10.8/node_modules/autorest/dist/app.js" --v2 --input-file=specification/communication/data-plane/CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp/oad-rF3PiP 2: ERROR: Referenced file 'file:///mnt/vss/work/1/azure-rest-api-specs/specification/communication/data-plane/CallAutomation/preview/2023-10-03-preview/examples/CallMediaStopMediaStreaming.json' not found 3: - file:///mnt/vss/work/1/azure-rest-api-specs/specification/communication/data-plane/CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json:1136:12 ($.paths["/calling/callConnections/callConnectionId:stopMediaStreaming"].post["x-ms-examples"].CallMediaStopMediaStreaming["$ref"]) 4: FATAL: swagger-document/loader - FAILED 5: FATAL: Error: [OperationAbortedException] Error occurred. Exiting. 6: Process() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting." |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
|
"new":"https://github.com/Azure/azure-rest-api-specs/blob/156ff363e44f764ddd8a0a6adcd371610240ba15/specification/communication/data-plane/CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/communication/data-plane/CallAutomation/preview/2023-06-15-preview/communicationservicescallautomation.json", "details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 20 lines of stack trace follow, indexed. First line should contain AutoRest command line invocation details. Remaining lines should contain the main message reported by AutoRest. ==================== 1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@Azure+oad@0.10.8/node_modules/autorest/dist/app.js" --v2 --input-file=specification/communication/data-plane/CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp/oad-8L8LGR 2: ERROR: Referenced file 'file:///mnt/vss/work/1/azure-rest-api-specs/specification/communication/data-plane/CallAutomation/preview/2023-10-03-preview/examples/CallMediaStopMediaStreaming.json' not found 3: - file:///mnt/vss/work/1/azure-rest-api-specs/specification/communication/data-plane/CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json:1136:12 ($.paths["/calling/callConnections/callConnectionId:stopMediaStreaming"].post["x-ms-examples"].CallMediaStopMediaStreaming["$ref"]) 4: FATAL: swagger-document/loader - FAILED 5: FATAL: Error: [OperationAbortedException] Error occurred. Exiting. 6: Process() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting." |
️❌LintDiff: 4 Errors, 11 Warnings failed [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-2023-10-03-preview | package-2023-10-03-preview(156ff36) | package-2023-10-03-preview(callautomation/alpha3) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L1049 |
RPC-Post-V1-09 |
|
Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/communication/data-plane/CallAutomation/preview/2023-10-03-preview/examples/CallMedia_StartMediaStreaming.json . Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L1088 |
|
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L1095 |
RPC-Post-V1-09 |
|
Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/communication/data-plane/CallAutomation/preview/2023-10-03-preview/examples/CallMedia_StopMediaStreaming.json . Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L1135 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L1057 |
||
| Parameter should have a description. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L1064 |
||
| Error response should contain a x-ms-error-code header. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L1077 |
||
| A 202 response should include an Operation-Location response header. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L1083 |
||
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L1103 |
||
| Error response should contain a x-ms-error-code header. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L1124 |
||
| A 202 response should include an Operation-Location response header. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L1130 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L2050 |
||
| Schema should have a description or title. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L2889 |
||
| Schema should have a description or title. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L2902 |
||
| Schema should have a description or title. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L3414 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L369 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L433 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L480 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L526 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L573 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L611 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L750 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L814 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L1346 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L1409 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L1601 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L1844 |
|
Operations with a 202 response must specify x-ms-long-running-operation: true. GET operation is excluded from the validation as GET will have 202 only if it is a polling action & hence x-ms-long-running-operation wouldn't be definedLocation: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L1881 |
| The summary and description values should not be same. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L19 |
|
| OperationId should be of the form 'Noun_Verb' Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L25 |
|
| header parameter name 'Repeatability-Request-ID' should be kebab case. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L40 |
|
| Error response should contain a x-ms-error-code header. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L55 |
|
| Using post for a create operation is discouraged. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L61 |
|
| OperationId should be of the form 'Noun_Verb' Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L82 |
|
| header parameter name 'Repeatability-Request-ID' should be kebab case. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L97 |
|
| Error response should contain a x-ms-error-code header. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L112 |
|
| The summary and description values should not be same. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L133 |
|
| OperationId should be of the form 'Noun_Verb' Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L139 |
|
| header parameter name 'Repeatability-Request-ID' should be kebab case. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L154 |
|
| Error response should contain a x-ms-error-code header. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L169 |
|
| The summary and description values should not be same. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L187 |
|
| OperationId should be of the form 'Noun_Verb' Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L193 |
|
| header parameter name 'Repeatability-Request-ID' should be kebab case. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L208 |
|
| Error response should contain a x-ms-error-code header. Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L223 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L248 |
️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The JSON file is not found but it is referenced from the readme file. readme: communication/data-plane/CallAutomation/readme.md json: preview/2023-10-03-preview/examples/CallMedia_StopMediaStreaming.json |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"role":"Model Validation", "url":"https://github.com/Azure/azure-rest-api-specs/blob/156ff363e44f764ddd8a0a6adcd371610240ba15/specification/communication/data-plane/CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json" |
️❌SemanticValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Unexpected internal error: ENOENT: no such file or directory, open '/mnt/vss/_work/1/azure-rest-api-specs/specification/communication/data-plane/CallAutomation/preview/2023-10-03-preview/examples/CallMedia_StartMediaStreaming.json' Error: ENOENT: no such file or directory, open '/mnt/vss/_work/1/azure-rest-api-specs/specification/communication/data-plane/CallAutomation/preview/2023-10-03-preview/examples/CallMedia_StartMediaStreaming.json' JsonUrl: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json |
️❌SpellCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Unknown word (transferor's), please fix the error. See https://aka.ms/ci-fix#spell-check path: CallAutomation/preview/2023-10-03-preview/communicationservicescallautomation.json#L2360:90 |
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
JeffreyRichter
approved these changes
May 16, 2024
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.
Data Plane API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection 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.
Is this review for (select one):
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 ApiViewcomment 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
Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.