-
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] Add x-ms-enum extension to fix Pandora SDK const conflict #26619
Conversation
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
cdn.json | 2023-05-01(b341dc8) | 2023-05-01(main) |
Only 30 items are listed, please refer to log for more details.
️️✔️
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.1.6) | new version | base version |
---|---|---|
package-2023-05 | package-2023-05(b341dc8) | package-2023-05(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/cdn.json#L118 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L163 |
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 |
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 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. 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 |
PostResponseCodes |
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 |
PostResponseCodes |
200 return code does not have a schema specified. LRO POST must have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. 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 |
PutResponseCodes |
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L773 |
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 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. 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 |
PostResponseCodes |
202 response for a LRO POST operation must not have a response schema specified. 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 |
ResourceNameRestriction |
The resource name parameter 'profileName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L1049 |
ResourceNameRestriction |
The resource name parameter 'endpointName' should be defined with a 'pattern' restriction. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L1049 |
PostResponseCodes |
202 response for a LRO POST operation must not have a response schema specified. Location: Microsoft.Cdn/stable/2023-05-01/cdn.json#L1050 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️❌
ModelValidation: 26 Errors, 0 Warnings failed [Detail]
️️✔️
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).
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
Please address or respond to feedback from the ARM API reviewer. |
Hi, @t-bzhan. 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 |
2 similar comments
Hi, @t-bzhan. 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 |
Hi, @t-bzhan. 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 |
Hi, @t-bzhan. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee. |
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting help
section below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
Our existing swagger definition does not follow the best practice of polymorphism to define class inheritance hierarchy, a hard-coded property (typeName) with a single ENUM value is in a lot of places for deserialization purpose. It will break the Hashicorp Pandora SDK generation which will impact Terraform integration for Azure Front Door Standard/Premium service, as Golang does not support ENUM naturally. It will use string constants instead. In our case, with so many ENUMs with the same name “typeName”, it will complain about name conflict when generating Golang SDK:
CDN
@2023-05-01
- issue importing hashicorp/pandora#2831. Azure SDK Track2 for Golang does not have the problem as they did some workaround to add prefixes when the name is conflicting, which is not recommended by Pandora team. This PR aims to add x-ms-enum extension to fix Pandora SDK const conflict. This is introduced as a workaround and we will fix the swagger in next stable version.Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReview
label.Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiView
comment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.