Microsoft.Automation swagger linter-check fix for sdk generation #12333

shivamT95-msft · 2021-01-08T12:03:18Z

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

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
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of “no breaking changes
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

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

ARM API Review Checklist

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
- Adding a new service
Please 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 there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable version with Breaking Change Validation errors
Updating API(s) in preview over 1 year

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-workflow-bot · 2021-01-08T12:03:21Z

Hi, @shivamT95-msft Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

openapi-pipeline-app · 2021-01-08T12:03:23Z

Swagger Validation Report

️❌BreakingChange: 9 Errors, 0 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.8.5)
- original: preview/2020-01-13-preview/privateEndpointConnection.json <---> new: preview/2020-01-13-preview/privateEndpointConnection.json
- original: preview/2020-01-13-preview/privateLinkResources.json <---> new: preview/2020-01-13-preview/privateLinkResources.json

Rule	Message
`❌` 1026 - TypeChanged	The new version has a different type 'object' than the previous one ''. New: Microsoft.Automation/preview/2020-01-13-preview/privateEndpointConnection.json#L156:13 Old: Microsoft.Automation/preview/2020-01-13-preview/privateEndpointConnection.json#L156:13
`❌` 1026 - TypeChanged	The new version has a different type 'object' than the previous one ''. New: Microsoft.Automation/preview/2020-01-13-preview/privateEndpointConnection.json#L200:13 Old: Microsoft.Automation/preview/2020-01-13-preview/privateEndpointConnection.json#L200:13
`❌` 1026 - TypeChanged	The new version has a different type 'object' than the previous one ''. New: Microsoft.Automation/common/v1/definitions.json#L27:5 Old: Microsoft.Automation/preview/2020-01-13-preview/privateEndpointConnection.json#L215:5
`❌` 1026 - TypeChanged	The new version has a different type 'object' than the previous one ''. New: Microsoft.Automation/common/v1/definitions.json#L63:5 Old: common-types/resource-management/v1/types.json#L48:5
`❌` 1026 - TypeChanged	The new version has a different type 'object' than the previous one ''. New: Microsoft.Automation/common/v1/definitions.json#L41:5 Old: common-types/resource-management/v1/types.json#L9:5
`❌` 1026 - TypeChanged	The new version has a different type 'object' than the previous one ''. New: Microsoft.Automation/common/v1/definitions.json#L94:5 Old: common-types/resource-management/v1/types.json#L82:5
`❌` 1026 - TypeChanged	The new version has a different type 'object' than the previous one ''. New: Microsoft.Automation/common/v1/definitions.json#L63:5 Old: common-types/resource-management/v1/types.json#L48:5
`❌` 1026 - TypeChanged	The new version has a different type 'object' than the previous one ''. New: Microsoft.Automation/common/v1/definitions.json#L41:5 Old: common-types/resource-management/v1/types.json#L9:5
`❌` 1026 - TypeChanged	The new version has a different type 'object' than the previous one ''. New: Microsoft.Automation/common/v1/definitions.json#L94:5 Old: common-types/resource-management/v1/types.json#L82:5

️❌LintDiff: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
`❌` AutoRest Exception	"details":" "Channel": "fatal", "Text": "swagger-document/compose - FAILED" "Channel": "fatal", "Text": "Error: '$.securityDefinitions.azure_auth.scopes.user_impersonation' has incompatible values (---\nimpersonate your user account\n, ---\nImpersonate your user account\n)."(node:6626) UnhandledPromiseRejectionWarning: Error: '$.securityDefinitions.azure_auth.scopes.user_impersonation' has incompatible values (---impersonate your user account", "location":"https://github.com/Azure/azure-rest-api-specs/blob/master/specification/automation/resource-manager/readme.md"

️⚠️Avocado: 1 Warnings warning [Detail]

Rule	Message
⚠️ MULTIPLE_API_VERSION	The default tag contains multiple API versions swaggers. readme: specification/automation/resource-manager/readme.md tag: specification/automation/resource-manager/readme.md#tag-package-2018-06-preview

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2021-01-08T12:03:24Z

Swagger Generation Artifacts

️️✔️ azure-sdk-for-python succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 2298361. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	npx n 12
command	python3 -m venv venv
command	pip install --upgrade setuptools wheel pip
command	pip install pathlib jinja2 msrestazure
command	autorest --version=V2 --use=@microsoft.azure/autorest.python@~4.0.71 --python --python-mode=update --multiapi --keep-version-file --no-async --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk ../azure-rest-api-specs/specification/automation/resource-manager/readme.md

️✔️azure-mgmt-automation [View full logs] [Release SDK Changes]

cmderr	[buildConf] INFO:packaging_tools:Building template azure-mgmt-automation
cmderr	[buildConf] INFO:packaging_tools.conf:Skipping default conf since the file exists
cmderr	[buildConf] INFO:packaging_tools:Skipping CHANGELOG.md template, since a previous one was found
cmderr	[buildConf] INFO:packaging_tools:Template done azure-mgmt-automation
cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
cmderr	[changelogReport] INFO:__main__:Looking for Autorest generated package in azure.mgmt.automation
cmderr	[changelogReport] INFO:__main__:Found azure.mgmt.automation
cmderr	[changelogReport] INFO:__main__:Working on azure.mgmt.automation
cmderr	[changelogReport] INFO:__main__:Report written to sdk/automation/azure-mgmt-automation/code_reports/latest/report.json
cmderr	[changelogReportLatest] INFO:__main__:Download versions of azure-mgmt-automation on PyPI
cmderr	[changelogReportLatest] INFO:__main__:Got ['0.1.0', '0.1.1', '1.0.0b1', '1.0.0']
cmderr	[changelogReportLatest] INFO:__main__:Only keep last PyPI version
cmderr	[changelogReportLatest] INFO:__main__:Installing version 0.1.1 of azure-mgmt-automation in a venv
cmderr	[changelogReportLatest] Cache entry deserialization failed, entry ignored
cmderr	[changelogReportLatest] INFO:__main__:Looking for Autorest generated package in azure.mgmt.automation
cmderr	[changelogReportLatest] INFO:__main__:Found azure.mgmt.automation
cmderr	[changelogReportLatest] INFO:__main__:Working on azure.mgmt.automation
cmderr	[changelogReportLatest] INFO:__main__:Report written to sdk/automation/azure-mgmt-automation/code_reports/0.1.1/report.json
cmdout	[Changelog] Size of delta 0.041% size of original (original: 150810 chars, delta: 62 chars)

️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 2298361. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/automation/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied

️✔️Microsoft.Azure.Management.Automation [View full logs] [Release SDK Changes]
- Microsoft.Azure.Management.Automation.3.8.2-preview.nupkg
- Microsoft.Azure.Management.Automation.3.8.2-preview.snupkg

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 2298361. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️preview/automation/mgmt/2018-06-30-preview/automation [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️preview/automation/mgmt/2018-01-15-preview/automation [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️preview/automation/mgmt/2017-05-15-preview/automation [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️automation/mgmt/2015-10-31/automation [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 2298361. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/automation/resource-manager/readme.md

️✔️@azure/arm-automation [View full logs] [Release SDK Changes]

azure-arm-automation-10.0.0.tgz

cmderr	[npmPack] loaded rollup.config.js with warnings
cmderr	[npmPack] (!) Unused external imports
cmderr	[npmPack] default imported from external module 'rollup' but never used
cmderr	[npmPack] ./esm/automationClient.js → ./dist/arm-automation.js...
cmderr	[npmPack] created ./dist/arm-automation.js in 1s

️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 2298361. Schema Automation 14.0.0

warn	Skip initScript due to not configured
command	npx n 12
command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6320 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/automation/resource-manager/readme.md

️✔️automation [View full logs] [Release Schema Changes]

cmderr	[resource-manager] node-pre-gyp
cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
cmderr	[resource-manager] WARN template-schema-validation-tools@1.0.0 No repository field.
cmderr	[resource-manager] optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2021-01-08T12:11:54Z

Hi @shivamT95-msft, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

… in definition file

openapi-workflow-bot · 2021-01-11T07:46:50Z

Hi @shivamT95-msft, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
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.
If you want to know the production traffic statistic, please see ARM Traffic statistic.
If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

jianyexi · 2021-01-11T07:58:40Z

The breaking change can be ignored , as the object definition is not changed

jianyexi · 2021-01-11T08:00:55Z

@akning-ms could you force merge it , it's to fix the existing conflict in the PR #12073 , so that the lintDiff can run normally

jianyexi · 2021-01-11T09:38:23Z

/azp run

azure-pipelines · 2021-01-11T09:38:37Z

Azure Pipelines successfully started running 2 pipeline(s).

Making userimpersonation as lower-case

fc10212

openapi-assignment-bot bot assigned weidongxu-microsoft Jan 8, 2021

shivamT95-msft requested a review from jagpreetstamber January 8, 2021 12:09

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Jan 8, 2021

shivamT95-msft requested a review from jianyexi January 8, 2021 12:40

jianyexi assigned jianyexi and unassigned weidongxu-microsoft Jan 9, 2021

Updating common definitions to fix linter error

d9da15e

openapi-pipeline-app bot added CI-FixRequiredOnFailure CI-BreakingChange-Python and removed CI-FixRequiredOnFailure labels Jan 11, 2021

openapi-sdkautomation bot mentioned this pull request Jan 11, 2021

[AutoPR automation] Microsoft.Automation swagger linter-check fix for sdk generation AzureSDKAutomation/azure-resource-manager-schemas#1313

Closed

Updating the references to refer to definitions and reverting changes…

336abca

… in definition file

openapi-pipeline-app bot added CI-FixRequiredOnFailure BreakingChangeReviewRequired and removed CI-FixRequiredOnFailure labels Jan 11, 2021

fixing model validations

1fb0357

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Jan 11, 2021

jianyexi approved these changes Jan 11, 2021 •

edited

Loading

View reviewed changes

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Jan 11, 2021

akning-ms merged commit 2298361 into Azure:master Jan 11, 2021

jianyexi removed the BreakingChangeReviewRequired label Jan 11, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Microsoft.Automation swagger linter-check fix for sdk generation #12333

Microsoft.Automation swagger linter-check fix for sdk generation #12333

shivamT95-msft commented Jan 8, 2021

openapi-workflow-bot bot commented Jan 8, 2021

openapi-pipeline-app bot commented Jan 8, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jan 8, 2021 •

edited

Loading

openapi-workflow-bot bot commented Jan 8, 2021

openapi-workflow-bot bot commented Jan 11, 2021

jianyexi commented Jan 11, 2021

jianyexi commented Jan 11, 2021

jianyexi commented Jan 11, 2021

azure-pipelines bot commented Jan 11, 2021

Microsoft.Automation swagger linter-check fix for sdk generation #12333

Microsoft.Automation swagger linter-check fix for sdk generation #12333

Conversation

shivamT95-msft commented Jan 8, 2021

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jan 8, 2021

openapi-pipeline-app bot commented Jan 8, 2021 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jan 8, 2021 • edited Loading

Swagger Generation Artifacts

openapi-workflow-bot bot commented Jan 8, 2021

openapi-workflow-bot bot commented Jan 11, 2021

jianyexi commented Jan 11, 2021

jianyexi commented Jan 11, 2021

jianyexi commented Jan 11, 2021

azure-pipelines bot commented Jan 11, 2021

openapi-pipeline-app bot commented Jan 8, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jan 8, 2021 •

edited

Loading