Merge branch Dev release network 2022 06 01 preview into main branch#23228
Merge branch Dev release network 2022 06 01 preview into main branch#23228
Conversation
…-01-preview to version 2022-06-01-preview
…21970) * New networkManagerGroupMembership API * fix typo * New List NetworkGroupMembership API * fix * fix format * fix error * fix * fix as comments * fix
|
Hi, @yanfa317 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.10.4)] | new version | base version |
|---|---|---|
| network.json | 2022-06-01-preview(7a96ae8) | 2022-05-01(main) |
| network.json | 2022-06-01-preview(7a96ae8) | 2022-04-01-preview(main) |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-06-preview | package-2022-06-preview(7a96ae8) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Based on the response model schema, operation 'ListNetworkGroupMemberships' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.Network/preview/2022-06-01-preview/networkManagerGroupMembership.json#L58 |
The following errors/warnings exist before current PR submission:
| 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/2022-06-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/2022-06-01-preview/network.json#L55 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Network/preview/2022-06-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/2022-06-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/2022-06-01-preview/network.json#L93 |
XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.Network/preview/2022-06-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/2022-06-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/2022-06-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/2022-06-01-preview/network.json#L198 |
MissingTypeObject |
The schema 'TagsObject' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/preview/2022-06-01-preview/network.json#L208 |
MissingTypeObject |
The schema 'ManagedServiceIdentity' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/preview/2022-06-01-preview/network.json#L273 |
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/2022-06-01-preview/network.json#L301 |
ProvisioningStateValidation |
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.Network/preview/2022-06-01-preview/network.json#L321 |
MissingTypeObject |
The schema 'ExtendedLocation' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.Network/preview/2022-06-01-preview/network.json#L395 |
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/2022-06-01-preview/network.json#L410 |
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/2022-06-01-preview/network.json#L417 |
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/2022-06-01-preview/network.json#L424 |
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: Microsoft.Network/preview/2022-06-01-preview/network.json#L156 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️CadlAPIView 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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi, @yanfa317 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
|
Hi, @yanfa317, 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 @yanfa317, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval. |
|
The Only change PR in the branch has been signed off by ARM #21970 |
|
Waiting for @MikhailTryakhov approval. |
MikhailTryakhov
left a comment
There was a problem hiding this comment.
approving preview version merge to the main directly
…zure#23228) * Adds base for updating Microsoft.Network from version preview/2022-04-01-preview to version 2022-06-01-preview * Updates readme * Updates API version in new specs and examples * Add New ListNetworkGroupMembership API to network 2022 06 01 preview (Azure#21970) * New networkManagerGroupMembership API * fix typo * New List NetworkGroupMembership API * fix * fix format * fix error * fix * fix as comments * fix
ARM API Information (Control Plane)
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:
Contribution checklist (MS Employees Only):
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 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 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.