-
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
Review request for Microsoft.ContainerService to add version 2022-10-02-preview #21439
Review request for Microsoft.ContainerService to add version 2022-10-02-preview #21439
Conversation
…w/2022-09-02-preview to version 2022-10-02-preview
* missed working comment * matthew comments * unpatched is a word
…21337) * Add MaintenanceWindow into MaintenanceConfigurationProperties * Fx PrettierCheck
… container service (Azure#21373) * fix API version * fix INVALID_FORMAT byte * fix INVALID_FORMAT arm-id * fix missing resource id * fix LRO_RESPONSE_HEADER
…vice (Azure#21366) * update readmes * remove fleets
* Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header Co-authored-by: InduSridhar <[email protected]>
Hi, @FumingZhang 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] |
Hi, @FumingZhang your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
Swagger Generation Artifacts
|
Generated ApiView
|
Hey @rkmanda, in the latest commit #c4bb044d, the response body in 202 has been removed. And it has also been declared that the operation result of this LRO post should be obtained via the url provided in the location header ( So for such an LRO post (no response if succeeds), is it still necessary to declare the schema in 200? |
It should not be. We have other APIs following this pattern such as |
* Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header * Fixing location url in abort examples * Fixing headers and body for abort response * Linter fix * Lint fix * Updating managedclusters.json responses * Minor edit to node os upgrade description based on ARM review Co-authored-by: InduSridhar <[email protected]>
Does that operation have a response body to deserialize? In reply to: 1325475470 In reply to: 1325475470 |
Neither |
In that case, I think they don't really need a schema definition. But it might be more idiomatic for them to return 204 NoContent to indicate success when they have no content. In reply to: 1325578279 |
@TimLovellSmith - the PR was already updated to include that. See
The same is true for the other new abort operation: |
...osoft.ContainerService/preview/2022-10-02-preview/examples/ManagedClustersAssociate_CRG.json
Show resolved
Hide resolved
consider quoting Refers to: specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-10-02-preview/managedClusters.json:924 in e998cd7. [](commit_id = e998cd7, deletion_comment = False) |
consider not capitalizing 'agent pool', I think that would be more in keeping with corporate style guide Refers to: specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-10-02-preview/managedClusters.json:924 in e998cd7. [](commit_id = e998cd7, deletion_comment = False) |
Consider this unactionable for now In reply to: 1320351342 Refers to: specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-10-02-preview/managedClusters.json:4416 in c4bb044. [](commit_id = c4bb044, deletion_comment = False) |
Consider quoting this Refers to: specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-10-02-preview/managedClusters.json:5459 in e998cd7. [](commit_id = e998cd7, deletion_comment = False) |
separately? Refers to: specification/containerservice/resource-manager/Microsoft.ContainerService/preview/2022-10-02-preview/managedClusters.json:5459 in e998cd7. [](commit_id = e998cd7, deletion_comment = False) |
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.
…02-preview (Azure#21439) * Adds base for updating Microsoft.ContainerService from version preview/2022-09-02-preview to version 2022-10-02-preview * Updates readme * Updates API version in new specs and examples * Pmiller/nodeosupgradechannel (Azure#21326) * missed working comment * matthew comments * unpatched is a word * Add MaintenanceWindow into MaintenanceConfigurationProperties (Azure#21337) * Add MaintenanceWindow into MaintenanceConfigurationProperties * Fx PrettierCheck * Fix ARM ID format for samples (Azure#21402) * Fix Swagger Model Validation for the 2022-10-02-preview dev branch of container service (Azure#21373) * fix API version * fix INVALID_FORMAT byte * fix INVALID_FORMAT arm-id * fix missing resource id * fix LRO_RESPONSE_HEADER * Update readmes for the 2022-10-02-preview dev branch of container service (Azure#21366) * update readmes * remove fleets * Updating abort apis response to make it long running (Azure#21362) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header Co-authored-by: InduSridhar <[email protected]> * fix 202 location header * fix ProvisioningState validation * add x-ms-long-running-operation-options * fix ResourceNameRestriction * Fix abort location url in example (Azure#21446) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header * Fixing location url in abort examples Co-authored-by: InduSridhar <[email protected]> * Abort api response fix (Azure#21559) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header * Fixing location url in abort examples * Fixing headers and body for abort response * Linter fix * Lint fix * Updating managedclusters.json responses Co-authored-by: InduSridhar <[email protected]> * Node os upgrade desc fix (Azure#21636) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header * Fixing location url in abort examples * Fixing headers and body for abort response * Linter fix * Lint fix * Updating managedclusters.json responses * Minor edit to node os upgrade description based on ARM review Co-authored-by: InduSridhar <[email protected]> Co-authored-by: Paul Miller <[email protected]> Co-authored-by: Thalia Wang <[email protected]> Co-authored-by: Matthew Christopher <[email protected]> Co-authored-by: InduSridhar <[email protected]> Co-authored-by: InduSridhar <[email protected]>
…02-preview (Azure#21439) * Adds base for updating Microsoft.ContainerService from version preview/2022-09-02-preview to version 2022-10-02-preview * Updates readme * Updates API version in new specs and examples * Pmiller/nodeosupgradechannel (Azure#21326) * missed working comment * matthew comments * unpatched is a word * Add MaintenanceWindow into MaintenanceConfigurationProperties (Azure#21337) * Add MaintenanceWindow into MaintenanceConfigurationProperties * Fx PrettierCheck * Fix ARM ID format for samples (Azure#21402) * Fix Swagger Model Validation for the 2022-10-02-preview dev branch of container service (Azure#21373) * fix API version * fix INVALID_FORMAT byte * fix INVALID_FORMAT arm-id * fix missing resource id * fix LRO_RESPONSE_HEADER * Update readmes for the 2022-10-02-preview dev branch of container service (Azure#21366) * update readmes * remove fleets * Updating abort apis response to make it long running (Azure#21362) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header Co-authored-by: InduSridhar <[email protected]> * fix 202 location header * fix ProvisioningState validation * add x-ms-long-running-operation-options * fix ResourceNameRestriction * Fix abort location url in example (Azure#21446) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header * Fixing location url in abort examples Co-authored-by: InduSridhar <[email protected]> * Abort api response fix (Azure#21559) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header * Fixing location url in abort examples * Fixing headers and body for abort response * Linter fix * Lint fix * Updating managedclusters.json responses Co-authored-by: InduSridhar <[email protected]> * Node os upgrade desc fix (Azure#21636) * Updating response abort abort apis * Updating abort AP and MC examples * Changes per CI checks * Adding x-ms-long-running-operation-options * Adding location header * Fixing location url in abort examples * Fixing headers and body for abort response * Linter fix * Lint fix * Updating managedclusters.json responses * Minor edit to node os upgrade description based on ARM review Co-authored-by: InduSridhar <[email protected]> Co-authored-by: Paul Miller <[email protected]> Co-authored-by: Thalia Wang <[email protected]> Co-authored-by: Matthew Christopher <[email protected]> Co-authored-by: InduSridhar <[email protected]> Co-authored-by: InduSridhar <[email protected]>
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:
Already deployed to all global regions by 11/06.
As soon as possible, 11/08.
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.