Skip to content

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Cadl demo #3598

wants to merge 2 commits into from

Conversation

dw511214992
Copy link

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:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

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.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] 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.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

@openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented Nov 3, 2022

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 2 Errors, 0 Warnings failed [Detail] The following breaking changes are detected by comparison with the latest stable 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/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]
Rule Message
XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in ConfidentialLedger_ListCollections.
Url: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L54:14
XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in ConfidentialLedger_GetEnclaveQuotes.
Url: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L85:14
XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in ConfidentialLedger_GetConstitution.
Url: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L108:14
XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in ConfidentialLedger_GetConsortiumMembers.
Url: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L131:14
XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in ConfidentialLedger_ListLedgerEntries.
Url: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L154:14
XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in ConfidentialLedger_CreateLedgerEntry.
Url: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L181:15
XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in ConfidentialLedger_GetLedgerEntry.
Url: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L231:14
XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in ConfidentialLedger_GetReceipt.
Url: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L263:14
XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in ConfidentialLedger_GetTransactionStatus.
Url: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L292:14
XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in ConfidentialLedger_GetCurrentLedgerEntry.
Url: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L321:14
XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in ConfidentialLedger_DeleteUser.
Url: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L350:17
XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in ConfidentialLedger_GetUser.
Url: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L374:14
XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in ConfidentialLedger_CreateOrUpdateUser.
Url: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L401:16
️❌SemanticValidation: 19 Errors, 0 Warnings failed [Detail]
Rule Message
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: flow
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: authorizationUrl
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: tokenUrl
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: scopes
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
ENUM_MISMATCH No enum match for: oauth2
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: name
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: in
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: flow
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: authorizationUrl
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: tokenUrl
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: scopes
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
ENUM_MISMATCH No enum match for: oauth2
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: tokenUrl
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: authorizationUrl
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
ENUM_MISMATCH No enum match for: implicit
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: authorizationUrl
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
ENUM_MISMATCH No enum match for: implicit
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
ENUM_MISMATCH No enum match for: implicit
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
ONE_OF_MISSING Data does not match any schemas from 'oneOf'
JsonUrl: Microsoft.ConfidentialLedger/stable/2022-08-13/confidentialledger.json#L43:15
️️✔️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."
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented Nov 3, 2022

Swagger Generation Artifacts

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking


️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning [Logs] Generate from d1c05a30a8b5bc29ebfe500831217c210133396e. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    warn		specification/confidentialledger/data-plane/readme.md skipped due to azure-sdk-for-python not found in swagger-to-sdk
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
  • ️✔️azure-security-confidentialledger [View full logs]  [Preview SDK Changes]
    info	[Changelog] data-plan skip changelog generation temporarily
️⚠️ azure-sdk-for-net-track2 warning [Detail]
  • ⚠️Warning [Logs] Generate from d1c05a30a8b5bc29ebfe500831217c210133396e. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
    warn		specification/confidentialledger/data-plane/readme.md skipped due to azure-sdk-for-net-track2 not found in swagger-to-sdk
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice
    cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice New minor version of npm available! 8.15.0 -> 8.19.2
    cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.19.2>
    cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[Invoke-GenerateAndBuildV2.ps1] npm notice
  • ️✔️Azure.Security.ConfidentialLedgerDemo [View full logs]  [Preview SDK Changes]
    info	[Changelog]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from d1c05a30a8b5bc29ebfe500831217c210133396e. SDK Automation 14.0.0
    command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
    warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
    warn		specification/confidentialledger/data-plane/readme.md skipped due to azure-sdk-for-js not found in swagger-to-sdk
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
  • ️✔️@azure-rest/confidentialledger-test [View full logs]  [Preview SDK Changes]
    info	[Changelog]
    error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs] Generate from d1c05a30a8b5bc29ebfe500831217c210133396e. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    warn		specification/confidentialledger/data-plane/readme.md skipped due to azure-sdk-for-java not found in swagger-to-sdk
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    cmderr	[generate.py] npm notice
    cmderr	[generate.py] npm notice New minor version of npm available! 8.15.0 -> 8.19.2
    cmderr	[generate.py] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.19.2>
    cmderr	[generate.py] npm notice Run `npm install -g [email protected]` to update!
    cmderr	[generate.py] npm notice
  • ️✔️azure-confidentialledger [View full logs]  [Preview SDK Changes]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app-test
Copy link

openapi-pipeline-app-test bot commented Nov 3, 2022

@dw511214992
Copy link
Author

/azp run

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@dw511214992
Copy link
Author

/azp run

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@zzvswxy zzvswxy added the APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. label Nov 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants