-
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
[Hub Generated] Review request for Microsoft.HybridCompute to add version preview/2021-05-17-preview #14481
[Hub Generated] Review request for Microsoft.HybridCompute to add version preview/2021-05-17-preview #14481
Conversation
…021-04-22-preview to version 2021-05-17-preview
Hi, @dkirby017 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. vsswagger@microsoft.com |
Swagger Validation Report
|
Rule | Message |
---|---|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridCompute/preview/2021-05-17-preview/privateLinkScopes.json#L918 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.HybridCompute/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.HybridCompute/preview/2021-05-17-preview/HybridCompute.json#L673 |
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridCompute/preview/2021-05-17-preview/HybridCompute.json#L926 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridCompute/preview/2021-05-17-preview/HybridCompute.json#L951 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridCompute/preview/2021-05-17-preview/HybridCompute.json#L996 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridCompute/preview/2021-05-17-preview/HybridCompute.json#L1015 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridCompute/preview/2021-05-17-preview/privateLinkScopes.json#L721 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridCompute/preview/2021-05-17-preview/privateLinkScopes.json#L856 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HybridCompute/preview/2021-05-17-preview/privateLinkScopes.json#L985 |
|
Based on the response model schema, operation 'PrivateLinkScopes_GetValidationDetails' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.HybridCompute/preview/2021-05-17-preview/privateLinkScopes.json#L591 |
|
Based on the response model schema, operation 'PrivateLinkScopes_GetValidationDetailsForMachine' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.HybridCompute/preview/2021-05-17-preview/privateLinkScopes.json#L630 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
- Compared Swaggers (Based on Oad v0.8.9)
- current:preview/2021-05-17-preview/HybridCompute.json compared with base:preview/2021-04-22-preview/HybridCompute.json
- current:preview/2021-05-17-preview/privateLinkScopes.json compared with base:preview/2021-04-22-preview/privateLinkScopes.json
- current:preview/2021-05-17-preview/HybridCompute.json compared with base:stable/2021-05-20/HybridCompute.json
- current:preview/2021-05-17-preview/privateLinkScopes.json compared with base:stable/2021-05-20/privateLinkScopes.json
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"hybridcompute/resource-manager/readme.md",
"tag":"package-preview-2021-05",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"hybridcompute/resource-manager/readme.md",
"tag":"package-preview-2021-05",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"hybridcompute/resource-manager/readme.md",
"tag":"package-preview-2021-05",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
/azp run unifiedPipeline |
No pipelines are associated with this pull request. |
Hi, @dkirby017 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @zhenglaizhang |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
@@ -800,6 +800,14 @@ | |||
"readOnly": true, | |||
"description": "The Guid id of the private link scope.", | |||
"type": "string" | |||
}, | |||
"privateEndpointConnections": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see privateEndpointConnections array defined here contains the list of connections and the details. Few questions...
- How many privateEndpointConnections can exist? Would all the connections details fit in a single response? Note that you cannot do paging just for the array content.
- Also you will run into RBAC issues if you return the entire privateEndpointConnection response in privateLinkScope GET. Refer https://armwiki.azurewebsites.net/api_contracts/guidelines/rpc.html#rpc019-rbac-violation-information-leak-when-resources-full-content-of-other-types-are-included-in-the-response
I would recommend to return just an array of privateEndpointConnection IDs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Single digits. Most likely 1, but we wanted to make sure we had support built in for >1
- The privateEndpointConnection data isn't really a different resource type, but just data on a privateLinkScope. it also isn't something that should have different RBAC rules associated with it. This information is needed for policy checks, so we need it to be available here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
adding on to 2., the data we're returning here isn't the underlying private endpoint resource itself either. It's just some information about the private link scope's relationship with that private endpoint, plus the id of the private endpoint. I don't think there should be any information leak issues here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dkirby017 Sounds good then. Signing off by adding 'ARMSignedOff' label.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
…2021-05-17-preview
…sion preview/2021-05-17-preview (Azure#14481) * Adds base for updating Microsoft.HybridCompute from version preview/2021-04-22-preview to version 2021-05-17-preview * Updates readme * Updates API version in new specs and examples * updated 2021-05-17-preview spec
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.