Skip to content
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

Add new NSP API versions #26154

Closed
wants to merge 7 commits into from
Closed

Conversation

kaushal087
Copy link
Contributor

@kaushal087 kaushal087 commented Oct 10, 2023

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix swagger quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

Getting help

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 10, 2023

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR is in purview of ARM review (label: ARMReview). Please ensure your PR is on the ARM PR review queue - see instructions in steps 1 and 2 in the PR description diagram.
  • ❌ The required check named Swagger LintDiff has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 10, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 16 Warnings warning [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
network.json 2023-07-01-preview(450c83f) 2023-05-01(main)
network.json 2023-07-01-preview(450c83f) 2022-06-01-preview(main)
networkSecurityPerimeter.json 2023-07-01-preview(450c83f) 2021-03-01-preview(main)
network.json 2023-08-01-preview(450c83f) 2023-05-01(main)
network.json 2023-08-01-preview(450c83f) 2022-06-01-preview(main)
networkSecurityPerimeter.json 2023-08-01-preview(450c83f) 2021-03-01-preview(main)

The following breaking changes are detected by comparison with the latest preview version:

Rule Message
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ProvisioningState' removed or renamed?
New: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1341:3
Old: Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json#L282:3
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ProvisioningState' removed or renamed?
New: Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json#L1341:3
Old: Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json#L282:3
⚠️ 1008 - ModifiedOperationId The operation id has been changed from 'PerimeterAssociableResourceTypes_Get' to 'PerimeterAssociableResourceTypes_List'. This will impact generated code.
New: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L846:7
Old: Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json#L242:7
⚠️ 1008 - ModifiedOperationId The operation id has been changed from 'PerimeterAssociableResourceTypes_Get' to 'PerimeterAssociableResourceTypes_List'. This will impact generated code.
New: Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json#L846:7
Old: Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json#L242:7
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1396:9
Old: Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json#L346:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json#L1396:9
Old: Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json#L346:9
⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
New: Microsoft.Network/preview/2023-07-01-preview/network.json#L171:5
Old: Microsoft.Network/preview/2022-06-01-preview/network.json#L171:5
⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
New: Microsoft.Network/preview/2023-08-01-preview/network.json#L171:5
Old: Microsoft.Network/preview/2022-06-01-preview/network.json#L171:5
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'displayName' renamed or removed?
New: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1395:7
Old: Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json#L337:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'description' renamed or removed?
New: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1395:7
Old: Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json#L337:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'etag' renamed or removed?
New: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1344:7
Old: Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json#L285:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'displayName' renamed or removed?
New: Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json#L1395:7
Old: Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json#L337:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'description' renamed or removed?
New: Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json#L1395:7
Old: Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json#L337:7
⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'etag' renamed or removed?
New: Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json#L1344:7
Old: Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json#L285:7
⚠️ 1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
New: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1396:9
Old: Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json#L346:9
⚠️ 1047 - XmsEnumChanged The new version has a different x-ms-enum 'name' than the previous one.
New: Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json#L1396:9
Old: Microsoft.Network/preview/2021-03-01-preview/networkSecurityPerimeter.json#L346:9
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 20 Errors, 32 Warnings failed [Detail]
compared tags (via openapi-validator v2.1.6) new version base version
package-2023-08-preview package-2023-08-preview(450c83f) default(main)
package-2023-07-preview package-2023-07-preview(450c83f) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Only 30 items are listed, please refer to log for more details.

Rule Message Related RPC [For API reviewers]
FATAL spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json'. Errors encountered: Error: Error running Nimma Error 1: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 2: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 3: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 4: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 5: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 6: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 7: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 8: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 9: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 10: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 11: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 12: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 13: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 14: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 15: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 16: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 17: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 18: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 19: $[paths,'x-ms-paths'] threw: ErrorWithCause('Function 'ParametersInPointGet' threw an exception: Cannot read property 'filter' of undefined')
Location: azure-rest-api-specs/blob/450c83f8d0ed627e66f4ef0257f1f139970c5869/#L1
FATAL spectralPluginFunc: Failed validating: 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/network/resource-manager/Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json'. Errors encountered: Error: Error running Nimma Error 1: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 2: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 3: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 4: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 5: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 6: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 7: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 8: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 9: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 10: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 11: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 12: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 13: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 14: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 15: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 16: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 17: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 18: $[paths,'x-ms-paths']..^ threw: ErrorWithCause('Function 'resourceNameRestriction' threw an exception: Cannot read property 'in' of undefined') Error 19: $[paths,'x-ms-paths'] threw: ErrorWithCause('Function 'ParametersInPointGet' threw an exception: Cannot read property 'filter' of undefined')
Location: azure-rest-api-specs/blob/450c83f8d0ed627e66f4ef0257f1f139970c5869/#L1
OperationsAPIImplementation Operations API must be implemented for 'Microsoft.Network'.
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L1
MissingTypeObject The schema 'ProxyResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L171
RequiredPropertiesMissingInResourceModel Model definition 'NetworkSecurityPerimeter' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1342
RPC-Get-V1-03, RPC-Put-V1-08
RequiredPropertiesMissingInResourceModel Model definition 'NspProfile' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1427
RPC-Get-V1-03, RPC-Put-V1-08
TrackedResourcePatchOperation Tracked resource 'NspProfile' must have patch operation that at least supports the update of tags.
Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1427
RPC-Patch-V1-03
RequiredPropertiesMissingInResourceModel Model definition 'NspAccessRule' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1490
RPC-Get-V1-03, RPC-Put-V1-08
TrackedResourcePatchOperation Tracked resource 'NspAccessRule' must have patch operation that at least supports the update of tags.
Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1490
RPC-Patch-V1-03
RequiredPropertiesMissingInResourceModel Model definition 'NspAssociation' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1632
RPC-Get-V1-03, RPC-Put-V1-08
TrackedResourcePatchOperation Tracked resource 'NspAssociation' must have patch operation that at least supports the update of tags.
Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L1632
RPC-Patch-V1-03
OperationsAPIImplementation Operations API must be implemented for 'Microsoft.Network'.
Location: Microsoft.Network/preview/2023-08-01-preview/network.json#L1
MissingTypeObject The schema 'ProxyResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-08-01-preview/network.json#L171
RequiredPropertiesMissingInResourceModel Model definition 'NetworkSecurityPerimeter' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Location: Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json#L1342
RPC-Get-V1-03, RPC-Put-V1-08
RequiredPropertiesMissingInResourceModel Model definition 'NspProfile' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Location: Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json#L1427
RPC-Get-V1-03, RPC-Put-V1-08
TrackedResourcePatchOperation Tracked resource 'NspProfile' must have patch operation that at least supports the update of tags.
Location: Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json#L1427
RPC-Patch-V1-03
RequiredPropertiesMissingInResourceModel Model definition 'NspAccessRule' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Location: Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json#L1490
RPC-Get-V1-03, RPC-Put-V1-08
TrackedResourcePatchOperation Tracked resource 'NspAccessRule' must have patch operation that at least supports the update of tags.
Location: Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json#L1490
RPC-Patch-V1-03
RequiredPropertiesMissingInResourceModel Model definition 'NspAssociation' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Location: Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json#L1639
RPC-Get-V1-03, RPC-Put-V1-08
TrackedResourcePatchOperation Tracked resource 'NspAssociation' must have patch operation that at least supports the update of tags.
Location: Microsoft.Network/preview/2023-08-01-preview/networkSecurityPerimeter.json#L1639
RPC-Patch-V1-03
⚠️ RequiredReadOnlySystemData The response of operation:'NetworkSecurityPerimeters_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L52
⚠️ RequiredReadOnlySystemData The response of operation:'NetworkSecurityPerimeters_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L78
⚠️ RequiredReadOnlySystemData The response of operation:'NetworkSecurityPerimeters_Patch' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L147
⚠️ RequiredReadOnlySystemData The response of operation:'NspProfiles_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L296
⚠️ RequiredReadOnlySystemData The response of operation:'NspProfiles_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L322
⚠️ RequiredReadOnlySystemData The response of operation:'NspAccessRules_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L464
⚠️ RequiredReadOnlySystemData The response of operation:'NspAccessRules_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L490
⚠️ RequiredReadOnlySystemData The response of operation:'NspAssociations_Get' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L632
⚠️ RequiredReadOnlySystemData The response of operation:'NspAssociations_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L658
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'reconcile' in:'NspAssociationReconcile_Post'. Consider updating the operationId
Location: Microsoft.Network/preview/2023-07-01-preview/networkSecurityPerimeter.json#L811


The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule Message
MissingTypeObject The schema 'ErrorDetails' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L38
MissingTypeObject The schema 'Error' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L55
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L69
MissingTypeObject The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L83
MissingTypeObject The schema 'CloudErrorBody' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L93
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L108
MissingTypeObject The schema 'AzureAsyncOperationResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L118
MissingTypeObject The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L140
MissingTypeObject The schema 'SubResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L197
MissingTypeObject The schema 'TagsObject' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L207
MissingTypeObject The schema 'ManagedServiceIdentity' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L272
AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L300
ProvisioningStateValidation ProvisioningState must have terminal states: Succeeded, Failed and Canceled.
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L320
MissingTypeObject The schema 'ExtendedLocation' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L394
XmsParameterLocation The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L409
XmsParameterLocation The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L416
XmsParameterLocation The parameter 'ApiVersionVmssParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'.
Location: Microsoft.Network/preview/2023-07-01-preview/network.json#L423
MissingTypeObject The schema 'ErrorDetails' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-08-01-preview/network.json#L38
MissingTypeObject The schema 'Error' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-08-01-preview/network.json#L55
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Network/preview/2023-08-01-preview/network.json#L69
MissingTypeObject The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-08-01-preview/network.json#L83
MissingTypeObject The schema 'CloudErrorBody' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-08-01-preview/network.json#L93
XmsIdentifierValidation Missing identifier id in array item property
Location: Microsoft.Network/preview/2023-08-01-preview/network.json#L108
MissingTypeObject The schema 'AzureAsyncOperationResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-08-01-preview/network.json#L118
MissingTypeObject The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-08-01-preview/network.json#L140
MissingTypeObject The schema 'SubResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-08-01-preview/network.json#L197
MissingTypeObject The schema 'TagsObject' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-08-01-preview/network.json#L207
MissingTypeObject The schema 'ManagedServiceIdentity' is considered an object but without a 'type:object', please add the missing 'type:object'.
Location: Microsoft.Network/preview/2023-08-01-preview/network.json#L272
AvoidAnonymousTypes Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models.
Location: Microsoft.Network/preview/2023-08-01-preview/network.json#L300
ProvisioningStateValidation ProvisioningState must have terminal states: Succeeded, Failed and Canceled.
Location: Microsoft.Network/preview/2023-08-01-preview/network.json#L320
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 10, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking



️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 70c482cdeeabd8a420a04b44f9eed8635d752875. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.101 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/network/resource-manager/readme.md
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
  • ️✔️Microsoft.Azure.Management.Network [View full logs]  [Preview SDK Changes]
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 70c482cdeeabd8a420a04b44f9eed8635d752875. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
  • ️✔️Azure.ResourceManager.Network [View full logs]  [Preview SDK Changes]
    info	[Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs] Generate from 70c482cdeeabd8a420a04b44f9eed8635d752875. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] E: Unable to locate package python3.10-venv
    cmderr	[automation_init.sh] E: Couldn't find any package by glob 'python3.10-venv'
    cmderr	[automation_init.sh] E: Couldn't find any package by regex 'python3.10-venv'
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    cmderr	[automation_generate.sh]
    cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.8.1 -> 10.2.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.2.0` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-network [View full logs]  [Preview SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Added operation NetworkSecurityPerimetersOperations.patch
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs] Generate from 70c482cdeeabd8a420a04b44f9eed8635d752875. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 23.2.1
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-network-generated [View full logs]  [Preview SDK Changes]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 70c482cdeeabd8a420a04b44f9eed8635d752875. SDK Automation 14.0.0
    command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️sdk/resourcemanager/network/armnetwork [View full logs]  [Preview SDK Changes]
    info	[Changelog] ### Other Changes
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 70c482cdeeabd8a420a04b44f9eed8635d752875. SDK Automation 14.0.0
    command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
    warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    cmderr	[automation_generate.sh] [ERROR] Cannot generate changelog because the codes of local and npm may be the same.
  • ️✔️@azure/arm-network [View full logs]  [Preview SDK Changes]
    info	[Changelog]
    error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️🔄 azure-resource-manager-schemas inProgress [Detail]
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs] Generate from 70c482cdeeabd8a420a04b44f9eed8635d752875. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    SSL error: syscall failure: Broken pipe
    Error: SSL error: syscall failure: Broken pipe
  • ⚠️Az.network.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.network.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Oct 10, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/network/armnetwork https://apiview.dev/Assemblies/Review/2187d6468ae14cd3a53eabbe516c69f6
Java azure-resourcemanager-network-generated https://apiview.dev/Assemblies/Review/993b4e93feec488ba0513bb30fbe1565
JavaScript @azure/arm-network There is no API change compared with the previous version
.Net Azure.ResourceManager.Network There is no API change compared with the previous version
Swagger Microsoft.Network https://apiview.dev/Assemblies/Review/af9b1d58100342fca4da65e2662f8769

@AzureRestAPISpecReview AzureRestAPISpecReview added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-MissingBaseCommit new-api-version resource-manager labels Oct 10, 2023
@openapi-workflow-bot
Copy link

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

@openapi-workflow-bot
Copy link

Hi @kaushal087! 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.

@AzureRestAPISpecReview AzureRestAPISpecReview added NewApiVersionRequired and removed BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Oct 11, 2023
@kaushal087
Copy link
Contributor Author

@Joanna-Yang-Art The LintDiff check is failing, it's not because of our code. The same error was coming in our previous PR (#24147) and it was approved. Could you please review and approve? Thanks.

@kaushal087 kaushal087 closed this Oct 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview CI-MissingBaseCommit new-api-version resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants