NetworkCloud 2023-05-01-preview APIs #24438
Merged
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, @mbashtovaya 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 |
|---|---|---|
| networkcloud.json | 2023-05-01-preview(c682fe5) | 2022-12-12-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/defaultCniNetworks' removed or restructured? Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L201:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.NetworkCloud/hybridAksClusters' removed or restructured? Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L238:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/defaultCniNetworks' removed or restructured? Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L3162:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/defaultCniNetworks/{defaultCniNetworkName}' removed or restructured? Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L3202:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/hybridAksClusters' removed or restructured? Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L3402:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/hybridAksClusters/{hybridAksClusterName}' removed or restructured? Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L3442:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/hybridAksClusters/{hybridAksClusterName}/restartNode' removed or restructured? Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L3642:5 |
|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/storageAppliances/{storageApplianceName}/validateHardware' removed or restructured? Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L4860:5 |
|
| The new version is missing a definition that was found in the old version. Was 'CniBgpConfiguration' removed or renamed? New: Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json#L6227:3 Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L6253:3 |
|
| The new version is missing a definition that was found in the old version. Was 'DefaultCniNetwork' removed or renamed? New: Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json#L6227:3 Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L6253:3 |
|
| The new version is missing a definition that was found in the old version. Was 'DefaultCniNetworkPatchParameters' removed or renamed? New: Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json#L6227:3 Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L6253:3 |
|
| The new version is missing a definition that was found in the old version. Was 'DefaultCniNetworkProperties' removed or renamed? New: Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json#L6227:3 Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L6253:3 |
|
| The new version is missing a definition that was found in the old version. Was 'HybridAksCluster' removed or renamed? New: Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json#L6227:3 Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L6253:3 |
|
| The new version is missing a definition that was found in the old version. Was 'HybridAksClusterPatchParameters' removed or renamed? New: Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json#L6227:3 Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L6253:3 |
|
| The new version is missing a definition that was found in the old version. Was 'HybridAksClusterProperties' removed or renamed? New: Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json#L6227:3 Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L6253:3 |
|
| The new version is missing a definition that was found in the old version. Was 'HybridAksClusterRestartNodeParameters' removed or renamed? New: Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json#L6227:3 Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L6253:3 |
|
| The new version is missing a definition that was found in the old version. Was 'StorageApplianceValidateHardwareParameters' removed or renamed? New: Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json#L6227:3 Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L6253:3 |
|
| The new version is missing a client parameter that was found in the old version. Was 'BareMetalMachineKeySetName' removed or renamed? New: Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json#L12364:3 Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L11367:3 |
|
| The new version is missing a client parameter that was found in the old version. Was 'BmcKeySetName' removed or renamed? New: Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json#L12364:3 Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L11367:3 |
|
| The new version is missing a client parameter that was found in the old version. Was 'DefaultCniNetworkNameParameter' removed or renamed? New: Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json#L12364:3 Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L11367:3 |
|
| The new version is missing a client parameter that was found in the old version. Was 'HybridAksClusterNameParameter' removed or renamed? New: Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json#L12364:3 Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L11367:3 |
|
| The operation id has been changed from 'BareMetalMachineKeySets_ListByResourceGroup' to 'BareMetalMachineKeySets_ListByCluster'. This will impact generated code. New: Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json#L2204:7 Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L2230:7 |
|
| The operation id has been changed from 'BmcKeySets_ListByResourceGroup' to 'BmcKeySets_ListByCluster'. This will impact generated code. New: Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json#L2475:7 Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L2501:7 |
|
| The operation id has been changed from 'MetricsConfigurations_ListByResourceGroup' to 'MetricsConfigurations_ListByCluster'. This will impact generated code. New: Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json#L2808:7 Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L2833:7 |
|
| The operation id has been changed from 'Consoles_ListByResourceGroup' to 'Consoles_ListByVirtualMachine'. This will impact generated code. New: Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json#L5444:7 Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L5475:7 |
|
| The new version removs a required header 'Location'. Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L840:15 |
|
| The new version removs a required header 'Location'. Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L1706:15 |
|
| The new version removs a required header 'Location'. Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L2202:15 |
|
| The new version removs a required header 'Location'. Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L2476:15 |
|
| The new version removs a required header 'Location'. Old: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json#L2747:15 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
| compared tags (via openapi-validator v2.1.3) | new version | base version |
|---|---|---|
| package-2023-05-01-preview | package-2023-05-01-preview(c682fe5) | default(main) |
️❌Avocado: 8 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.NetworkCloud/defaultCniNetworks is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/networkcloud/resource-manager/readme.md json: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.NetworkCloud/hybridAksClusters is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/networkcloud/resource-manager/readme.md json: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NetworkCloud/defaultCniNetworks is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/networkcloud/resource-manager/readme.md json: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NetworkCloud/defaultCniNetworks/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/networkcloud/resource-manager/readme.md json: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NetworkCloud/hybridAksClusters is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/networkcloud/resource-manager/readme.md json: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NetworkCloud/hybridAksClusters/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/networkcloud/resource-manager/readme.md json: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NetworkCloud/hybridAksClusters/{}/restartNode is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/networkcloud/resource-manager/readme.md json: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.NetworkCloud/storageAppliances/{}/validateHardware is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/networkcloud/resource-manager/readme.md json: Microsoft.NetworkCloud/preview/2022-12-12-preview/networkcloud.json |
️️✔️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 succeeded [Detail] [Expand]
️️✔️CadlAPIView 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).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
ARMReview
CI-FixRequiredOnFailure
CI-MissingBaseCommit
new-api-version
resource-manager
RPaaS
WaitForARMFeedback
|
Hi @mbashtovaya, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi, @mbashtovaya, 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 |
|
This introduces a new public preview version of the NetworkCloud APIs. All the breaking changes have been approved and merged into azure-rest-api-spec-pr repository earlier. |
|
Approve |
For PATCH location is still required, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/async-api-reference.md#updating-using-patch, overall Azure-AsyncOperation is a better contract, but location is needed for some legacy reason Refers to: specification/networkcloud/resource-manager/Microsoft.NetworkCloud/preview/2023-05-01-preview/networkcloud.json:803 in c682fe5. [](commit_id = c682fe5, deletion_comment = False) |
zizw123
added
the
ARMChangesRequested
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
ARM review board approved this change when we did this change in private repository. The Location header is causing issues with the aaz-dev-tool CLI generation. Please see the original approval https://github.com/Azure/azure-rest-api-specs-pr/pull/12893 |
mbashtovaya
removed
the
ARMChangesRequested
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
Synced offline, RPaaS has async operation status defined for all verbs and this pattern has been signed off, signing off the PR |
zizw123
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
Python SDK breakingchange has been approved in https://github.com/Azure/azure-rest-api-specs-pr/pull/12893 |
raych1
added
the
Approved-SdkBreakingChange-Go
v-jiaodi
approved these changes
Jun 19, 2023
v-jiaodi
added
the
Approved-OkToMerge
This was referenced Jun 19, 2023
ghost
pushed a commit
to Azure/azure-resource-manager-schemas
that referenced
this pull request
Jul 10, 2023
harryli0108
pushed a commit
to harryli0108/azure-rest-api-specs
that referenced
this pull request
Jul 28, 2023
* base commit for the next preview version * new preview version 2023-05-01-preview
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.
ARM API Information (Control Plane)
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. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
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.