Dev hybridcompute microsoft.hybrid compute 2022 12 27 preview #22034
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
…022-08-11-preview to version 2022-12-27-preview
|
Hi, @shubhammalhotra28 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 |
|---|---|---|
| HybridCompute.json | 2022-12-27-preview(bbc20c3) | 2022-11-10(main) |
| HybridCompute.json | 2022-12-27-preview(bbc20c3) | 2022-08-11-preview(main) |
| privateLinkScopes.json | 2022-12-27-preview(bbc20c3) | 2022-11-10(main) |
| privateLinkScopes.json | 2022-12-27-preview(bbc20c3) | 2022-08-11-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 3 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-12 | package-preview-2022-12(bbc20c3) | 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 'NetworkProfile_Get' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L912 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'NetworkProfileModel'. Consider using the plural form of 'NetworkProfile' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L916 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L1247 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The resource name parameter 'extensionName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L340 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L341 |
|
A 'put' operation 'MachineExtensions_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L341 |
|
An async PUT operation must return 201. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L384 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L391 |
|
A 202 response should include an Location response header. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L391 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L490 |
|
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L678 |
|
Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'Machine' has extra properties ['resources']. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L1497 |
|
Top level property names should not be repeated inside the properties bag for ARM resource 'MachineExtension'. Properties [properties.type] conflict with ARM top level properties. Please rename these. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L1576 |
|
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L115 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L116 |
|
A 'delete' operation 'PrivateLinkScopes_Delete' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 204. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L116 |
|
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L311 |
|
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L356 |
|
The resource name parameter 'groupName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L356 |
|
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L401 |
|
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L401 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L449 |
|
An async PUT operation must return 201. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L484 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L491 |
|
A 202 response should include an Location response header. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L491 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L508 |
|
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L575 |
|
The path for nested resource doest not meet the valid resource pattern. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L659 |
|
The resource name parameter 'machineName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L659 |
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Machines_CreateOrUpdate' Request Model: 'parameters[4].schema' Response Model: 'responses[200].schema' Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L38 |
|
| Based on the response model schema, operation 'Machines_Get' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L197 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List Machines by resource group Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L330 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'MachineExtensions_CreateOrUpdate' Request Model: 'parameters[3].schema' Response Model: 'responses[200].schema' Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L341 |
️❌Avocado: 5 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.HybridCompute/machines/{}/reconnect is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/hybridcompute/resource-manager/readme.md json: Microsoft.HybridCompute/preview/2019-08-02/HybridCompute.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.HybridCompute/machines/{}/assessPatches is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/hybridcompute/resource-manager/readme.md json: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.HybridCompute/machines/{}/installPatches is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/hybridcompute/resource-manager/readme.md json: Microsoft.HybridCompute/preview/2020-08-15-preview/HybridCompute.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.HybridCompute/privateLinkScopes/{}/scopedResources/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/hybridcompute/resource-manager/readme.md json: Microsoft.HybridCompute/preview/2020-08-15-preview/privateLinkScopes.json |
|
The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.HybridCompute/privateLinkScopes/{}/scopedResources is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/hybridcompute/resource-manager/readme.md json: Microsoft.HybridCompute/preview/2020-08-15-preview/privateLinkScopes.json |
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.HybridCompute' for api version '2022-12-27-preview'. The supported api-versions are '2019-03-18-preview, 2019-08-02-preview, 2019-12-12, 2020-03-11-preview, 2020-07-30-preview, 2020-08-02, 2020-08-15-preview, 2021-01-28-preview, 2021-03-25-preview, 2021-04-22-preview, 2021-05-20, 2021-05-17-preview, 2021-06-10-preview, 2021-12-10-preview, 2022-03-10, 2022-05-10-preview, 2022-08-11-preview, 2022-11-10'." |
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️~[Staging] 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
|
ghost
added
the
Generated ApiView
|
|
Hi @shubhammalhotra28 and @arcboard, one or more change(s) have been detected in your Arc enabled VM's or Arc enabled Server's RPs. Please review the changes and ensure that no gaps have been introduced with respect to the ARM API modeling consistency across Azure Arc and Azure Compute. For further details, see guidelines at Consistency in ARM Modeling. To approve the change(s), set the label to ArcSignedOff. If you have any questions, please mail to arcboard@microsoft.com. |
This was referenced Jan 3, 2023
PakDLiu
suggested changes
Jan 3, 2023
...mpute/resource-manager/Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json
Outdated
Show resolved
Hide resolved
|
Hi, @shubhammalhotra28, 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 |
11 tasks
AzureRestAPISpecReview
added
ARMReview
CI-FixRequiredOnFailure
WaitForARMFeedback
raosuhas
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
Signed off from ARM side with minor comment |
jianyunt
approved these changes
Jan 25, 2023
|
@shubhammalhotra28 Please fix the Avocado errors, details can be found via #22034 (comment) |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
@tadelesh Could you help to review the breaking change of go? Thanks! |
|
@qiaozha Could you help to review the breaking change of JS? Thanks! |
tadelesh
added
the
Approved-SdkBreakingChange-Go
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
live1206
added
the
Approved-OkToMerge
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
This was referenced Jan 31, 2023
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)
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.