-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Dev hybridcompute microsoft.hybrid compute 2022 12 27 preview #22009
Dev hybridcompute microsoft.hybrid compute 2022 12 27 preview #22009
Conversation
…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.2)] | new version | base version |
---|---|---|
HybridCompute.json | 2022-12-27-preview(9d08728) | 2022-11-10(main) |
HybridCompute.json | 2022-12-27-preview(9d08728) | 2022-08-11-preview(main) |
privateLinkScopes.json | 2022-12-27-preview(9d08728) | 2022-11-10(main) |
privateLinkScopes.json | 2022-12-27-preview(9d08728) | 2022-08-11-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 5 Errors, 0 Warnings failed [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-preview-2022-12 | package-preview-2022-12(9d08728) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L440 |
RPC-Async-V1-07 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L492 |
RPC-Async-V1-07 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L658 |
RPC-Async-V1-07 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L137 |
RPC-Async-V1-07 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L524 |
RPC-Async-V1-07 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ResourceNameRestriction |
The resource name parameter 'machineName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L37 |
ResourceNameRestriction |
The resource name parameter 'machineName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L328 |
ResourceNameRestriction |
The resource name parameter 'extensionName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L328 |
CreateOperationAsyncResponseValidation |
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#L329 |
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/preview/2022-12-27-preview/HybridCompute.json#L329 |
CreateOperationAsyncResponseValidation |
An async PUT operation must return 201. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L369 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L376 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L376 |
DeleteOperationAsyncResponseValidation |
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#L457 |
ResourceNameRestriction |
The resource name parameter 'machineName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L564 |
ResourceNameRestriction |
The resource name parameter 'machineName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/HybridCompute.json#L620 |
PostOperationAsyncResponseValidation |
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#L621 |
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/preview/2022-12-27-preview/HybridCompute.json#L1316 |
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/preview/2022-12-27-preview/HybridCompute.json#L1395 |
ResourceNameRestriction |
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L115 |
DeleteOperationAsyncResponseValidation |
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 |
LongRunningResponseStatusCode |
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 |
ResourceNameRestriction |
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L296 |
ResourceNameRestriction |
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L341 |
ResourceNameRestriction |
The resource name parameter 'groupName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L341 |
ResourceNameRestriction |
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L386 |
ResourceNameRestriction |
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L386 |
CreateOperationAsyncResponseValidation |
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#L434 |
CreateOperationAsyncResponseValidation |
An async PUT operation must return 201. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L469 |
CreateOperationAsyncResponseValidation |
Only 201 is the supported response code for PUT async response. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L476 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L476 |
DeleteOperationAsyncResponseValidation |
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#L493 |
ResourceNameRestriction |
The resource name parameter 'scopeName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L545 |
PathForNestedResource |
The path for nested resource doest not meet the valid resource pattern. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L629 |
ResourceNameRestriction |
The resource name parameter 'machineName' should be defined with a 'pattern' restriction. Location: Microsoft.HybridCompute/preview/2022-12-27-preview/privateLinkScopes.json#L629 |
️❌
Avocado: 5 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
MISSING_APIS_IN_DEFAULT_TAG |
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 |
MISSING_APIS_IN_DEFAULT_TAG |
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 |
MISSING_APIS_IN_DEFAULT_TAG |
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 |
MISSING_APIS_IN_DEFAULT_TAG |
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 |
MISSING_APIS_IN_DEFAULT_TAG |
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 |
---|---|
API Readiness check failed. Please make sure your service is deployed. |
"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]
️❌
ModelValidation: 10 Errors, 0 Warnings failed [Detail]
️️✔️
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 @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. |
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 |
Hi @shubhammalhotra28, 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. |
NEW PR OPENED, AND ADDING COMMITS TO IT. |
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.