-
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
Adding NSP child resources, profile and access rule, to swagger #18066
Conversation
Taking latest from upstream
Hi, @harics24 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 |
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
Rule | Message |
---|---|
'PerimeterBasedAccessRule' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1012 |
|
'NspAssociationProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1078 |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
The resource 'PerimeterAssociableResource' does not have get operation, please add it. Location: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1110 |
|
The API version:2021-02-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L6 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
SDK Track2 Validation succeeded [Detail]
- The following tags are being changed in this PR
Rule | Message |
---|---|
|
"readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Error: Plugin prechecker reported failure." |
️️✔️
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).
Swagger Generation Artifacts
|
Hi @harics24, Your PR has some issues. Please fix the CI sequentially by following the order of
|
NewApiVersionRequired reason: |
Hi @harics24, 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 Hari Ive responded again to the comments. Please fix the one about the resource definition since the duplication of the values could cause issues in the parser and remove location if it is not needed, we want to avoid asking clients to provide more information than necessary since it needlessly increases the surface area for errors. Rest are suggestions which will make your apis more usable and I would strongly suggest to incorporate them. I am adding the ARMsigned off since none of these are issues are blocking. |
Hi @raych1 , could approve this PR? we got the sign offs from ARM teams. |
From my opinion, it's a preview version, so LGTM from api version perspective... Please let me know if you need to review something special |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
@raych1 , Our portal team is waiting for the changes. I see that the go sdk is taking time. Please approve and merge while the SDK owner team is investigating the issue. We have some minor changes pending and few new APIs to be added too. For now, we should unblock the portal team. |
@akning-ms , can you help force merge this PR as the GO SDK task failed by timeout? Dapeng confirmed it's ok to ignore. |
* Defining the APIs for the new NSP resource * Adding NSP child resources - profile and access rule * Fixing the model errors, prettier-fix and typos * Fixing the typo in the spec file for NSP * Adding definitions for resource association * Prettier fix on the spec and example files * Fix typos, and removing the apiVersion on the top level * Handling the review comments * Correcting the subId in the path * Adding the NSP preview version for go in the read me Co-authored-by: Hari Prasad Perabattula <haperaba@microsoft.com> Co-authored-by: Hari Prasad Perabattula <Hari.Perabattula@Microsoft.com>
…e#18066) * Defining the APIs for the new NSP resource * Adding NSP child resources - profile and access rule * Fixing the model errors, prettier-fix and typos * Fixing the typo in the spec file for NSP * Adding definitions for resource association * Prettier fix on the spec and example files * Fix typos, and removing the apiVersion on the top level * Handling the review comments * Correcting the subId in the path * Adding the NSP preview version for go in the read me Co-authored-by: Hari Prasad Perabattula <haperaba@microsoft.com> Co-authored-by: Hari Prasad Perabattula <Hari.Perabattula@Microsoft.com>
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change 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.