Adding the toplevel resource for querying the onboarded resources #15230
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Taking latest from upstream
Adding the definition of the new location based endpoint for getting the list of resources onboarded to use the network security perimeter feature.
Adding the example response for the resource endpoint
|
[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. |
|
Hi, @harics24 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
ghost
added
the
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The new version is adding a path that was not found in the old version. New: Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json#L241:5 |
️🔄LintDiff inProgress [Detail]
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️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.
️❌[Staging] SDK Track2 Validation: 2 Errors, 3 Warnings failed [Detail]
- The following tags are being changed in this PR
| Rule | Message |
|---|---|
|
"readme":"network/resource-manager/readme.md", "tag":"package-2021-03-preview", "details":"Duplicate Schema named CloudError -- properties.error.$ref: undefined => "#/components/schemas/schemas:3896" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
|
"readme":"network/resource-manager/readme.md", "tag":"package-2021-03-preview", "details":"Duplicate Schema named CloudErrorBody -- properties.details.$ref: undefined => "#/components/schemas/schemas:3900" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that." |
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-03-preview", "details":"Schema 'PerimeterAssociableResource' has a property 'id' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from PerimeterAssociableResource" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-03-preview", "details":"Schema 'PerimeterAssociableResource' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from PerimeterAssociableResource" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-03-preview", "details":"Schema 'PerimeterAssociableResource' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from PerimeterAssociableResource" |
|
| 💬 AutorestCore/Exception | "readme":"network/resource-manager/readme.md", "tag":"package-2021-03-preview", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
| 💬 AutorestCore/Exception | "readme":"network/resource-manager/readme.md", "tag":"package-2021-03-preview", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
"readme":"network/resource-manager/readme.md", "tag":"package-2021-03-preview", "details":"Error: Plugin prechecker reported failure." |
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-03-preview", "details":"Schema 'NetworkSecurityPerimeter' has a property 'id' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from NetworkSecurityPerimeter" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-03-preview", "details":"Schema 'NetworkSecurityPerimeter' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from NetworkSecurityPerimeter" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-03-preview", "details":"Schema 'NetworkSecurityPerimeter' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from NetworkSecurityPerimeter" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-03-preview", "details":"Schema 'ResourceNavigationLink' has a property 'id' that is already declared the parent schema 'SubResource' but 'readonly' has been changed -- this is not permitted. The property has been removed from ResourceNavigationLink" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-03-preview", "details":"Schema 'VpnServerConfiguration' has a property 'name' that is already declared the parent schema 'Resource' but 'readonly' has been changed -- this is not permitted. The property has been removed from VpnServerConfiguration" |
|
| 💬 AutorestCore/Exception | "readme":"network/resource-manager/readme.md", "tag":"package-2021-03-preview", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
|
NewApiVersionRequired reason: |
This was referenced Jul 16, 2021
added 7 commits
July 16, 2021 19:55
Fixing a duplicate definition error.
|
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. |
|
@harics24, this change is adding new Uri paths to an existing API version which is a breaking change. Current automation is failing to correctly add the BreakingChangeReviewRequired label (actually it incorrectly removed it in this case). I've added it back. Please follow the instructions to get a breaking change review. After you have breaking change signoff, send an email to armapireview group so the current oncall can pick up the review. |
|
@lirenhe , I see 3 failures: 1). https://github.com/Azure/azure-rest-api-specs/pull/15230/checks?check_run_id=3088578737: 2). https://github.com/Azure/azure-rest-api-specs/pull/15230/checks?check_run_id=3088578981: 3). https://github.com/Azure/azure-rest-api-specs/pull/15230/checks?check_run_id=3088578904: |
Hi @mentat9 , this is a new service/endpoint and had never been exposed. There are no users. We are working on the very first version. We need the endpoints to be available through ARM. So, we had initiated the changes in manifest. The ARM had requested for swagger PR. This PR for the same. There's not really anything that we're breaking. |
|
OK, please work with this week's oncall @majastrz to get this API reviewed. |
JeffreyRichter
added
the
Approved-BreakingChange
majastrz
added
ARMSignedOff
lirenhe
approved these changes
Jul 20, 2021
This was referenced Jul 20, 2021
This was referenced Aug 5, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This resource definition is for the top level readonly endpoint that serves the list of perimeter associable resources (resources/RPs that are onboarded to use the network security perimeter feature).
Changelog
Please ensure to add changelog with 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
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 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.