[Web PubSub] Add web pubsub stable version 2021-10-01 #16045
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi, @zackliu 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 |
|
[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. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.SignalRService/stable/2021-10-01/webpubsub.json#L2306 |
|
| Based on the response model schema, operation 'WebPubSub_ListSkus' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.SignalRService/stable/2021-10-01/webpubsub.json#L1238 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| The resource 'PrivateLinkResource' does not have get operation, please add it. Location: Microsoft.SignalRService/stable/2021-10-01/webpubsub.json#L1718 |
️️✔️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: 2 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.9.0)
- current:stable/2021-10-01/webpubsub.json compared with base:preview/2021-09-01-preview/webpubsub.json
| Rule | Message |
|---|---|
|
The new version is missing a definition that was found in the old version. Was 'EventHandlerSettings' removed or renamed? New: Microsoft.SignalRService/stable/2021-10-01/webpubsub.json#L1280:3 Old: Microsoft.SignalRService/preview/2021-09-01-preview/webpubsub.json#L1072:3 |
|
The new version is missing a property found in the old version. Was 'eventHandler' renamed or removed? New: Microsoft.SignalRService/stable/2021-10-01/webpubsub.json#L2415:7 Old: Microsoft.SignalRService/preview/2021-09-01-preview/webpubsub.json#L2125:7 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
️️✔️[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
|
This was referenced Sep 15, 2021
This was referenced Sep 15, 2021
JeffreyRichter
added
the
Approved-BreakingChange
|
Hi, @zackliu your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
approve for python breaking change. |
j5lim
reviewed
Sep 17, 2021
...resource-manager/Microsoft.SignalRService/stable/2021-10-01/examples/WebPubSubHubs_List.json
Outdated
Show resolved
Hide resolved
j5lim
reviewed
Sep 17, 2021
...resource-manager/Microsoft.SignalRService/stable/2021-10-01/examples/WebPubSubHubs_List.json
Show resolved
Hide resolved
j5lim
reviewed
Sep 17, 2021
| } | ||
| } | ||
| } | ||
| ] |
There was a problem hiding this comment.
Nested resource must be created by its own PUT.
There was a problem hiding this comment.
The eventHandler in a WebPubSubHub has order. Re-order or replace all the eventhandlers in the webpubsubhub will be easier in such design. I think it's not an implicitly creation. And we'd like to work as keyvault and accesspolicy. KeyVault also show the content of accesspolicy and can update accesspolicy in parent resource's operation. How can we also achieve that?
There was a problem hiding this comment.
Then you should model event handlers as a property of webpubsubhub only not as a child resource. You can't have both.
The keyvault case is okay since access policies are a property of keyvault. (its PUT api does not comply to the RPC though).
There was a problem hiding this comment.
So, if event handler is just a property, can we have an api to update one event handler's properties only. I mean does ARM have such an api guidance to achieve this? Why access policy is just a property but not a sub-resource?
There was a problem hiding this comment.
PATCH is for partial update and it can update one event handler only.
https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md#patch-resource
https://armwiki.azurewebsites.net/api_contracts/guidelines/rpc.html#rpc009-use-put-for-update-of-entire-resource-ie-replace-use-patch-only-for-partial-update-of-resource
You can't model a property of the parent resource as a child resource. They have different RBAC and you need to update the parent if a child resources are updated /deleted or vice versa.
There was a problem hiding this comment.
After discussion, we decided not to introduce another subresource for event handler. We treat it as property only
j5lim
reviewed
Sep 17, 2021
...manager/Microsoft.SignalRService/stable/2021-10-01/examples/WebPubSubEventHandlers_List.json
Outdated
Show resolved
Hide resolved
j5lim
reviewed
Sep 17, 2021
...crosoft.SignalRService/stable/2021-10-01/examples/WebPubSubEventHandlers_CreateOrUpdate.json
Outdated
Show resolved
Hide resolved
j5lim
reviewed
Sep 17, 2021
...ication/webpubsub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/webpubsub.json
Outdated
Show resolved
Hide resolved
j5lim
reviewed
Sep 17, 2021
...ication/webpubsub/resource-manager/Microsoft.SignalRService/stable/2021-10-01/webpubsub.json
Outdated
Show resolved
Hide resolved
|
@zackliu Next time please follow the instruction for Adding a new API version This allows the reviewer to just compare two commits to see all new changes introduced by the new API version. It will make the review process more efficient. |
j5lim
added
the
ARMChangesRequested
j5lim
added
ARMSignedOff
ruowan
approved these changes
Sep 26, 2021
This was referenced Sep 26, 2021
Hardell
pushed a commit
to Hardell/azure-rest-api-specs
that referenced
this pull request
Sep 27, 2021
* Add web pubsub stable version 2021-10-01 * Fix structure * Update swagger
LeiWang3
pushed a commit
to LeiWang3/azure-rest-api-specs
that referenced
this pull request
Mar 31, 2022
* Add web pubsub stable version 2021-10-01 * Fix structure * Update swagger
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for 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
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 label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] 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.
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 any of the following scenarios apply to the PR, request approval from the 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.