forked from Azure/azure-rest-api-specs
-
Notifications
You must be signed in to change notification settings - Fork 3
Cadl demo #3598
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
Open
dw511214992
wants to merge
2
commits into
main
Choose a base branch
from
cadl-demo
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Cadl demo #3598
Conversation
This file contains hidden or 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
Swagger Validation Report
|
Rule | Message |
---|---|
Runtime Exception |
"new":"https://github.com/openapi-env-test/azure-rest-api-specs/blob/fad5eab434382a5f65f09e82798eb6c20a86b76b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json", "old":"https://github.com/openapi-env-test/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/AzureApiValidationTest_1a18ed4f-f3bf-4f34-9fed-13cb57bd2410/0.0.267/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 latest preview version:
Rule | Message |
---|---|
Runtime Exception |
"new":"https://github.com/openapi-env-test/azure-rest-api-specs/blob/fad5eab434382a5f65f09e82798eb6c20a86b76b/specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json", "old":"https://github.com/openapi-env-test/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/AzureApiValidationTest_1a18ed4f-f3bf-4f34-9fed-13cb57bd2410/0.0.267/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" |
️❌
LintDiff: 2 Errors, 0 Warnings failed [Detail]
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
AutoRest exception |
"location":"specification/confidentialledger/data-plane/readme.md", "tag":"package-2022-2022-08-13", "details":"swagger-document/individual/schema-validator - FAILED" |
|
AutoRest exception |
"location":"specification/confidentialledger/data-plane/readme.md", "tag":"package-2022-2022-08-13", "details":"Error: [OperationAbortedException] Error occurred. Exiting." |
️️✔️
PR Summary succeeded [Detail] [Expand]
️️✔️
[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️❌
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: fad5eab434382a5f65f09e82798eb6c20a86b76b/specification/confidentialledger/ConfientialLedger |
️❌
ModelValidation: 13 Errors, 0 Warnings failed [Detail]
️❌
SemanticValidation: 19 Errors, 0 Warnings failed [Detail]
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️❌
[Staging] 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 |
️️✔️
[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
- "https://github.com/openapi-env-test/azure-rest-api-specs/blob/fad5eab434382a5f65f09e82798eb6c20a86b76b/specification/confidentialledger/data-plane/readme.md#tag-package-2022-2022-08-13">confidentialledger/data-plane/readme.md#package-2022-2022-08-13
️❌
CadlValidation: 2 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
MissingCadlFile |
"details":"The swagger specification/confidentialledger/data-plane/Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json is generated from cadl files, but the cadl file is missing in the PR." |
MissingPackageJson |
"details":"The 'package.json' is missing in the cadl folder spe, please ensure the 'package.json' is added in the PR." |
Swagger Generation Artifacts
|
Generated ApiView
|
This was referenced Nov 3, 2022
Closed
Closed
Closed
/azp run |
No pipelines are associated with this pull request. |
/azp run |
No pipelines are associated with this pull request. |
This was referenced Nov 3, 2022
Open
Open
Open
Open
Open
Open
Open
This was referenced Nov 4, 2022
Open
This was referenced Nov 4, 2022
This was referenced Nov 8, 2022
Open
Open
This was referenced Dec 16, 2022
[data-plane] JS: 'New Beta of Release Planner Test Product'
test-repo-billy/sdk-release-request#1186
Open
3erik777
approved these changes
Dec 16, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
APIStewardshipBoard-SignedOff
The Azure API Stewardship team has reviewed and approved the changes.
cadl
CI-FixRequiredOnFailure
CI-MissingBaseCommit
data-plane
new-api-version
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.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for 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
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
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 any of the following scenarios apply to the PR, request approval from the 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.