-
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
[Hub Generated] Review request for Microsoft.Cdn to add version stable/2023-05-01 #23615
Conversation
Hi, @gubalasu 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.10.4)] | new version | base version |
---|---|---|
afdx.json | 2023-05-01(19f2135) | 2021-06-01(main) |
afdx.json | 2023-05-01(19f2135) | 2022-11-01-preview(main) |
cdn.json | 2023-05-01(19f2135) | 2021-06-01(main) |
cdn.json | 2023-05-01(19f2135) | 2022-11-01-preview(main) |
cdnwebapplicationfirewall.json | 2023-05-01(19f2135) | 2021-06-01(main) |
cdnwebapplicationfirewall.json | 2023-05-01(19f2135) | 2022-11-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Rule | Message |
---|---|
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Cdn/validateSecret' removed or restructured? Old: Microsoft.Cdn/stable/2021-06-01/afdx.json#L3242:5 |
1048 - AddedXmsEnum |
The new version adds a x-ms-enum extension. New: Microsoft.Cdn/stable/2023-05-01/afdx.json#L5829:9 Old: Microsoft.Cdn/stable/2021-06-01/afdx.json#L5497:9 |
1048 - AddedXmsEnum |
The new version adds a x-ms-enum extension. New: Microsoft.Cdn/stable/2023-05-01/afdx.json#L5849:15 Old: Microsoft.Cdn/stable/2021-06-01/afdx.json#L5513:15 |
1048 - AddedXmsEnum |
The new version adds a x-ms-enum extension. New: Microsoft.Cdn/stable/2023-05-01/afdx.json#L6062:9 Old: Microsoft.Cdn/stable/2021-06-01/afdx.json#L5722:9 |
1048 - AddedXmsEnum |
The new version adds a x-ms-enum extension. New: Microsoft.Cdn/stable/2023-05-01/afdx.json#L6082:15 Old: Microsoft.Cdn/stable/2021-06-01/afdx.json#L5738:15 |
The following breaking changes are detected by comparison with the latest preview version:
Rule | Message |
---|---|
The new version adds a response code '202'. New: Microsoft.Cdn/stable/2023-05-01/cdn.json#L392:11 |
|
The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Cdn/stable/2023-05-01/cdn.json#L354:7 Old: Microsoft.Cdn/preview/2022-11-01-preview/cdn.json#L354:7 |
️️✔️
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-2023-05 | package-2023-05(19f2135) | 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 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L136 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L185 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L357 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L406 |
ResourceNameRestriction |
The resource name parameter 'customDomainName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L406 |
RepeatedPathInfo |
The 'profileName' already appears in the path, please don't repeat it in the request body. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L473 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L521 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L521 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L614 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L678 |
ResourceNameRestriction |
The resource name parameter 'customDomainName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L678 |
PostOperationAsyncResponseValidation |
An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L679 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L740 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L789 |
ResourceNameRestriction |
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L789 |
RepeatedPathInfo |
The 'profileName' already appears in the path, please don't repeat it in the request body. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L856 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L899 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L997 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L1061 |
ResourceNameRestriction |
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L1061 |
PostOperationAsyncResponseValidation |
An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options' Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L1062 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L1132 |
ResourceNameRestriction |
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L1132 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L1188 |
ResourceNameRestriction |
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L1188 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L1250 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L1299 |
ResourceNameRestriction |
The resource name parameter 'originGroupName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L1299 |
RepeatedPathInfo |
The 'profileName' already appears in the path, please don't repeat it in the request body. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L1366 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.Cdn/stable/2023-05-01/afdx.json#L1409 |
️❌
Avocado: 4 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
MISSING_APIS_IN_DEFAULT_TAG |
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cdn/resource-manager/readme.md json: Microsoft.Cdn/stable/2020-09-01/cdnwebapplicationfirewall.json |
MISSING_APIS_IN_DEFAULT_TAG |
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.Cdn/CdnWebApplicationFirewallPolicies/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cdn/resource-manager/readme.md json: Microsoft.Cdn/stable/2020-09-01/cdnwebapplicationfirewall.json |
MISSING_APIS_IN_DEFAULT_TAG |
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Cdn/CdnWebApplicationFirewallManagedRuleSets is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cdn/resource-manager/readme.md json: Microsoft.Cdn/stable/2020-09-01/cdnwebapplicationfirewall.json |
MISSING_APIS_IN_DEFAULT_TAG |
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.Cdn/validateSecret is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/cdn/resource-manager/readme.md json: Microsoft.Cdn/stable/2021-06-01/afdx.json |
️❌
ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
API Readiness check failed. Please make sure your service is deployed. |
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.Cdn' for api version '2023-05-01'. The supported api-versions are '2015-06-01, 2016-04-02, 2016-10-02, 2017-04-02, 2017-10-12, 2018-04-02, 2019-04-15, 2019-06-15-preview, 2019-12-31, 2020-03-31, 2020-04-15, 2020-09-01, 2021-06-01, 2022-05-01-preview, 2022-11-01-preview, 2023-02-01-preview'." |
️⚠️
~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️❌
ModelValidation: 52 Errors, 0 Warnings failed [Detail]
Only 30 items are listed, please refer to log for more details.
️️✔️
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.
️️✔️
TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @gubalasu, 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. |
/azp run unifiedPipeline |
No pipelines are associated with this pull request. |
Swagger Generation Artifacts
|
Hi @gubalasu, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Waiting to do breaking change review |
Breaking change previously reviewed and approved in #20979 |
@gubalasu, please fix the tooling check error for 'Swagger Avocado' & Swagger ModelValidation. Those are required for merging the PR. Thanks |
@weidongxu-microsoft, @qiaozha, @tadelesh, could you help to check the SDK breaking changes for this PR? |
Remove path may cause some problem, but so far it is not exposed in convenience API in Java. x-ms-enum change maybe fine, I assume m4 default to modelAsString=true |
SDK errors are not because of the changes in this PR. Rather it was carried over from older ones. These are already approved in an older version: https://github.com/Azure/azure-rest-api-specs/pull/23493/checks?check_run_id=12625114723 |
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
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.