Fix event mapping and add a missing field #13485
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, @vikrampraveen 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 Validation Report
|
| Rule | Message |
|---|---|
| "readme":"eventgrid/data-plane/readme.md", "tag":"package-2018-01", "details":"The schema 'IotHubDeviceCreatedEventData' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventgrid/data-plane/readme.md", "tag":"package-2018-01", "details":"The schema 'IotHubDeviceDeletedEventData' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventgrid/data-plane/readme.md", "tag":"package-2018-01", "details":"The schema 'IotHubDeviceConnectedEventData' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventgrid/data-plane/readme.md", "tag":"package-2018-01", "details":"The schema 'IotHubDeviceDisconnectedEventData' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventgrid/data-plane/readme.md", "tag":"package-2018-01", "details":"The schema 'IotHubDeviceTelemetryEventData' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventgrid/data-plane/readme.md", "tag":"package-2018-01", "details":"The schema 'ContainerRegistryImagePushedEventData' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventgrid/data-plane/readme.md", "tag":"package-2018-01", "details":"The schema 'ContainerRegistryImageDeletedEventData' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventgrid/data-plane/readme.md", "tag":"package-2018-01", "details":"The schema 'ContainerRegistryChartPushedEventData' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventgrid/data-plane/readme.md", "tag":"package-2018-01", "details":"The schema 'ContainerRegistryChartDeletedEventData' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"eventgrid/data-plane/readme.md", "tag":"package-2018-01", "details":"The schema 'ContainerRegistryEventData' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
Kishp01
approved these changes
Mar 17, 2021
lmazuel
approved these changes
Mar 18, 2021
This was referenced Mar 18, 2021
ellismg
added a commit
to ellismg/azure-sdk-for-js
that referenced
this pull request
Mar 22, 2021
The Azure Communication Services team noticed that some of their event shapes were wrong and have [updated the swagger](Azure/azure-rest-api-specs#13485) to address this. This commit pulls these changes into our SDK. Fixes Azure#14345
MirzaSikander
pushed a commit
to MirzaSikander/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2021
Co-authored-by: Vikram Praveen Kumar <[email protected]>
ellismg
added a commit
to Azure/azure-sdk-for-js
that referenced
this pull request
Mar 23, 2021
* [EventGrid] Fix ACS Event Names The Azure Communication Services team noticed that some of their event shapes were wrong and have [updated the swagger](Azure/azure-rest-api-specs#13485) to address this. This commit pulls these changes into our SDK. Fixes #14345 * [EventGrid] Add types for RecordingFileStatusUpdated event This is a new event ACS is sending. * [EventGrid] Remove incorrect ACS System Events After discussion, we are comfortable removing these two event names from our mapping. The rationale here is that the service never sent events using these names (they made a typo when documenting the event names in Swagger) and so any code using them was going to be wrong. In this case, we like that if you're using TypeScript you'll see a compile time issue here because it will be pointing to place in your code where things were never going to behave as you might have expected. The `CHANGELOG.md` has been updated to provide a little more perscriptive guidence on what to do here, and we feel OK about not doing a major version bump.
jay-most
pushed a commit
to jay-most/azure-sdk-for-js
that referenced
this pull request
Apr 26, 2021
* [EventGrid] Fix ACS Event Names The Azure Communication Services team noticed that some of their event shapes were wrong and have [updated the swagger](Azure/azure-rest-api-specs#13485) to address this. This commit pulls these changes into our SDK. Fixes Azure#14345 * [EventGrid] Add types for RecordingFileStatusUpdated event This is a new event ACS is sending. * [EventGrid] Remove incorrect ACS System Events After discussion, we are comfortable removing these two event names from our mapping. The rationale here is that the service never sent events using these names (they made a typo when documenting the event names in Swagger) and so any code using them was going to be wrong. In this case, we like that if you're using TypeScript you'll see a compile time issue here because it will be pointing to place in your code where things were never going to behave as you might have expected. The `CHANGELOG.md` has been updated to provide a little more perscriptive guidence on what to do here, and we feel OK about not doing a major version bump.
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
Co-authored-by: Vikram Praveen Kumar <[email protected]>
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
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 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.