Remove NSP private APIs #19500
Closed
Remove NSP private APIs #19500
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
|
Hi, @kaushal087 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 |
Swagger Validation Report
|
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| networkSecurityPerimeter.json | 2021-02-01-preview(eb18f39) | 2021-02-01-preview(main) |
| Rule | Message |
|---|---|
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/resourceAssociationProxies/{associationName}' removed or restructured? Old: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L749:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/resourceAssociationProxies' removed or restructured? Old: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L860:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/profiles/{networkSecurityPerimeterProfile}/checkMembers' removed or restructured? Old: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L950:5 |
|
The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Network/locations/{location}/queryNetworkSecurityPerimeter' removed or restructured? Old: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1006:5 |
|
The new version is missing a definition that was found in the old version. Was 'CheckMembers' removed or renamed? New: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L851:3 Old: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1110:3 |
|
The new version is missing a definition that was found in the old version. Was 'QueryNSPReqRes' removed or renamed? New: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L851:3 Old: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1110:3 |
|
The required parameter 'api-version' was added in the new version. |
|
The required parameter 'api-version' was added in the new version. New: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L627:9 |
|
The required parameter 'api-version' was added in the new version. |
|
The read only property has changed from 'false' to 'true'. New: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L911:9 Old: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1171:9 |
|
The read only property has changed from 'true' to 'false'. New: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L860:9 Old: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1119:9 |
| The new version has a different type 'object' than the previous one 'string'. New: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1060:11 Old: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1319:11 |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2021-02-preview | package-2021-02-preview(eb18f39) | package-2021-02-preview(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| 'SubscriptionId' 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#L1077 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| OperationId should contain the verb: 'reconcile' in:'NspAccessRulesReconcile_Post'. Consider updating the operationId Location: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L816 |
|
| The resource 'PerimeterAssociableResource' does not have get operation, please add it. Location: Microsoft.Network/preview/2021-02-01-preview/networkSecurityPerimeter.json#L1188 |
|
| '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#L1086 |
|
| '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#L1152 |
|
| 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.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"errorCode: AssertionError, errorMessage: ResourceType 'networkSecurityPerimeters' should be deployed in 'West Central US' on apiVersion '2021-02-01'.: expected [ Array(153) ] to satisfy [Function]" |
|
"errorCode: AssertionError, errorMessage: ResourceType 'networkSecurityPerimeters' should be deployed in 'West Central US' on apiVersion '2021-02-01'.: expected [ Array(153) ] to satisfy [Function]" |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️❌SDK Track2 Validation: 2 Errors, 2 Warnings failed [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/eb18f390c927ad6e5c706b2d4b1d5c14728a8672/specification/network/resource-manager/readme.md#tag-package-2021-02-preview-only">network/resource-manager/readme.md#package-2021-02-preview-only
- "https://github.com/Azure/azure-rest-api-specs/blob/eb18f390c927ad6e5c706b2d4b1d5c14728a8672/specification/network/resource-manager/readme.md#tag-package-2021-02-preview">network/resource-manager/readme.md#package-2021-02-preview
| Rule | Message |
|---|---|
|
"readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Duplicate Schema named 'CloudError' (1 differences):\n - properties.error.$ref: "#/components/schemas/schemas:11" => "#/components/schemas/schemas:4256"; 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-02-preview", "details":"Duplicate Schema named 'CloudErrorBody' (1 differences):\n - properties.details.$ref: "#/components/schemas/schemas:15" => "#/components/schemas/schemas:4260"; 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-02-preview-only", "details":"Schema 'NetworkSecurityPerimeter' has a property 'location' 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-02-preview", "details":"Schema 'NetworkSecurityPerimeter' has a property 'location' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from NetworkSecurityPerimeter" |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
"readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Error: 2 errors occured -- cannot continue." |
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "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-02-preview-only", "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-02-preview-only", "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-02-preview-only", "details":"Schema 'NspProfile' 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 NspProfile" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "details":"Schema 'NspProfile' 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 NspProfile" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "details":"Schema 'NspProfile' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from NspProfile" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "details":"Schema 'NspAccessRule' 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 NspAccessRule" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "details":"Schema 'NspAccessRule' 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 NspAccessRule" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "details":"Schema 'NspAccessRule' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from NspAccessRule" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "details":"Schema 'NspAssociation' 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 NspAssociation" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "details":"Schema 'NspAssociation' 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 NspAssociation" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "details":"Schema 'NspAssociation' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from NspAssociation" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "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-02-preview-only", "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-02-preview-only", "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" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview-only", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-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-02-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-02-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-02-preview", "details":"Schema 'NspProfile' 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 NspProfile" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Schema 'NspProfile' 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 NspProfile" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Schema 'NspProfile' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from NspProfile" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Schema 'NspAccessRule' 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 NspAccessRule" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Schema 'NspAccessRule' 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 NspAccessRule" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Schema 'NspAccessRule' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from NspAccessRule" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Schema 'NspAssociation' 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 NspAssociation" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Schema 'NspAssociation' 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 NspAssociation" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-preview", "details":"Schema 'NspAssociation' has a property 'type' that is already declared the parent schema 'Resource' but isn't significantly different. The property has been removed from NspAssociation" |
|
| "readme":"network/resource-manager/readme.md", "tag":"package-2021-02-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" |
️️✔️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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
|
Hi @kaushal087, 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. |
This was referenced Jun 17, 2022
Closed
@kaushal087 , can you follow above action to get breaking change review approval? |
|
@kaushal087 , is this PR still valid? If I haven't got any response from you in a week, then I will close this PR. |
…into remove_private_apis
Generated ApiView
|
@raych1 thanks for your comment. Yes, this is still valid. I will get the breaking change review done. |
added 2 commits
August 22, 2022 14:58
…into remove_private_apis
|
Hi @kaushal087, Your PR has some issues. Please fix the CI sequentially by following the order of
|
openapi-pipeline-app
bot
added
resource-manager
NewApiVersionRequired
and removed
resource-manager
labels
|
NewApiVersionRequired reason: |
|
Closing this PR as the changes were included in this PR: #20167 |
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.
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 appy 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.
-[ ] 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.