-
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
Azure CDN : Change casing for subscription ID and API version #12159
Azure CDN : Change casing for subscription ID and API version #12159
Conversation
Hi, @jorinmejia 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] |
Hi, @jorinmejia 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
|
Rule | Message |
---|---|
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'SubscriptionIdParameter' removed or renamed? New: Microsoft.Cdn/stable/2020-09-01/cdnwebapplicationfirewall.json#L890:3 Old: Microsoft.Cdn/stable/2020-09-01/cdnwebapplicationfirewall.json#L890:3 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'ApiVersionParameter' removed or renamed? New: Microsoft.Cdn/stable/2020-09-01/cdnwebapplicationfirewall.json#L890:3 Old: Microsoft.Cdn/stable/2020-09-01/cdnwebapplicationfirewall.json#L890:3 |
️️✔️
LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
️️✔️
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
|
Rule | Message |
---|---|
RestBuild error |
"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=188153&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"Run.ps1 failed with exit code 1 " |
Hi @jorinmejia, 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. |
The failure on go and python seems relate to description difference on https://github.com/Azure/azure-rest-api-specs/blob/master/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-09-01/afdx.json#L5554-L5560 |
Hi, @jorinmejia. 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 @jorinmejia, 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 @jorinmejia, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
"SubscriptionIdParameter": { | ||
"subscriptionIdParameter": { | ||
"name": "subscriptionId", | ||
"in": "path", | ||
"description": "Azure Subscription ID.", | ||
"required": true, | ||
"type": "string" | ||
}, | ||
"ApiVersionParameter": { | ||
"apiVersionParameter": { | ||
"name": "api-version", |
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.
Is there reason to make these casing changes?
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.
We need to make these casing changes because the Python SDK generation was failing. It was failing because the casing for subscriptionIdParameter and apiVersionParameter was not consistent in the afdx.json and cdn.json files.
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
@ArcturusZhang This PR make some casing change on type name to make it consistent across 3 JSONs. Go SDK reports breaking changes, do you know whether they are OK or not? |
@jorinmejia Go SDK is OK with it. Let me know when you need it merged. |
@weidongxu-microsoft, please merge the changes ASAP. Thank you. |
…12159) * change casing of for subId and apiVersion * fix references * fix mismacth in apiVersion description * fix description in cdnwaf Co-authored-by: Jorin Mejia <[email protected]>
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.
ASAP
ASAP
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.