-
Notifications
You must be signed in to change notification settings - Fork 5.3k
Dw/test cadl pipeline #21639
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
base: main
Are you sure you want to change the base?
Dw/test cadl pipeline #21639
Conversation
Hi, @dw511214992 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 |
---|---|
Runtime Exception |
"new":"https://github.com/Azure/azure-rest-api-specs/blob/3ebe2fa9a1fed6b645f6643dc9cc1dbe0d795e21/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-05-13/confidentialledger.json", "details":"Command failed: node /mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.46/common/temp/node_modules/.pnpm/@Azure[email protected]/node_modules/autorest/dist/app.js --v2 --input-file=specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp\nERROR: Schema violation: Data does not match any schemas from 'oneOf'\n - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json:41:4 ($.securityDefinitions.OAuth2Auth)\nFATAL: swagger-document/individual/schema-validator - FAILED\nFATAL: Error: [OperationAbortedException] Error occurred. Exiting.\nProcess() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting.\n" |
The following breaking changes are detected by comparison with the latest preview version:
Rule | Message |
---|---|
Runtime Exception |
"new":"https://github.com/Azure/azure-rest-api-specs/blob/3ebe2fa9a1fed6b645f6643dc9cc1dbe0d795e21/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/preview/0.1-preview/confidentialledger.json", "details":"Command failed: node /mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.46/common/temp/node_modules/.pnpm/@Azure[email protected]/node_modules/autorest/dist/app.js --v2 --input-file=specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp\nERROR: Schema violation: Data does not match any schemas from 'oneOf'\n - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json:41:4 ($.securityDefinitions.OAuth2Auth)\nFATAL: swagger-document/individual/schema-validator - FAILED\nFATAL: Error: [OperationAbortedException] Error occurred. Exiting.\nProcess() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting.\n" |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 6 Errors, 53 Warnings failed [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2022-08-13 | package-2022-08-13(3ebe2fa) | 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] |
---|---|---|
AvoidAnonymousParameter |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L195 |
|
AvoidAnonymousParameter |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L415 |
|
AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L431 |
|
AvoidAnonymousTypes |
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L453 |
|
RequiredReadOnlyProperties |
Property 'collectionId' is a required property. It should not be marked as 'readonly' Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L566 |
|
RequiredReadOnlyProperties |
Property 'transactionId' is a required property. It should not be marked as 'readonly' Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L566 |
|
Security definition should have a description. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L41 |
||
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L54 |
||
Error response should contain a x-ms-error-code header. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L75 |
||
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L85 |
||
All success responses except 202 & 204 should define a response body. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L95 |
||
Error response should contain a x-ms-error-code header. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L98 |
||
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L108 |
||
All success responses except 202 & 204 should define a response body. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L118 |
||
Error response should contain a x-ms-error-code header. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L121 |
||
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L131 |
||
All success responses except 202 & 204 should define a response body. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L141 |
||
Error response should contain a x-ms-error-code header. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L144 |
||
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L154 |
||
Response body schema of pageable response should contain top-level array property value Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L166 |
||
Error response should contain a x-ms-error-code header. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L170 |
||
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L181 |
||
Parameter should have a description. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L192 |
||
The body parameter is not marked as required. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L192 |
||
Using post for a create operation is discouraged. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L212 |
||
All success responses except 202 & 204 should define a response body. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L212 |
||
Error response should contain a x-ms-error-code header. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L221 |
||
Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L231 |
||
Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L236 |
||
Error response should contain a x-ms-error-code header. Location: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L253 |
️❌
Avocado: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
MISSING_README |
Can not find readme.md in the folder. If no readme.md file, it will block SDK generation. folder: 3ebe2fa9a1fed6b645f6643dc9cc1dbe0d795e21/specification/confidentialledger/ConfientialLedger |
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️❌
ModelValidation: 13 Errors, 0 Warnings failed [Detail]
️❌
SemanticValidation: 19 Errors, 0 Warnings failed [Detail]
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️❌
SpellCheck: 3 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
HowToFix |
Unknown word (updateable), please fix the error or add words to ./custom-words.txt path: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L203:55 |
HowToFix |
Unknown word (Updateable), please fix the error or add words to ./custom-words.txt path: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L207:31 |
HowToFix |
Unknown word (Updateable), please fix the error or add words to ./custom-words.txt path: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L424:50 |
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️❌
CadlValidation: 2 Errors, 16 Warnings failed [Detail]
Rule | Message |
---|---|
MissingExamplesDirectory |
"details":"The 'examples' directory is missing in the cadl folder specification/confidentialledger/ConfientialLedger, please ensure the 'examples' is added in the PR." |
SwaggerNotExistInPR |
"details":"the generated swagger file openapi.json from cadl specification/confidentialledger/ConfientialLedger is not in the PR, please make sure it presents into the PR." |
The Model named 'MyFlow' should have a documentation or description, please use decorator @doc to add it. Location: specification/confidentialledger/ConfientialLedger/main.cadl#L34 |
|
The ModelProperty named 'authorizationUrl' should have a documentation or description, please use decorator @doc to add it. Location: specification/confidentialledger/ConfientialLedger/main.cadl#L34 |
|
The ModelProperty named 'scopes' should have a documentation or description, please use decorator @doc to add it. Location: specification/confidentialledger/ConfientialLedger/main.cadl#L34 |
|
The ModelProperty named 'collectionId' should have a documentation or description, please use decorator @doc to add it. Location: specification/confidentialledger/ConfientialLedger/main.cadl#L54 |
|
The ModelProperty named 'collectionId' should have a documentation or description, please use decorator @doc to add it. Location: specification/confidentialledger/ConfientialLedger/main.cadl#L61 |
|
The Model named 'ReceiptContents' should have a documentation or description, please use decorator @doc to add it. Location: specification/confidentialledger/ConfientialLedger/main.cadl#L98 |
|
The ModelProperty named 'state' should have a documentation or description, please use decorator @doc to add it. Location: specification/confidentialledger/ConfientialLedger/main.cadl#L112 |
|
The ModelProperty named 'state' should have a documentation or description, please use decorator @doc to add it. Location: specification/confidentialledger/ConfientialLedger/main.cadl#L129 |
|
Operation 'listCollections' should be defined using a signature from the Azure.Core namespace. Location: specification/confidentialledger/ConfientialLedger/main.cadl#L156 |
|
The ModelProperty named 'transactionId' should have a documentation or description, please use decorator @doc to add it. Location: specification/confidentialledger/ConfientialLedger/main.cadl#L200 |
|
The ModelProperty named 'transactionId' should have a documentation or description, please use decorator @doc to add it. Location: specification/confidentialledger/ConfientialLedger/main.cadl#L208 |
|
The ModelProperty named 'transactionId' should have a documentation or description, please use decorator @doc to add it. Location: specification/confidentialledger/ConfientialLedger/main.cadl#L214 |
|
The Operation named 'deleteUser' should have a documentation or description, please use decorator @doc to add it. Location: specification/confidentialledger/ConfientialLedger/main.cadl#L230 |
|
The Operation named 'createOrUpdateUser' should have a documentation or description, please use decorator @doc to add it. Location: specification/confidentialledger/ConfientialLedger/main.cadl#L236 |
|
"details":"The configuration 'output-file' for '@azure-tools/cadl-autorest' is missing in the cadl-project.yaml under folder specification/confidentialledger/ConfientialLedger, please ensure it is added in the configuration of the emitter '@azure-tools/cadl-autorest'." |
|
"details":"The configuration 'azure-resource-provider-folder' for '@azure-tools/cadl-autorest' is missing in the cadl-project.yaml under folder specification/confidentialledger/ConfientialLedger, please ensure it is added in the configuration of the emitter '@azure-tools/cadl-autorest'." |
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
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 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 Open API document (swagger) if applicable, and the root paths that have been updated.
❔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