-
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
[CDN][2023-05-01] Fix async operation options for migrate related APIs #24164
Conversation
Hi, @TracyYaoYao 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 |
---|---|---|
cdn.json | 2023-05-01(61c04ab) | 2023-05-01(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 3 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.2) | new version | base version |
---|---|---|
package-2023-05 | package-2023-05(61c04ab) | package-2023-05(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
Schema should have a description or title. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L2901 |
||
Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L2904 |
||
Schema should have a description or title. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L3040 |
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/cdn.json#L118 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L201 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L228 |
PatchSkuProperty |
The patch operation body parameter schema should contains property 'sku'. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L256 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L293 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L299 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L346 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L403 |
LroPostReturn |
202 response for a LRO POST operation must not have a response schema specified. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L414 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L466 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L476 |
LroPostReturn |
200 response for a LRO POST operation must have a response schema specified. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L477 |
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/cdn.json#L477 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L521 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L531 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L577 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L623 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L672 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L721 |
ResourceNameRestriction |
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L721 |
PutResponseSchemaDescription |
Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L818 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L845 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L917 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L923 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L977 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L984 |
ResourceNameRestriction |
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L984 |
LroPostReturn |
202 response for a LRO POST operation must not have a response schema specified. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L985 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L985 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L1042 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️
~[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 @TracyYaoYao, Your PR has some issues. Please fix the CI sequentially by following the order of
|
21ffcb5
to
72a3236
Compare
2e4892c
to
6b91512
Compare
6b91512
to
071e8f1
Compare
Hi @TracyYaoYao, 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. |
c050538
to
503cb11
Compare
...ation/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Profiles_CanMigrate.json
Outdated
Show resolved
Hide resolved
@TracyYaoYao does this PR has private PR? please fix LintDiff and ModelValidation error |
52674e2
to
bf61a4a
Compare
The model validation errors are carried over from existing swaggers and the author would fix them in separate PR later |
Azure#24164) Co-authored-by: yaoshi <yaoshi@microsoft.com>
ARM API Information (Control Plane)
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. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
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.