-
Notifications
You must be signed in to change notification settings - Fork 8
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
Test API review change for swagger #2920
Test API review change for swagger #2920
Conversation
Swagger Validation Report
|
Rule | Message |
---|---|
Runtime Exception |
"new":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/98507aef04a0f229d9b5c185b1364b0809a9c62d/specification/communication/data-plane/Email/stable/2023-03-31/CommunicationServicesEmail.json", "old":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/main/specification/communication/data-plane/Email/stable/2023-03-31/CommunicationServicesEmail.json", "details":"Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidationTest_1a18ed4f-f3bf-4f34-9fed-13cb57bd2410/0.0.332/common/temp/node_modules/.pnpm/@Azure+oad@0.10.4/node_modules/autorest/dist/app.js" --v2 --input-file=/mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specification/communication/data-plane/Email/stable/2023-03-31/CommunicationServicesEmail.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp\nERROR: Schema violation: Data does not match any schemas from 'oneOf'\n - file:///mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specification/communication/data-plane/Email/stable/2023-03-31/CommunicationServicesEmail.json:152:10 ($.paths["/emails:send"].post["x-ms-examples"]["Send Email"])\nERROR: Schema violation: Data does not match any schemas from 'oneOf'\n - file:///mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specification/communication/data-plane/Email/stable/2023-03-31/CommunicationSe" |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2023-03-31 | package-2023-03-31(98507ae) | package-2023-03-31(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Email/stable/2023-03-31/CommunicationServicesEmail.json#L20 |
|
The error property in the error response schema should be required.Location: Email/stable/2023-03-31/CommunicationServicesEmail.json#L40 |
|
Error schema should define code and message properties as required.Location: Email/stable/2023-03-31/CommunicationServicesEmail.json#L40 |
|
The error property in the error response schema should be required.Location: Email/stable/2023-03-31/CommunicationServicesEmail.json#L125 |
|
Error schema should define code and message properties as required.Location: Email/stable/2023-03-31/CommunicationServicesEmail.json#L125 |
|
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: Email/stable/2023-03-31/CommunicationServicesEmail.json#L237 |
️️✔️
~[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
~[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
~[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
PR Summary succeeded [Detail] [Expand]
️️✔️
CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️
TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
Hi, @praveenkuttappan 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. vscswagger@microsoft.com |
Swagger Generation Artifacts
|
Generated ApiView
|
/azp run |
No pipelines are associated with this pull request. |
/azp run unifiedPipeline |
1 similar comment
/azp run unifiedPipeline |
No pipelines are associated with this pull request. |
1 similar comment
No pipelines are associated with this pull request. |
Test request suppression |
Test request suppression updated |
Test PR. Do not merge |
Test, requesting suppression |
Test Swagger API review gen to cover regression test of latest unified pipeline
fix #3019