Added UMC operations#23320
Added UMC operations#23320dorothyhu merged 2 commits intodorothyhu-hybridcompute-Microsoft.HybridCompute-2022-12-27from
Conversation
Added UMC operations
|
Hi, @assing 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(9dc6c8c) | 2022-11-10(main) |
| HybridCompute.json | 2022-12-27(9dc6c8c) | 2022-12-27-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
️⚠️LintDiff: 3 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-12 | package-2022-12(9dc6c8c) | package-2022-12(dorothyhu-hybridcompute-Microsoft.HybridCompute-2022-12-27) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| 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/stable/2022-12-27/HybridCompute.json#L2021 |
||
| 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/stable/2022-12-27/HybridCompute.json#L2226 |
||
| 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/stable/2022-12-27/HybridCompute.json#L2315 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
ResourceNameRestriction |
The resource name parameter 'extensionName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L475 |
CreateOperationAsyncResponseValidation |
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L476 |
LongRunningResponseStatusCode |
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/stable/2022-12-27/HybridCompute.json#L476 |
CreateOperationAsyncResponseValidation |
An async PUT operation must return 201. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L519 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L526 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L526 |
DeleteOperationAsyncResponseValidation |
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L625 |
PostOperationAsyncResponseValidation |
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L813 |
BodyTopLevelProperties |
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/stable/2022-12-27/HybridCompute.json#L1632 |
ArmResourcePropertiesBag |
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/stable/2022-12-27/HybridCompute.json#L1711 |
| 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/stable/2022-12-27/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/stable/2022-12-27/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/stable/2022-12-27/HybridCompute.json#L465 |
|
| 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/stable/2022-12-27/HybridCompute.json#L476 |
|
| The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L476 |
|
| The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L543 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create or Update a Machine Extension Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L618 |
|
| The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L625 |
|
| The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L813 |
|
| Based on the response model schema, operation 'NetworkProfile_Get' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json#L1047 |
|
| 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/stable/2022-12-27/HybridCompute.json#L1051 |
|
| 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/stable/2022-12-27/HybridCompute.json#L1181 |
|
| 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/stable/2022-12-27/HybridCompute.json#L1382 |
|
| 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/stable/2022-12-27/HybridCompute.json#L1762 |
|
| 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/stable/2022-12-27/HybridCompute.json#L1766 |
|
| 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/stable/2022-12-27/HybridCompute.json#L1811 |
|
| 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/stable/2022-12-27/HybridCompute.json#L1815 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 4 Errors, 0 Warnings failed [Detail]
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌PrettierCheck: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
HowToFix |
Code style issues found path: stable/2022-12-27/examples/MachineAssessPatches.json |
HowToFix |
Code style issues found path: stable/2022-12-27/examples/MachineInstallPatches.json |
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️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
|
|
Hi @assing 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. |
|
Hi @assing, 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. |
|
Hi @assing, Your PR has some issues. Please fix the CI sequentially by following the order of
|
.../hybridcompute/resource-manager/Microsoft.HybridCompute/stable/2022-12-27/HybridCompute.json
Outdated
Show resolved
Hide resolved
400dec1
into
dorothyhu-hybridcompute-Microsoft.HybridCompute-2022-12-27
…sion stable/2022-12-27 (#23282) * Adds base for updating Microsoft.HybridCompute from version preview/2022-12-27-preview to version 2022-12-27 * Updates readme * Updates API version in new specs and examples * Added UMC operations (#23320) * Added UMC operations Added UMC operations * Fixed CR comments * fixed model validation error --------- Co-authored-by: assing <43956166+assing@users.noreply.github.com>
…sion stable/2022-12-27 (Azure#23282) * Adds base for updating Microsoft.HybridCompute from version preview/2022-12-27-preview to version 2022-12-27 * Updates readme * Updates API version in new specs and examples * Added UMC operations (Azure#23320) * Added UMC operations Added UMC operations * Fixed CR comments * fixed model validation error --------- Co-authored-by: assing <43956166+assing@users.noreply.github.com>
No description provided.