Created New Stable API Version for python3 Runbook APIs #19771
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @sushil490023 Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| 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] |
|---|---|---|
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| 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 |
||
| '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 |
||
| 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 |
|---|---|
| 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 |
|---|---|
| "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" |
|
| "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" |
|
| "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.
Swagger Generation Artifacts
|
|
Hi @sushil490023, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi, @sushil490023 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
@sushil490023 , can you resolve |
rkmanda
reviewed
Jul 20, 2022
...ation/automation/resource-manager/Microsoft.Automation/stable/2022-07-15/python3package.json
Outdated
Show resolved
Hide resolved
rkmanda
added
the
ARMChangesRequested
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
NewApiVersionRequired reason: |
Generated ApiView
|
|
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. |
|
@sushil490023 , can you fix @jianyexi , can you guide on the 'duplicated model' |
openapi-pipeline-app
bot
added
CI-BreakingChange-Go
and removed
NewApiVersionRequired
labels
|
Commenter does not have sufficient privileges for PR 19771 in repo Azure/azure-rest-api-specs |
|
/azp run |
|
Commenter does not have sufficient privileges for PR 19771 in repo Azure/azure-rest-api-specs |
|
/azp run |
|
Commenter does not have sufficient privileges for PR 19771 in repo Azure/azure-rest-api-specs |
|
/azp run |
|
Commenter does not have sufficient privileges for PR 19771 in repo Azure/azure-rest-api-specs |
|
/azp run |
|
Commenter does not have sufficient privileges for PR 19771 in repo Azure/azure-rest-api-specs |
|
/azp run |
|
Commenter does not have sufficient privileges for PR 19771 in repo Azure/azure-rest-api-specs |
sushil490023
force-pushed
the
updatePython3Swagger
branch
from
1705784
to
5e492b9
Compare
JeffreyRichter
added
the
Approved-BreakingChange
jianyexi
approved these changes
Sep 2, 2022
jianyexi
added
the
Approved-OkToMerge
|
Hi, @sushil490023. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
ghost
added
the
|
@raych1 Now ARM Manifest changes has been deployed in all the public region and we can merge this PR. |
This was referenced Sep 23, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
What's the purpose of the update?
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.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.