-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
update innererror to fix s360 correctness #21863
Conversation
Hi, @vutran01 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.2)] | new version | base version |
---|---|---|
workbooks_API.json | 2021-08-01(7f263f3) | 2021-08-01(main) |
workbooks_API.json | 2022-04-01(7f263f3) | 2022-04-01(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-04-01 | package-2022-04-01(7f263f3) | package-2022-04-01(main) |
package-2022-01-11 | package-2022-01-11(7f263f3) | package-2022-01-11(main) |
package-2021-11-01 | package-2021-11-01(7f263f3) | package-2021-11-01(main) |
package-2022-12-09-only | package-2022-12-09-only(7f263f3) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L139 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L139 |
RepeatedPathInfo |
The 'sourceId' already appears in the path, please don't repeat it in the request body. Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L236 |
RepeatedPathInfo |
The 'sourceId' already appears in the path, please don't repeat it in the request body. Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L236 |
PatchIdentityProperty |
The patch operation body parameter schema should contains property 'identity'. Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L300 |
PatchIdentityProperty |
The patch operation body parameter schema should contains property 'identity'. Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L300 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L340 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L340 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L382 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L382 |
ArmResourcePropertiesBag |
Top level property names should not be repeated inside the properties bag for ARM resource 'Workbook'. Properties [properties.tags] conflict with ARM top level properties. Please rename these. Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L482 |
ArmResourcePropertiesBag |
Top level property names should not be repeated inside the properties bag for ARM resource 'Workbook'. Properties [properties.tags] conflict with ARM top level properties. Please rename these. Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L482 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L139 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L139 |
RepeatedPathInfo |
The 'sourceId' already appears in the path, please don't repeat it in the request body. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L236 |
RepeatedPathInfo |
The 'sourceId' already appears in the path, please don't repeat it in the request body. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L236 |
PatchIdentityProperty |
The patch operation body parameter schema should contains property 'identity'. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L300 |
PatchIdentityProperty |
The patch operation body parameter schema should contains property 'identity'. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L300 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L340 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L340 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L382 |
ResourceNameRestriction |
The resource name parameter 'resourceName' should be defined with a 'pattern' restriction. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L382 |
ArmResourcePropertiesBag |
Top level property names should not be repeated inside the properties bag for ARM resource 'Workbook'. Properties [properties.tags] conflict with ARM top level properties. Please rename these. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L478 |
ArmResourcePropertiesBag |
Top level property names should not be repeated inside the properties bag for ARM resource 'Workbook'. Properties [properties.tags] conflict with ARM top level properties. Please rename these. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L478 |
'GET' operation 'Workbooks_RevisionsList' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L343 |
|
'GET' operation 'Workbooks_RevisionsList' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L343 |
|
'GET' operation 'Workbooks_RevisionGet' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L385 |
|
'GET' operation 'Workbooks_RevisionGet' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Insights/stable/2021-08-01/workbooks_API.json#L385 |
|
'GET' operation 'Workbooks_RevisionsList' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L343 |
|
'GET' operation 'Workbooks_RevisionsList' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Insights/stable/2022-04-01/workbooks_API.json#L343 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/applicationinsights/resource-manager/readme.md tag: specification/applicationinsights/resource-manager/readme.md#tag-package-2022-12-09-only |
️️✔️
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]
️️✔️
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
|
Generated ApiView
|
NewApiVersionRequired reason: |
Hi @vutran01, 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. |
It is possible to change it in service code to keep consistent, as it caused breaking change which need breaking change review board to approve |
clients have been using this structure for a long time, changing the service would break all the clients. the swagger has been incorrect so this change is needed to match swagger to what the service has been doing. even creating a new api-version will not resolve swagger correctly for existing api-version |
I am not sure what clients is using "innererror"? as they(SDK, PS...) are generated from Swagger. it should be using "innerError. the breaking change I said means this PR caused client breaking change. so suggest change service code if possible. otherwise. you should get breaking change review board approval first. refer to #21863 (comment) |
Hi, @vutran01. 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 |
@akning-ms can you take a look at this PR again as the breaking change has been approved? |
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist (MS Employees Only):
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 apply 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.