Changes to fix the SDK generation with latest API version #15927

chsamala2 · 2021-09-06T10:48:52Z

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

Changelog

Add a changelog entry for 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 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.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific langauge 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:

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

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 apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
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-workflow-bot · 2021-09-06T10:48:54Z

Hi, @chsamala2 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. [email protected]

openapi-pipeline-app · 2021-09-06T10:48:55Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

️⚠️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-2021-06-22

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

Validation passes for ModelValidation.

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

Validation passes for SemanticValidation.

️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

️⚠️[Staging] SDK Track2 Validation: 2 Warnings warning [Detail]

The following tags are being changed in this PR

automation/resource-manager/readme.md#package-2021-06-22

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ Modeler/MissingType	"readme":"automation/resource-manager/readme.md", "tag":"package-2021-06-22", "details":"The schema 'ScheduleCreateOrUpdateProperties-interval' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/schedule.json#/components/schemas/ScheduleCreateOrUpdateProperties-interval"
⚠️ Modeler/MissingType	"readme":"automation/resource-manager/readme.md", "tag":"package-2021-06-22", "details":"The schema 'ScheduleProperties-interval' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/preview/2020-01-13-preview/schedule.json#/components/schemas/ScheduleProperties-interval"
💬 AutorestCore/Exception	"readme":"automation/resource-manager/readme.md", "tag":"package-2021-06-22", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"
💬 AutorestCore/Exception	"readme":"automation/resource-manager/readme.md", "tag":"package-2021-06-22", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"

The following errors/warnings exist before current PR submission:

|:speech_balloon: AutorestCore/Exception|"readme":"automation/resource-manager/readme.md",
"tag":"package-2021-06-22",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

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

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

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

openapi-workflow-bot · 2021-09-06T10:48:55Z

[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

openapi-pipeline-app · 2021-09-06T10:48:55Z

Swagger Generation Artifacts

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

️❌[Staging] SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

❌azure-sdk-for-python-track2 - track2_azure-mgmt-automation - Approved - 1.1.0b1

+	Model HybridRunbookWorker has a new signature

️✔️azure-sdk-for-go - automation/mgmt/2019-06-01/automation - v57.1.0
️✔️azure-sdk-for-go - automation/mgmt/2015-10-31/automation - v57.1.0
️✔️azure-sdk-for-go - preview/automation/mgmt/2020-01-13-preview/automation - v57.1.0
️✔️azure-sdk-for-go - preview/automation/mgmt/2018-06-30-preview/automation - v57.1.0
️✔️azure-sdk-for-go - preview/automation/mgmt/2018-01-15-preview/automation - v57.1.0
️✔️azure-sdk-for-go - preview/automation/mgmt/2017-05-15-preview/automation - v57.1.0

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

️✔️Succeeded [Logs]Release - Generate from d5e70e3. 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 [email protected]/[email protected] --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.3-preview.nupkg
- Microsoft.Azure.Management.Automation.3.8.3-preview.symbols.nupkg

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from d5e70e3. 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.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

️✔️track2_azure-mgmt-automation [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Model AutomationAccountUpdateParameters has a new parameter disable_local_auth
info	[Changelog]   - Model AutomationAccountUpdateParameters has a new parameter public_network_access
info	[Changelog]   - Model AutomationAccountUpdateParameters has a new parameter identity
info	[Changelog]   - Model AutomationAccountUpdateParameters has a new parameter encryption
info	[Changelog]   - Model AutomationAccount has a new parameter disable_local_auth
info	[Changelog]   - Model AutomationAccount has a new parameter automation_hybrid_service_url
info	[Changelog]   - Model AutomationAccount has a new parameter private_endpoint_connections
info	[Changelog]   - Model AutomationAccount has a new parameter identity
info	[Changelog]   - Model AutomationAccount has a new parameter encryption
info	[Changelog]   - Model AutomationAccount has a new parameter system_data
info	[Changelog]   - Model AutomationAccount has a new parameter public_network_access
info	[Changelog]   - Model HybridRunbookWorkerGroup has a new parameter system_data
info	[Changelog]   - Model HybridRunbookWorkerGroup has a new parameter type
info	[Changelog]   - Model AutomationAccountCreateOrUpdateParameters has a new parameter disable_local_auth
info	[Changelog]   - Model AutomationAccountCreateOrUpdateParameters has a new parameter public_network_access
info	[Changelog]   - Model AutomationAccountCreateOrUpdateParameters has a new parameter identity
info	[Changelog]   - Model AutomationAccountCreateOrUpdateParameters has a new parameter encryption
info	[Changelog]   - Added operation HybridRunbookWorkerGroupOperations.create
info	[Changelog]   - Added operation group PrivateEndpointConnectionsOperations
info	[Changelog]   - Added operation group HybridRunbookWorkersOperations
info	[Changelog]   - Added operation group PrivateLinkResourcesOperations
info	[Changelog]   - Added operation group AutomationClientOperationsMixin
info	[Changelog]
info	[Changelog] **Breaking changes**
info	[Changelog]
info	[Changelog]   - Model HybridRunbookWorker has a new signature

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

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

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️automation/mgmt/2019-06-01/automation [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```

️✔️automation/mgmt/2015-10-31/automation [View full logs]

Only show 20 items here, please refer to log for details.

info	[Changelog] - New function `*WatcherListResultPage.Next() error`
info	[Changelog] - New function `WatcherListResultPage.NotDone() bool`
info	[Changelog] - New function `NewWatcherListResultPage(WatcherListResult, func(context.Context, WatcherListResult) (WatcherListResult, error)) WatcherListResultPage`
info	[Changelog] - New function `WatcherClient.StopSender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `WatcherClient.Update(context.Context, string, string, string, WatcherUpdateParameters) (Watcher, error)`
info	[Changelog] - New struct `PrivateEndpointConnection`
info	[Changelog] - New struct `PrivateEndpointConnectionProperties`
info	[Changelog] - New struct `PrivateEndpointProperty`
info	[Changelog] - New struct `PrivateLinkServiceConnectionStateProperty`
info	[Changelog] - New struct `Watcher`
info	[Changelog] - New struct `WatcherClient`
info	[Changelog] - New struct `WatcherListResult`
info	[Changelog] - New struct `WatcherListResultIterator`
info	[Changelog] - New struct `WatcherListResultPage`
info	[Changelog] - New struct `WatcherProperties`
info	[Changelog] - New struct `WatcherUpdateParameters`
info	[Changelog] - New struct `WatcherUpdateProperties`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 76 additive change(s).
info	[Changelog]

️✔️preview/automation/mgmt/2020-01-13-preview/automation [View full logs]
```
info	[Changelog] This is a new package
```

️✔️preview/automation/mgmt/2018-06-30-preview/automation [View full logs]

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog] - New function `*PrivateEndpointConnection.UnmarshalJSON([]byte) error`
info	[Changelog] - New function `PrivateEndpointConnection.MarshalJSON() ([]byte, error)`
info	[Changelog] - New function `PrivateLinkServiceConnectionStateProperty.MarshalJSON() ([]byte, error)`
info	[Changelog] - New struct `PrivateEndpointConnection`
info	[Changelog] - New struct `PrivateEndpointConnectionProperties`
info	[Changelog] - New struct `PrivateEndpointProperty`
info	[Changelog] - New struct `PrivateLinkServiceConnectionStateProperty`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 11 additive change(s).
info	[Changelog]

️✔️preview/automation/mgmt/2018-01-15-preview/automation [View full logs]

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog] - New function `PrivateLinkServiceConnectionStateProperty.MarshalJSON() ([]byte, error)`
info	[Changelog] - New function `*PrivateEndpointConnection.UnmarshalJSON([]byte) error`
info	[Changelog] - New function `PrivateEndpointConnection.MarshalJSON() ([]byte, error)`
info	[Changelog] - New struct `PrivateEndpointConnection`
info	[Changelog] - New struct `PrivateEndpointConnectionProperties`
info	[Changelog] - New struct `PrivateEndpointProperty`
info	[Changelog] - New struct `PrivateLinkServiceConnectionStateProperty`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 11 additive change(s).
info	[Changelog]

️✔️preview/automation/mgmt/2017-05-15-preview/automation [View full logs]

Only show 20 items here, please refer to log for details.

info	[Changelog] - New function `*WatcherUpdateParameters.UnmarshalJSON([]byte) error`
info	[Changelog] - New function `WatcherListResultPage.NotDone() bool`
info	[Changelog] - New function `WatcherListResultPage.Response() WatcherListResult`
info	[Changelog] - New function `WatcherListResultIterator.Response() WatcherListResult`
info	[Changelog] - New function `WatcherClient.Delete(context.Context, string, string, string) (autorest.Response, error)`
info	[Changelog] - New struct `PrivateEndpointConnection`
info	[Changelog] - New struct `PrivateEndpointConnectionProperties`
info	[Changelog] - New struct `PrivateEndpointProperty`
info	[Changelog] - New struct `PrivateLinkServiceConnectionStateProperty`
info	[Changelog] - New struct `Watcher`
info	[Changelog] - New struct `WatcherClient`
info	[Changelog] - New struct `WatcherListResult`
info	[Changelog] - New struct `WatcherListResultIterator`
info	[Changelog] - New struct `WatcherListResultPage`
info	[Changelog] - New struct `WatcherProperties`
info	[Changelog] - New struct `WatcherUpdateParameters`
info	[Changelog] - New struct `WatcherUpdateProperties`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 76 additive change(s).
info	[Changelog]

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

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

warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --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.1.1.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 1.1s

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from d5e70e3. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh] WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
warn	No file changes detected after generation

️✔️automation [View full logs]

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

msyyc · 2021-09-07T02:12:59Z

approve for python breaking change

chsamala and others added 4 commits August 27, 2021 15:15

Adding diable local auth in PUT payload

f1178dc

Adding diable local auth in PUT payload

1057b28

Merge branch 'Azure:main' into main

848dee3

fixing md file to generate right SDK files

45b049a

openapi-assignment-bot bot assigned ArcturusZhang Sep 6, 2021

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label Sep 6, 2021

openapi-sdkautomation bot mentioned this pull request Sep 6, 2021

[AutoPR Microsoft.Azure.Management.Automation] Changes to fix the SDK generation with latest API version AzureSDKAutomation/azure-sdk-for-net#5805

Closed

msyyc added the Approved-SdkBreakingChange-Python label Sep 7, 2021

ArcturusZhang approved these changes Sep 7, 2021

View reviewed changes

ArcturusZhang merged commit d5e70e3 into Azure:main Sep 7, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changes to fix the SDK generation with latest API version #15927

Changes to fix the SDK generation with latest API version #15927

chsamala2 commented Sep 6, 2021

openapi-workflow-bot bot commented Sep 6, 2021

openapi-pipeline-app bot commented Sep 6, 2021 •

edited

Loading

openapi-workflow-bot bot commented Sep 6, 2021

openapi-pipeline-app bot commented Sep 6, 2021 •

edited

Loading

Breaking Changes Tracking

msyyc commented Sep 7, 2021

Changes to fix the SDK generation with latest API version #15927

Changes to fix the SDK generation with latest API version #15927

Conversation

chsamala2 commented Sep 6, 2021

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Sep 6, 2021

openapi-pipeline-app bot commented Sep 6, 2021 • edited Loading

Swagger Validation Report

openapi-workflow-bot bot commented Sep 6, 2021

openapi-pipeline-app bot commented Sep 6, 2021 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

msyyc commented Sep 7, 2021

openapi-pipeline-app bot commented Sep 6, 2021 •

edited

Loading

openapi-pipeline-app bot commented Sep 6, 2021 •

edited

Loading