Skip to content
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

Fix event mapping and add a missing field #13485

Merged
merged 1 commit into from
Mar 18, 2021

Conversation

vikrampraveen
Copy link
Contributor

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.

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

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.

    • Adding new API(s)
    • Adding a new API version
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • 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.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

@openapi-workflow-bot
Copy link

Hi, @vikrampraveen Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 17, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.

    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.

    ️️✔️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) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️[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: 43 Warnings warning [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ PreCheck/SchemaMissingType "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'"
    ⚠️ PreCheck/SchemaMissingType "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'"
    ⚠️ PreCheck/SchemaMissingType "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'"
    ⚠️ PreCheck/SchemaMissingType "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'"
    ⚠️ PreCheck/SchemaMissingType "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'"
    ⚠️ PreCheck/SchemaMissingType "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'"
    ⚠️ PreCheck/SchemaMissingType "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'"
    ⚠️ PreCheck/SchemaMissingType "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'"
    ⚠️ PreCheck/SchemaMissingType "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'"
    ⚠️ PreCheck/SchemaMissingType "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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 17, 2021

    Swagger Generation Artifacts

    ️❌ azure-sdk-for-python failed [Detail]
    • Failed [Logs]Release - Generate from cf9d9c4. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
      cmdout	[automation_generate.sh] [Autorest]../azure-sdk-for-python_tmp/generateOutput.json does not exist!!!Error happened during package
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
      warn	Skip package processing as generation is failed
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from cf9d9c4. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️eventgrid/2018-01-01/eventgrid [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Const `Public` type has been changed from `StampKind` to `CommunicationCloudEnvironmentModel`
      info	[Changelog] - Const `AseV1` has been removed
      info	[Changelog] - Const `AseV2` has been removed
      info	[Changelog] - Function `ACSChatThreadCreatedWithUserEventData.MarshalJSON` has been removed
      info	[Changelog] - Function `ACSChatThreadPropertiesUpdatedPerUserEventData.MarshalJSON` has been removed
      info	[Changelog] - Struct `ACSChatEventBaseProperties` has been removed
      info	[Changelog] - Struct `ACSChatMemberAddedToThreadWithUserEventData` has been removed
      info	[Changelog] - Struct `ACSChatMemberRemovedFromThreadWithUserEventData` has been removed
      info	[Changelog] - Struct `ACSChatMessageDeletedEventData` has been removed
      info	[Changelog] - Struct `ACSChatMessageEditedEventData` has been removed
      info	[Changelog] - Struct `ACSChatMessageEventBaseProperties` has been removed
      info	[Changelog] - Struct `ACSChatMessageReceivedEventData` has been removed
      info	[Changelog] - Struct `ACSChatThreadCreatedWithUserEventData` has been removed
      info	[Changelog] - Struct `ACSChatThreadEventBaseProperties` has been removed
      info	[Changelog] - Struct `ACSChatThreadMemberProperties` has been removed
      info	[Changelog] - Struct `ACSChatThreadPropertiesUpdatedPerUserEventData` has been removed
      info	[Changelog] - Struct `ACSChatThreadWithUserDeletedEventData` has been removed
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `Dod`
      info	[Changelog] - New const `StampKindAseV2`
      info	[Changelog] - New const `StampKindAseV1`
      info	[Changelog] - New const `Gcch`
      info	[Changelog] - New const `StampKindPublic`
      info	[Changelog] - New function `AcsChatThreadCreatedWithUserEventData.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `AcsChatThreadPropertiesUpdatedEventData.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `PossibleCommunicationCloudEnvironmentModelValues() []CommunicationCloudEnvironmentModel`
      info	[Changelog] - New function `AcsChatThreadCreatedEventData.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `AcsChatThreadPropertiesUpdatedPerUserEventData.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New struct `AcsChatEventBaseProperties`
      info	[Changelog] - New struct `AcsChatEventInThreadBaseProperties`
      info	[Changelog] - New struct `AcsChatMessageDeletedEventData`
      info	[Changelog] - New struct `AcsChatMessageDeletedInThreadEventData`
      info	[Changelog] - New struct `AcsChatMessageEditedEventData`
      info	[Changelog] - New struct `AcsChatMessageEditedInThreadEventData`
      info	[Changelog] - New struct `AcsChatMessageEventBaseProperties`
      info	[Changelog] - New struct `AcsChatMessageEventInThreadBaseProperties`
      info	[Changelog] - New struct `AcsChatMessageReceivedEventData`
      info	[Changelog] - New struct `AcsChatMessageReceivedInThreadEventData`
      info	[Changelog] - New struct `AcsChatParticipantAddedToThreadEventData`
      info	[Changelog] - New struct `AcsChatParticipantAddedToThreadWithUserEventData`
      info	[Changelog] - New struct `AcsChatParticipantRemovedFromThreadEventData`
      info	[Changelog] - New struct `AcsChatParticipantRemovedFromThreadWithUserEventData`
      info	[Changelog] - New struct `AcsChatThreadCreatedEventData`
      info	[Changelog] - New struct `AcsChatThreadCreatedWithUserEventData`
      info	[Changelog] - New struct `AcsChatThreadDeletedEventData`
      info	[Changelog] - New struct `AcsChatThreadEventBaseProperties`
      info	[Changelog] - New struct `AcsChatThreadEventInThreadBaseProperties`
      info	[Changelog] - New struct `AcsChatThreadParticipantProperties`
      info	[Changelog] - New struct `AcsChatThreadPropertiesUpdatedEventData`
      info	[Changelog] - New struct `AcsChatThreadPropertiesUpdatedPerUserEventData`
      info	[Changelog] - New struct `AcsChatThreadWithUserDeletedEventData`
      info	[Changelog] - New struct `AcsRecordingChunkInfoProperties`
      info	[Changelog] - New struct `AcsRecordingFileStatusUpdatedEventData`
      info	[Changelog] - New struct `AcsRecordingStorageInfoProperties`
      info	[Changelog] - New struct `CommunicationIdentifierModel`
      info	[Changelog] - New struct `CommunicationUserIdentifierModel`
      info	[Changelog] - New struct `MicrosoftTeamsUserIdentifierModel`
      info	[Changelog] - New struct `PhoneNumberIdentifierModel`
      info	[Changelog] - New struct `ServiceBusActiveMessagesAvailablePeriodicNotificationsEventData`
      info	[Changelog] - New struct `ServiceBusDeadletterMessagesAvailablePeriodicNotificationsEventData`
      info	[Changelog] - New field `SyncToken` in struct `AppConfigurationKeyValueModifiedEventData`
      info	[Changelog] - New field `SyncToken` in struct `AppConfigurationKeyValueDeletedEventData`
      info	[Changelog] - New field `Tag` in struct `AcsSmsDeliveryReportReceivedEventData`
      info	[Changelog]
      info	[Changelog] Total 29 breaking change(s), 77 additive change(s).
      info	[Changelog]
    ️❌ azure-sdk-for-js failed [Detail]
    • Failed [Logs]Release - Generate from cf9d9c4. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/eventgrid/data-plane/readme.md
    • @azure/eventgrid [View full logs]  [Release SDK Changes]
      error	Script return with result [failed] code [2] signal [null] cwd [azure-sdk-for-js/azure-sdk-for-js/sdk/eventgrid/eventgrid]: npm pack --silent
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    Posted by Swagger Pipeline | How to fix these errors?

    @lmazuel lmazuel merged commit cf9d9c4 into master Mar 18, 2021
    @lmazuel lmazuel deleted the user/vipravee/fixeventmapping branch March 18, 2021 21:51
    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 <vipravee@microsoft.com>
    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 <vipravee@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants