azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Created New Stable API Version for python3 Runbook APIs
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
- [x] 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. Its available in all public regions
-
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. This is PR to update swagger.
-
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)
- [x] 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:
- [x] I commit to follow the Breaking Change Policy of "no breaking changes"
- [x] 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: :warning:
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:
-
[x] 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.
Hi, @sushil490023 Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 2 Errors, 185 Warnings failed [Detail]
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| account.json | 2022-08-08(5e492b9) | 2021-06-22(main) |
| account.json | 2022-08-08(5e492b9) | 2020-01-13-preview(main) |
| certificate.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| certificate.json | 2022-08-08(5e492b9) | 2020-01-13-preview(main) |
| connection.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| connection.json | 2022-08-08(5e492b9) | 2020-01-13-preview(main) |
| connectionType.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| connectionType.json | 2022-08-08(5e492b9) | 2020-01-13-preview(main) |
| credential.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| credential.json | 2022-08-08(5e492b9) | 2020-01-13-preview(main) |
| dscConfiguration.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| dscNodeConfiguration.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| dscNodeConfiguration.json | 2022-08-08(5e492b9) | 2020-01-13-preview(main) |
| hybridRunbookWorker.json | 2022-08-08(5e492b9) | 2021-06-22(main) |
| hybridRunbookWorkerGroup.json | 2022-08-08(5e492b9) | 2022-02-22(main) |
| hybridRunbookWorkerGroup.json | 2022-08-08(5e492b9) | 2020-01-13-preview(main) |
| job.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| job.json | 2022-08-08(5e492b9) | 2017-05-15-preview(main) |
| jobSchedule.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| jobSchedule.json | 2022-08-08(5e492b9) | 2020-01-13-preview(main) |
| linkedWorkspace.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| linkedWorkspace.json | 2022-08-08(5e492b9) | 2020-01-13-preview(main) |
| module.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| module.json | 2022-08-08(5e492b9) | 2020-01-13-preview(main) |
| operations.json | 2022-08-08(5e492b9) | 2021-06-22(main) |
| python2package.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| python2package.json | 2022-08-08(5e492b9) | 2020-01-13-preview(main) |
| runbook.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| schedule.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| schedule.json | 2022-08-08(5e492b9) | 2020-01-13-preview(main) |
| softwareUpdateConfigurationMachineRun.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| softwareUpdateConfigurationMachineRun.json | 2022-08-08(5e492b9) | 2017-05-15-preview(main) |
| softwareUpdateConfigurationRun.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| softwareUpdateConfigurationRun.json | 2022-08-08(5e492b9) | 2017-05-15-preview(main) |
| sourceControl.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| sourceControl.json | 2022-08-08(5e492b9) | 2020-01-13-preview(main) |
| sourceControlSyncJob.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| sourceControlSyncJob.json | 2022-08-08(5e492b9) | 2020-01-13-preview(main) |
| sourceControlSyncJobStreams.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| sourceControlSyncJobStreams.json | 2022-08-08(5e492b9) | 2020-01-13-preview(main) |
| variable.json | 2022-08-08(5e492b9) | 2019-06-01(main) |
| variable.json | 2022-08-08(5e492b9) | 2020-01-13-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 15 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
Only 15 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 16 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-08-08 | package-2022-08-08(5e492b9) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 15 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: R2017 - PutRequestResponseScheme | A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Python3Package_CreateOrUpdate' Request Model: 'PythonPackageCreateParameters' Response Model: 'Module' Location: Microsoft.Automation/stable/2022-08-08/python3package.json#L140 |
|
| :warning: R2017 - PutRequestResponseScheme | A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Python3Package_CreateOrUpdate' Request Model: 'PythonPackageCreateParameters' Response Model: 'Module' Location: Microsoft.Automation/stable/2022-08-08/python3package.json#L140 |
|
| :warning: R3010 - TrackedResourceListByImmediateParent | The child tracked resource, 'activities' with immediate parent 'Module', must have a list by immediate parent operation. Location: Microsoft.Automation/stable/2022-08-08/python3package.json#L454 |
|
| :warning: R3010 - TrackedResourceListByImmediateParent | The child tracked resource, 'python3Packages' with immediate parent 'AutomationAccount', must have a list by immediate parent operation. Location: Microsoft.Automation/stable/2022-08-08/python3package.json#L683 |
|
| :warning: R3010 - TrackedResourceListByImmediateParent | The child tracked resource, 'modules' with immediate parent 'AutomationAccount', must have a list by immediate parent operation. Location: Microsoft.Automation/stable/2022-08-08/python3package.json#L683 |
|
| :warning: R3010 - TrackedResourceListByImmediateParent | The child tracked resource, 'python2Packages' with immediate parent 'AutomationAccount', must have a list by immediate parent operation. Location: Microsoft.Automation/stable/2022-08-08/python3package.json#L683 |
|
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isMandatory Location: Microsoft.Automation/stable/2022-08-08/python3package.json#L326 |
|
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDynamic Location: Microsoft.Automation/stable/2022-08-08/python3package.json#L330 |
|
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: valueFromPipeline Location: Microsoft.Automation/stable/2022-08-08/python3package.json#L339 |
|
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: valueFromPipelineByPropertyName Location: Microsoft.Automation/stable/2022-08-08/python3package.json#L343 |
|
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: valueFromRemainingArguments Location: Microsoft.Automation/stable/2022-08-08/python3package.json#L347 |
|
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isGlobal Location: Microsoft.Automation/stable/2022-08-08/python3package.json#L595 |
|
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isComposite Location: Microsoft.Automation/stable/2022-08-08/python3package.json#L663 |
|
| :warning: R4021 - DescriptionAndTitleMissing | 'UserAssignedIdentitiesProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Automation/stable/2022-08-08/account.json#L947 |
|
| :warning: R4030 - UniqueXmsExample | Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Update a module Location: Microsoft.Automation/stable/2022-08-08/python2package.json#L211 |
The following errors/warnings exist before current PR submission:
Only 15 items are listed, please refer to log for more details.
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| :warning: 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-2022-08-08 |
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.Automation' for api version '2022-08-08'. The supported api-versions are '2015-01-01-preview, 2015-10-31, 2017-05-15-preview, 2018-01-15, 2018-06-30, 2019-06-01, 2020-01-13-preview'." |
️❌~[Staging] ServiceAPIReadinessTest: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"ResourceType 'automationAccounts' should be deployed in 'West Central US' on apiVersion '2022-08-08'.: expected [ Array(16) ] to satisfy [Function]" |
️❌~[Staging] TrafficValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"ResourceType 'automationAccounts' should be deployed in 'West Central US' on apiVersion '2022-08-08'.: expected [ Array(16) ] to satisfy [Function]" |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️SDK Track2 Validation: 3 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/5e492b974bf1381301cf60a67f300b11046e8db0/specification/automation/resource-manager/readme.md#tag-package-2022-08-08">automation/resource-manager/readme.md#package-2022-08-08
| Rule | Message |
|---|---|
| :warning: UnkownSecurityScheme | "readme":"automation/resource-manager/readme.md", "tag":"package-2022-08-08", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
| :warning: Modeler/MissingType | "readme":"automation/resource-manager/readme.md", "tag":"package-2022-08-08", "details":"The schema 'ScheduleCreateOrUpdateProperties-interval' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/stable/2022-08-08/schedule.json#/components/schemas/ScheduleCreateOrUpdateProperties-interval" |
| :warning: Modeler/MissingType | "readme":"automation/resource-manager/readme.md", "tag":"package-2022-08-08", "details":"The schema 'ScheduleProperties-interval' has no type or format information whatsoever. Location:\n file:///mnt/vss/_work/1/azure-rest-api-specs/specification/automation/resource-manager/Microsoft.Automation/stable/2022-08-08/schedule.json#/components/schemas/ScheduleProperties-interval" |
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-go - armautomation - 0.8.0+ Function `*DscConfigurationClient.UpdateWithJSON` parameter(s) have been changed from `(context.Context, string, string, string, DscConfigurationUpdateParameters, *DscConfigurationClientUpdateWithJSONOptions)` to `(context.Context, string, string, string, *DscConfigurationClientUpdateWithJSONOptions)` + Function `*DscConfigurationClient.UpdateWithText` parameter(s) have been changed from `(context.Context, string, string, string, string, *DscConfigurationClientUpdateWithTextOptions)` to `(context.Context, string, string, string, *DscConfigurationClientUpdateWithTextOptions)`
❌azure-sdk-for-go - sdk/resourcemanager/automation/armautomation - 0.8.0+ Field `Body` of struct `RunbookDraftClientReplaceContentResponse` has been removed + Field `RunbookDraftUndoEditResult` of struct `RunbookDraftClientUndoEditResponse` has been removed + Field `Value` of struct `DscConfigurationClientGetContentResponse` has been removed + Struct `ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties` has been removed + Type of `Identity.UserAssignedIdentities` has been changed from `map[string]*ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties` to `map[string]*UserAssignedIdentitiesProperties`
️❌ azure-sdk-for-net failed [Detail]
❌Failed [Logs]Release - Generate from 0f161c7ced9e7c9bf5f04047d3edd194bd932687. SDK Automation 14.0.0warn Skip initScript due to not configured command sudo apt-get install -y dotnet-sdk-6.0 command autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/mnt/vss/_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 cmderr [Autorest] No usable version of the libssl was found cmderr [Autorest] FATAL: csharp/simplifier - FAILED cmderr [Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated. cmderr [Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated. error Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest warn Skip package processing as generation is failed
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from 0f161c7ced9e7c9bf5f04047d3edd194bd932687. SDK Automation 14.0.0command 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 Detectedinfo [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation group DeletedAutomationAccountsOperations info [Changelog] - Added operation group Python3PackageOperations info [Changelog] - Model HybridRunbookWorkerGroupCreateOrUpdateParameters has a new parameter name info [Changelog] - Model Operation has a new parameter origin info [Changelog] - Model Operation has a new parameter service_specification info [Changelog] - Model OperationDisplay has a new parameter description info [Changelog] info [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Model HybridRunbookWorkerGroup no longer has parameter hybrid_runbook_workers info [Changelog] - Operation DscConfigurationOperations.create_or_update no longer has parameter content_type info [Changelog] - Operation DscConfigurationOperations.update no longer has parameter content_type info [Changelog] - Operation HybridRunbookWorkerGroupOperations.update has a new parameter hybrid_runbook_worker_group_updation_parameters info [Changelog] - Operation HybridRunbookWorkerGroupOperations.update no longer has parameter parameters
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from 0f161c7ced9e7c9bf5f04047d3edd194bd932687. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️sdk/resourcemanager/automation/armautomation [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Function `*DscConfigurationClient.UpdateWithJSON` parameter(s) have been changed from `(context.Context, string, string, string, DscConfigurationUpdateParameters, *DscConfigurationClientUpdateWithJSONOptions)` to `(context.Context, string, string, string, *DscConfigurationClientUpdateWithJSONOptions)` info [Changelog] - Function `*DscConfigurationClient.UpdateWithText` parameter(s) have been changed from `(context.Context, string, string, string, string, *DscConfigurationClientUpdateWithTextOptions)` to `(context.Context, string, string, string, *DscConfigurationClientUpdateWithTextOptions)` info [Changelog] - Type of `Identity.UserAssignedIdentities` has been changed from `map[string]*ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties` to `map[string]*UserAssignedIdentitiesProperties` info [Changelog] - Struct `ComponentsSgqdofSchemasIdentityPropertiesUserassignedidentitiesAdditionalproperties` has been removed info [Changelog] - Field `Body` of struct `RunbookDraftClientReplaceContentResponse` has been removed info [Changelog] - Field `Value` of struct `DscConfigurationClientGetContentResponse` has been removed info [Changelog] - Field `RunbookDraftUndoEditResult` of struct `RunbookDraftClientUndoEditResponse` has been removed info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New function `NewPython3PackageClient(string, azcore.TokenCredential, *arm.ClientOptions) (*Python3PackageClient, error)` info [Changelog] - New function `*Python3PackageClient.CreateOrUpdate(context.Context, string, string, string, PythonPackageCreateParameters, *Python3PackageClientCreateOrUpdateOptions) (Python3PackageClientCreateOrUpdateResponse, error)` info [Changelog] - New function `*Python3PackageClient.Update(context.Context, string, string, string, PythonPackageUpdateParameters, *Python3PackageClientUpdateOptions) (Python3PackageClientUpdateResponse, error)` info [Changelog] - New function `*Python3PackageClient.Delete(context.Context, string, string, string, *Python3PackageClientDeleteOptions) (Python3PackageClientDeleteResponse, error)` info [Changelog] - New function `*Python3PackageClient.Get(context.Context, string, string, string, *Python3PackageClientGetOptions) (Python3PackageClientGetResponse, error)` info [Changelog] - New function `*Python3PackageClient.NewListByAutomationAccountPager(string, string, *Python3PackageClientListByAutomationAccountOptions) *runtime.Pager[Python3PackageClientListByAutomationAccountResponse]` info [Changelog] - New struct `Dimension` info [Changelog] - New struct `LogSpecification` info [Changelog] - New struct `MetricSpecification` info [Changelog] - New struct `OperationPropertiesFormat` info [Changelog] - New struct `OperationPropertiesFormatServiceSpecification` info [Changelog] - New struct `Python3PackageClient` info [Changelog] - New struct `Python3PackageClientCreateOrUpdateOptions` info [Changelog] - New struct `Python3PackageClientCreateOrUpdateResponse` info [Changelog] - New struct `Python3PackageClientDeleteOptions` info [Changelog] - New struct `Python3PackageClientDeleteResponse` info [Changelog] - New struct `Python3PackageClientGetOptions` info [Changelog] - New struct `Python3PackageClientGetResponse` info [Changelog] - New struct `Python3PackageClientListByAutomationAccountOptions` info [Changelog] - New struct `Python3PackageClientListByAutomationAccountResponse` info [Changelog] - New struct `Python3PackageClientUpdateOptions` info [Changelog] - New struct `Python3PackageClientUpdateResponse` info [Changelog] - New struct `UserAssignedIdentitiesProperties` info [Changelog] - New field `Parameters` in struct `DscConfigurationClientUpdateWithTextOptions` info [Changelog] - New field `Description` in struct `OperationDisplay` info [Changelog] - New field `Origin` in struct `Operation` info [Changelog] - New field `Properties` in struct `Operation` info [Changelog] - New field `Parameters` in struct `DscConfigurationClientUpdateWithJSONOptions` info [Changelog] info [Changelog] Total 8 breaking change(s), 44 additive change(s).
️🔄 azure-sdk-for-js inProgress [Detail]
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs]Release - Generate from 0f161c7ced9e7c9bf5f04047d3edd194bd932687. Schema Automation 14.0.0command .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
️✔️automation [View full logs] [Release Schema Changes]
️❌ azure-powershell failed [Detail]
❌Failed [Logs]Release - Generate from 0f161c7ced9e7c9bf5f04047d3edd194bd932687. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
❌Az.automation [View full logs] [Release SDK Changes]
Hi @sushil490023, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
Hi, @sushil490023 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
NewApiVersionRequired reason: A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support. EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/automation/armautomation | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| Python | track2_azure-mgmt-automation | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
Hi @sushil490023, 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. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.
@sushil490023 , can you fix prettierCheck error and get breaking change review approval?
@jianyexi , can you guide on the 'duplicated model' lintDiff error?
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi @raych1 I think it is false positive breaking change As With first of changes we were trying to add new resources to existing API version which resulted breaking changes, but now instead of adding swagger in old API version we have created A new API version and Added swagger to the new API version.
Hi @raych1 I think it is false positive breaking change As With first of changes we were trying to add new resources to existing API version which resulted breaking changes, but now instead of adding swagger in old API version we have created A new API version and Added swagger to the new API version.
You're right, cross version breaking change task passed too.
"$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"
Try use v3 when possible
Refers to: specification/automation/resource-manager/Microsoft.Automation/stable/2022-08-08/python3package.json:56 in b311391. [](commit_id = b311391ed2b0ea90457e1593e4ff80b9516816a9, deletion_comment = False)
"modelAsString": false
Any particular reason why this is false, it will be much easier to add if this is true https://armwiki.azurewebsites.net/api_contracts/guidelines/openapi.html?q=modelAsString#oapi015-avoid-modelling-a-property-as-string-type-when-it-should-be-an-enums
Refers to: specification/automation/resource-manager/Microsoft.Automation/stable/2022-08-08/python3package.json:636 in b311391. [](commit_id = b311391ed2b0ea90457e1593e4ff80b9516816a9, deletion_comment = False)
"modelAsString": falseAny particular reason why this is false, it will be much easier to add if this is true https://armwiki.azurewebsites.net/api_contracts/guidelines/openapi.html?q=modelAsString#oapi015-avoid-modelling-a-property-as-string-type-when-it-should-be-an-enums
Refers to: specification/automation/resource-manager/Microsoft.Automation/stable/2022-08-08/python3package.json:636 in b311391. [](commit_id = b311391, deletion_comment = False)
Updated it to enum Thanks
@zizw123 Thanks for reviewing.
With latest commit we have also added Response for 201 Status code in API Version for swagger hybridRunbookWorkerGroup and hybridRunbookWorker
"$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter"Try use v3 when possible
Refers to: specification/automation/resource-manager/Microsoft.Automation/stable/2022-08-08/python3package.json:56 in b311391. [](commit_id = b311391, deletion_comment = False)
these definitions is only present in v1, Thanks
See https://github.com/Azure/azure-rest-api-specs-pr/blob/main/specification/common-types/resource-management/v3/types.json#L638
Will not block this PR on this, signing off, and you can take a look at these v3
Commenter does not have sufficient privileges for PR 19771 in repo Azure/azure-rest-api-specs
Commenter does not have sufficient privileges for PR 19771 in repo Azure/azure-rest-api-specs