-
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
Fixing RI s360 Flagged corrections in 2019-10-01 version #12777
Fixing RI s360 Flagged corrections in 2019-10-01 version #12777
Conversation
(cherry picked from commit 919cb1df3931e1a2d5d892b44470e85b78f55696)
Hi, @saipv 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. vsswagger@microsoft.com |
Swagger Validation Report
|
Rule | Message |
---|---|
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'Code', for definition: 'HighCasedErrorDetails' must follow camelCase style. Example: 'code'. New: Microsoft.Consumption/stable/2019-10-01/consumption.json#L4619 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'Message', for definition: 'HighCasedErrorDetails' must follow camelCase style. Example: 'message'. New: Microsoft.Consumption/stable/2019-10-01/consumption.json#L4624 |
R3016 - DefinitionsPropertiesNamesCamelCase |
Property named: 'Error', for definition: 'HighCasedErrorResponse' must follow camelCase style. Example: 'error'. New: Microsoft.Consumption/stable/2019-10-01/consumption.json#L4635 |
R4007 - DefaultErrorResponseSchema |
the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. New: Microsoft.Consumption/stable/2019-10-01/consumption.json#L1179 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
Swagger Generation Artifacts
|
In the Window Period to fix mismatches between swagger and service, when PR is labelled with “FixS360”, breaking change can be approved by PR assignee; the Azure Breaking Change Board is no longer required to approve the PR. Please ensure to clarify what s360 action items to be solved, and @ mention PR assignee for awareness. Please check this wiki [Window to Fix Broken]( Window to Fix Broken - Overview (azure.com)) for more details. |
Hi @saipv, 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. |
Hi @saipv, Your PR has some issues. Please fix the CI sequentially by following the order of
|
@@ -1179,7 +1179,7 @@ | |||
"default": { | |||
"description": "Error response describing why the operation failed.", | |||
"schema": { | |||
"$ref": "#/definitions/ErrorResponse" | |||
"$ref": "#/definitions/HighCasedErrorResponse" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about other references to ErrorResponse
? Do they need to be updated either?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@raych1 our APIs currently return both kind of Error Response - upper case one and the camelcasing ones. So keeping both these.
@saipv , can you fix the |
…into fix_resource_multiapi_submodule * 'master' of https://github.com/Azure/azure-rest-api-specs: (452 commits) Dev cost management microsoft.cost management 2020 12 01 preview new (Azure#12259) Edit securityContact swagger for 2020-01-01 (Azure#12265) [Hub Generated] Review request for Microsoft.Insights to add version stable/2020-10-01 (Azure#11579) [Hub Generated] Review request for Microsoft.Media to add version stable/2020-05-01 (Azure#12681) Fix TimeSeriesInsights swagger issues (Azure#12204) Fixing error in lastModifiedAt description (Azure#12854) Update comment.yml (Azure#12910) Fixing RI s360 Flagged corrections in 2019-10-01 version (Azure#12777) [Hub Generated] Review request for Microsoft.Web to add version stable/2020-10-01 (Azure#11636) [Ready For Review] New version 20210101 (Azure#12111) Update scheduledQueryRule_API.json (Azure#12895) Remove UserAssigned MSI (Azure#12900) Update library.json (Azure#12922) KeyVault: Feature/update security domain spec (Azure#12863) Fixes ExampleId type and incorrect ArmTokenParameter name (Azure#12896) Update contract for anomaly detector (Azure#12487) [NetAppFiles] Urgent bug fix, backup response, remove systemData(not in response yet) (Azure#12852) [AML] Add PipelineEndpoint with version and DataPathAssignments fields in AzureMLExecutePipeline (Azure#12744) remove duplicated schema (Azure#12779) [Web] Add Swagger for Service Principal (Azure#12780) ...
The PR for adding new version 2019-11-01 took longer than expected to be approved, so some fixes made in 10-01 were not included in 2019-11-01 version. The missing changes were the following PRs: #12777 #12555 #13039 #13097 #12822 #13280 #12942 #13248 #13378 This PR is to add those corrections to 2019-11-01 version
Adding fixes made in 2019-10-01 to 2019-11-01 (Azure#13414) The PR for adding new version 2019-11-01 took longer than expected to be approved, so some fixes made in 10-01 were not included in 2019-11-01 version. The missing changes were the following PRs: Azure/azure-rest-api-specs#12777 Azure/azure-rest-api-specs#12555 Azure/azure-rest-api-specs#13039 Azure/azure-rest-api-specs#13097 Azure/azure-rest-api-specs#12822 Azure/azure-rest-api-specs#13280 Azure/azure-rest-api-specs#12942 Azure/azure-rest-api-specs#13248 Azure/azure-rest-api-specs#13378 This PR is to add those corrections to 2019-11-01 version
Adding fixes made in 2019-10-01 to 2019-11-01 (#13414) The PR for adding new version 2019-11-01 took longer than expected to be approved, so some fixes made in 10-01 were not included in 2019-11-01 version. The missing changes were the following PRs: Azure/azure-rest-api-specs#12777 Azure/azure-rest-api-specs#12555 Azure/azure-rest-api-specs#13039 Azure/azure-rest-api-specs#13097 Azure/azure-rest-api-specs#12822 Azure/azure-rest-api-specs#13280 Azure/azure-rest-api-specs#12942 Azure/azure-rest-api-specs#13248 Azure/azure-rest-api-specs#13378 This PR is to add those corrections to 2019-11-01 version
Adding fixes made in 2019-10-01 to 2019-11-01 (Azure#13414) The PR for adding new version 2019-11-01 took longer than expected to be approved, so some fixes made in 10-01 were not included in 2019-11-01 version. The missing changes were the following PRs: Azure/azure-rest-api-specs#12777 Azure/azure-rest-api-specs#12555 Azure/azure-rest-api-specs#13039 Azure/azure-rest-api-specs#13097 Azure/azure-rest-api-specs#12822 Azure/azure-rest-api-specs#13280 Azure/azure-rest-api-specs#12942 Azure/azure-rest-api-specs#13248 Azure/azure-rest-api-specs#13378 This PR is to add those corrections to 2019-11-01 version
Adding fixes made in 2019-10-01 to 2019-11-01 (Azure#13414) The PR for adding new version 2019-11-01 took longer than expected to be approved, so some fixes made in 10-01 were not included in 2019-11-01 version. The missing changes were the following PRs: Azure/azure-rest-api-specs#12777 Azure/azure-rest-api-specs#12555 Azure/azure-rest-api-specs#13039 Azure/azure-rest-api-specs#13097 Azure/azure-rest-api-specs#12822 Azure/azure-rest-api-specs#13280 Azure/azure-rest-api-specs#12942 Azure/azure-rest-api-specs#13248 Azure/azure-rest-api-specs#13378 This PR is to add those corrections to 2019-11-01 version
Adding fixes made in 2019-10-01 to 2019-11-01 (#13414) The PR for adding new version 2019-11-01 took longer than expected to be approved, so some fixes made in 10-01 were not included in 2019-11-01 version. The missing changes were the following PRs: Azure/azure-rest-api-specs#12777 Azure/azure-rest-api-specs#12555 Azure/azure-rest-api-specs#13039 Azure/azure-rest-api-specs#13097 Azure/azure-rest-api-specs#12822 Azure/azure-rest-api-specs#13280 Azure/azure-rest-api-specs#12942 Azure/azure-rest-api-specs#13248 Azure/azure-rest-api-specs#13378 This PR is to add those corrections to 2019-11-01 version
The PR for adding new version 2019-11-01 took longer than expected to be approved, so some fixes made in 10-01 were not included in 2019-11-01 version. The missing changes were the following PRs: Azure#12777 Azure#12555 Azure#13039 Azure#13097 Azure#12822 Azure#13280 Azure#12942 Azure#13248 Azure#13378 This PR is to add those corrections to 2019-11-01 version
* Fixing RI s360 Flagged corrections in 2019-10-01 version (cherry picked from commit 919cb1df3931e1a2d5d892b44470e85b78f55696) * fix corresponding example
The PR for adding new version 2019-11-01 took longer than expected to be approved, so some fixes made in 10-01 were not included in 2019-11-01 version. The missing changes were the following PRs: Azure#12777 Azure#12555 Azure#13039 Azure#13097 Azure#12822 Azure#13280 Azure#12942 Azure#13248 Azure#13378 This PR is to add those corrections to 2019-11-01 version
(cherry picked from commit 919cb1df3931e1a2d5d892b44470e85b78f55696)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from API 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.