-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Fix Runbook Name patter as per public doc #22352
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
Conversation
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. [email protected] |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
runbook.json | 2022-08-08(1031054) | 2022-08-08(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2022-08-08 | package-2022-08-08(1031054) | package-2022-08-08(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
PathForNestedResource |
The path for nested resource doest not meet the valid resource pattern. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L39 |
ResourceNameRestriction |
The resource name parameter 'automationAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L39 |
XmsResourceInPutResponse |
The 200 response model for an ARM PUT operation must have x-ms-azure-resource extension set to true in its hierarchy.Operation: RunbookDraft_ReplaceContent Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L94 |
ValidFormats |
'file' is not a known format. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L135 |
CreateOperationAsyncResponseValidation |
An async PUT operation must return 201. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L143 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L150 |
ResourceNameRestriction |
The resource name parameter 'automationAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L172 |
ResourceNameRestriction |
The resource name parameter 'automationAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L225 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L226 |
PathForResourceAction |
Path for 'post' method on a resource type MUST follow valid resource naming. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L282 |
ResourceNameRestriction |
The resource name parameter 'automationAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L282 |
ResourceNameRestriction |
The resource name parameter 'automationAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L335 |
ResourceNameRestriction |
The resource name parameter 'automationAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L391 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property name. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L544 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property location. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L544 |
ResourceNameRestriction |
The resource name parameter 'automationAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L624 |
ResourceNameRestriction |
The resource name parameter 'automationAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L672 |
ResourceNameRestriction |
The resource name parameter 'automationAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L732 |
PathForNestedResource |
The path for nested resource doest not meet the valid resource pattern. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L795 |
ResourceNameRestriction |
The resource name parameter 'automationAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L795 |
XmsResourceInPutResponse |
The 200 response model for an ARM PUT operation must have x-ms-azure-resource extension set to true in its hierarchy.Operation: TestJob_Create Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L796 |
PathForResourceAction |
Path for 'post' method on a resource type MUST follow valid resource naming. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L908 |
ResourceNameRestriction |
The resource name parameter 'automationAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L908 |
PathForResourceAction |
Path for 'post' method on a resource type MUST follow valid resource naming. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L958 |
ResourceNameRestriction |
The resource name parameter 'automationAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L958 |
PathForResourceAction |
Path for 'post' method on a resource type MUST follow valid resource naming. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L1008 |
ResourceNameRestriction |
The resource name parameter 'automationAccountName' should be defined with a 'pattern' restriction. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L1008 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L1251 |
BodyTopLevelProperties |
Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'TestJob' has extra properties ['creationTime']. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L1596 |
BodyTopLevelProperties |
Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'TestJob' has extra properties ['status']. Location: Microsoft.Automation/stable/2022-08-08/runbook.json#L1596 |
️⚠️
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 succeeded [Detail] [Expand]
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
~[Staging] CadlAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
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.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Thank you for your contribution sushil490023! We will review the pull request and get back to you soon. |
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. |
Business' Justification : With last API introduction changes its kind of break changes which is impacting customer. |
@qiaozha @fengzhou-msft could you help with the SDK generation failure ? |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
|
…/en-us/azure/automation/manage-runbooks
Changes
With recent changes made to swagger https://github.com/Azure/azure-rest-api-specs/pull/21128/files#diff-8a2476001660339cd88481fb4f06109174b32e1be800923813a9c5ecd0fe53fd
Pattern rule was added to Runbook Name resource to mandatory requirement . However this pattern didnt matched with what is mentioned in public document and whats already being used by customer.
https://learn.microsoft.com/en-us/azure/automation/manage-runbooks
This introduced a bug in new cmdlets generated by usingthis swagger version for few customer.
The changes are used to fix the Name as per doc and fix breaking changes