-
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.StorageCache to add version stable/2021-03-01 #12875
[Hub Generated] Review request for Microsoft.StorageCache to add version stable/2021-03-01 #12875
Conversation
Hi, @brpanask 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. [email protected] |
Swagger Generation Artifacts
|
In the Window Period to fix mismatches between swagger and service, when PR is labelled with “FixS360”, breaking change can be approved by PR assignee; the Azure Breaking Change Board is no longer required to approve the PR. Please ensure to clarify what s360 action items to be solved, and @ mention PR assignee for awareness. Please check this wiki [Window to Fix Broken]( Window to Fix Broken - Overview (azure.com)) for more details. |
/azp run unifiedPipeline |
No pipelines are associated with this pull request. |
Hi, @brpanask your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @ |
Hi, @brpanask your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @markcowl |
There's a customer expecting these feature updates in March, so it would be good if we can have the review approved and ready to merge soon. It doesn't have an ARM reviewer yet and its been open for 14 days. |
@brpanask why is this marked as 'DoNotMerge' if it is an urgent customer ask? S360 items are for fixing reported S360 completeness and correctness issues, not for providing new customer features. |
@markcowl, The new version of the api contains new features and fixes. Let me know if you need more detail or if that's not clear. |
@@ -554,18 +514,66 @@ | |||
"operationId": "Caches_Update" | |||
} | |||
}, | |||
"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/dnsRefresh": { |
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.
nit: POST action names are generally verbs. IMO, name 'refreshDns' is apt here. I will leave the call to you.
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 discussed with others on the team and they requested that I keep it as is, so I did not update it here.
@@ -1461,10 +1387,26 @@ | |||
"type": "string" | |||
}, | |||
"type": "array" | |||
}, | |||
"dnsServers": { | |||
"description": "DNS servers for the cache to use. The default is determined by the network configuration.", |
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.
What does 'default is determined by the network configuration' mean? Say, if user doesn't provide dnsServers values during PUT, would the default values be returned by RP in GET? If so please be aware that PUT & GET mismatch and you will run into issues in What-If testing. The PUT should be as close as possible to GET payload.
Refer https://armwiki.azurewebsites.net/api_contracts/WhatIfNoiseFix.html#put-as-patch-properties and https://armwiki.azurewebsites.net/api_contracts/WhatIfNoise.html
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 tried to reword this but I'm not sure how much else to add or how to phrase it.
With DNS, DHCP or AD or other services on the network can provide the DNS configuration. In Azure I think virtual networks have a variety of options for setting up dns servers on virtual networks which could also provide the configuration. Whatever the network provides will be sent back in a GET and can be supplied in a PUT again or left out of a PUT. Either way would work.
@@ -1795,6 +1743,28 @@ | |||
"statusDescription": { | |||
"description": "Describes explanation of state.", | |||
"type": "string" | |||
}, | |||
"conditions": { |
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.
Is this a readOnly property? If yes, please mark it as readonly.
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.
Updated in latest commit.
"type": "object", | ||
"description": "Outstanding conditions that will need to be resolved.", | ||
"properties": { | ||
"timestamp": { |
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.
Sounds like timestamp and message are readonly properties? If yes, please mark them as readonly.
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.
Updated in latest commit.
"$ref": "#/definitions/URLString" | ||
}, | ||
"usageModel": { | ||
"description": "Identifies the usage model to be used for this Storage Target. Get choices from .../usageModels", |
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.
Description text 'Get choices from .../usageModels' is not intuitive. Recommend to re-word it as these text will be published in docs.
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.
Updated in latest commit.
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.
Also updated an existing description with a similar message.
Thank you for copying the existing version into new folder for first commit. It helps in reviewing the change. Marked as ARMApproved, |
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.
@markcowl |
…ion stable/2021-03-01 (Azure#12875) * Adds base for updating Microsoft.StorageCache from version stable/2020-10-01 to version 2021-03-01 * Updates readme * Updates API version in new specs and examples * Add storagecache 2021-03-01 content * Add blobNfs and fix issues found by autorest. * Updating anonymous UID and GID * Update dns and storage target descriptions and condition readonly status.
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.