azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Nipadhye/firewall packet capture feature
ARM API Information (Control Plane)
** Closed another PR which was active to move the feature to the correct API Version** Link to closed PR: https://github.com/Azure/azure-rest-api-specs/pull/20601 MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow. 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:
- What's the purpose of the update?
- [ ] new service onboarding
- [ ] new API version
- [X] update existing version for new feature
- [ ] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
- When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month. NRP 170 - 9/23
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. Next release, 9/23 NRP 170 release
- By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
Contribution checklist (MS Employees Only):
- [X] I commit to follow the Breaking Change Policy of "no breaking changes"
- [X] I have reviewed the documentation for the workflow.
- [X] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
- Change to data plane APIs
- Adding new properties
- All removals
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.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[ ] 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.
Hi, @nikhilpadhye1 Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️❌BreakingChange: 1005 Errors, 11 Warnings failed [Detail]
Only 0 items are rendered, please refer to log for more details.
Only -1 items are listed, please refer to log for more details.
| Rule | Message |
|---|
️❌Breaking Change(Cross-Version): 21 Errors, 26 Warnings failed [Detail]
Only 0 items are rendered, please refer to log for more details.
The following breaking changes are detected by comparison with the latest stable version:
Only -1 items are listed, please refer to log for more details.
| Rule | Message |
|---|
️🔄LintDiff inProgress [Detail]
️❌Avocado: 761 Errors, 5 Warnings failed [Detail]
Only -1 items are listed, please refer to log for more details.
| Rule | Message |
|---|
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️🔄CadlAPIView inProgress [Detail]
️❌ModelValidation: 800 Errors, 0 Warnings failed [Detail]
Only -1 items are listed, please refer to log for more details.
| Rule | Message |
|---|
️❌SemanticValidation: 9 Errors, 0 Warnings failed [Detail]
Only -1 items are listed, please refer to log for more details.
| Rule | Message |
|---|
️❌PrettierCheck: 1 Errors, 0 Warnings failed [Detail]
Only -1 items are listed, please refer to log for more details.
| Rule | Message |
|---|
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️❌CadlValidation: 12 Errors, 11 Warnings failed [Detail]
Only -1 items are listed, please refer to log for more details.
| Rule | Message |
|---|
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
️⚠️SDK Breaking Change Tracking warning [Detail]
Only 0 items are rendered, please refer to log for more details.
️❌ azure-sdk-for-net-track2 failed [Detail]
Only 0 items are rendered, please refer to log for more details.
️❌ azure-sdk-for-python failed [Detail]
Only 0 items are rendered, please refer to log for more details.
️❌ azure-powershell failed [Detail]
Only 0 items are rendered, please refer to log for more details.
️🔄 azure-sdk-for-python-track2 inProgress [Detail]
️⚠️ azure-sdk-for-java warning [Detail]
Only 0 items are rendered, please refer to log for more details.
️🔄 azure-sdk-for-js inProgress [Detail]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
Only 0 items are rendered, please refer to log for more details.
️🔄 azure-resource-manager-schemas inProgress [Detail]
️❌ azure-sdk-for-net failed [Detail]
Only 0 items are rendered, please refer to log for more details.
Generated ApiView
@raosuhas @lirenhe moved the PR to correct API version. Ran into issues trying to rebase previous PR branch so making this new active PR. Addressed all the comments left by @raosuhas in the older PR
Hi @nikhilpadhye1, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
@nikhilpadhye1, could you fix the model validation errors? The Swagger example has some conflicts with API definition.
@nikhilpadhye1 Please merge public main branch into Azure:release-network-Microsoft.Network-2022-07-01 to pass python pipeline
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
@nikhilpadhye1 Please merge public main branch into Azure:release-network-Microsoft.Network-2022-07-01 to pass python pipeline
I tried to merge public main into the release branch and got up-to-date message from command-line @msyyc
@lirenhe @raosuhas is there anymore feedback for the PR? Can we close this?
@MikhailTryakhov @raosuhas @lirenhe @raych1 Can we please get the review on the PR?
@nikhilpadhye1, Please work with ARM team to address their feedback. I also see the PR to merge from network 2022-07-01 to main branch was already created. Could you work with @MikhailTryakhov about the timeline for this one?
Hi, @nikhilpadhye1. 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 no-recent-activity label.
Hi, @nikhilpadhye1. 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.
NewApiVersionRequired reason: A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support. EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.
@raosuhas can you please take a look at the response to comments and fix of NIT and approve or advice on further changes?
Hi, @nikhilpadhye1 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).
Please check the lint error in https://github.com/Azure/azure-rest-api-specs/pull/21080/checks?check_run_id=11211115269
Please check the lint error in https://github.com/Azure/azure-rest-api-specs/pull/21080/checks?check_run_id=11211115269
Adding the pattern linter error is existing for firewall. Adding the pattern may cause the feature to not be accessible to existing azure firewall customers. If you have a suggestion on how to safely circumvent this possibility, please let me know. Need a solution as this is a blocker for the PR. @zizw123
@nikhilpadhye1, I already see the PR to merge NRP 2022-09-01 to main branch. Please work with @MikhailTryakhov if this PR is needed for 2022-09-01, otherwise, you need to wait for the next release.
Hi @nikhilpadhye1, 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. 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. If you want to know the production traffic statistic, please see ARM Traffic statistic. If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.
Hi, @nikhilpadhye1, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline
Hi @nikhilpadhye1, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval.
![azure-pipelines[bot] avatar](https://avatars.githubusercontent.com/in/9426?v=4 "Published by a pub.dev verified publisher"){kind=small}
@nikhilpadhye1, can you follow instructions to get breaking change approval?
This PR was signed off by arm team for 2022-09-01 but approvals didnt make the cut date. Closing this pr and making new one for 2022-11-01.