-
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
Add Microsoft.Communication resource manager version 2020-08-20 #13024
Add Microsoft.Communication resource manager version 2020-08-20 #13024
Conversation
Hi, @memontic-ms 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 |
---|---|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: common-types/resource-management/v2/types.json#L348 |
|
'systemData' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.Communication/stable/2020-08-20/CommunicationService.json#L801 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️
[Staging] Cross Version BreakingChange (Base on preview version): 42 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- Compared Swaggers (Based on Oad v0.8.6)
️️✔️
[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
[Staging] SDK Track2 Validation: 7 Warnings warning [Detail]
- The following tags are being changed in this PR
Rule | Message |
---|---|
"readme":"communication/resource-manager/readme.md", "tag":"package-2020-08-20", "details":"The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"communication/resource-manager/readme.md", "tag":"package-2020-08-20", "details":"The schema 'ErrorDetail' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"communication/resource-manager/readme.md", "tag":"package-2020-08-20", "details":"The schema 'ErrorResponse' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"communication/resource-manager/readme.md", "tag":"package-2020-08-20", "details":"The schema 'ErrorAdditionalInfo' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"communication/resource-manager/readme.md", "tag":"package-2020-08-20", "details":"The schema 'Operation-display' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"communication/resource-manager/readme.md", "tag":"package-2020-08-20", "details":"The schema 'OperationListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
"readme":"communication/resource-manager/readme.md", "tag":"package-2020-08-20", "details":"Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail." |
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
Hi, @memontic-ms your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @ |
Hi @memontic-ms, Your PR has some issues. Please fix the CI sequentially by following the order of
|
f8a8bdd
to
cb62270
Compare
"description": "Parameters for the update operation", | ||
"required": false, | ||
"schema": { | ||
"$ref": "#/definitions/TaggedResource" |
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.
TaggedResource? Not CommunicationServiceResource?
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'm not sure of the reason for this. Tagging in @bviglietta who might have an answer as to why.
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'm not sure why it's TaggedResource, since it does seem like CommunicationServiceResource would make more sense here. Although CommunicationServiceResource doesn't actually have any mutable fields that you could patch, so it doesn't make a huge difference.
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.
@allenjzhang Is this blocking our signoff? This part hasn't changes since our previous version.
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.
Actually, this is the FIRST stable version, you should review this carefully to avoid breaking change later. The time is really now.
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.
@allenjzhang This has now been updated to use CommunicationServiceResource instead of TaggedResource
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
Hi, @memontic-ms your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @allenjzhang |
- Remove 3 instances of ARM violation R4009 by including systemData field - Change resource update to take a CommunicationServiceResource instead of a TaggedResource - Remove custom definition for OperationList and use the common-types version instead - Validate resource names
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.
Approved from SDK side. Please address ARM feedback and obtain ARMSignedOff. Thanks.
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.
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.
} | ||
}, | ||
"201": { | ||
"description": "Created and an async operation is executing in background to make the new key take effect. The response contains new keys and an Azure-AsyncOperation header to query the async operation result.", |
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": "Created and an async operation is executing in background to make t [](start = 11, length = 84)
Is this async? Then please follow the rpc guideline. https://github.com/Azure/azure-resource-manager-rpc/blob/f39512268c61b0a970766515d535a756495bb56d/v1.0/Addendum.md#call-action-post-asynchronously
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.
RegenerateKey is not async, will remove the 201 from responses
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.
.
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.
Approved from ARM side.
…e#13024) * Add Microsoft.Communication resource manager version 2020-08-20 * Fix mistyped API version from 2020-80-20 to 2020-08-20 * Fix linter errors and bring in more GA changes - Remove 3 instances of ARM violation R4009 by including systemData field - Change resource update to take a CommunicationServiceResource instead of a TaggedResource - Remove custom definition for OperationList and use the common-types version instead - Validate resource names
…e#13024) * Add Microsoft.Communication resource manager version 2020-08-20 * Fix mistyped API version from 2020-80-20 to 2020-08-20 * Fix linter errors and bring in more GA changes - Remove 3 instances of ARM violation R4009 by including systemData field - Change resource update to take a CommunicationServiceResource instead of a TaggedResource - Remove custom definition for OperationList and use the common-types version instead - Validate resource names
Bringing over the swagger and README changes for GA.
Stable version 2020-08-20.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Now
As soon as possible before March
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 Breaking Change 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.