{EventGrid}: Update data-plane Swagger to include aeg-channel-name in header

[VidyaKukke]

…ader

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:

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 are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
   Mar 2022

3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
   02-04-2022

4. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the 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 refresh required for updates in this PR

Contribution checklist:

• I commit to follow the Breaking Change Policy of "no breaking changes"
• I have reviewed the documentation for the workflow.
• Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

• Change to data plane APIs
• Adding new properties
• All removals

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.

  • Adding a new service
  • Adding new API(s)
  • Adding a new API version
    -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

• Removing API(s) in a stable version
• Removing properties in a stable version
• Removing API version(s) in a stable version
• Updating API in a 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]

Hi, @VidyaKukke 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-workflow-bot]

[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.

[openapi-pipeline-app]

Swagger Validation Report

️⌛BreakingChange pending [Detail]

️⌛LintDiff pending [Detail]

️⌛Avocado pending [Detail]

️⌛~[Staging] ApiReadinessCheck pending [Detail]

️⌛ModelValidation pending [Detail]

️⌛SemanticValidation pending [Detail]

️⌛Cross-Version Breaking Changes pending [Detail]

️⌛CredScan pending [Detail]

️⌛SDK Track2 Validation pending [Detail]

️⌛PrettierCheck pending [Detail]

️⌛SpellCheck pending [Detail]

️⌛Lint(RPaaS) pending [Detail]

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app]

Swagger Generation Artifacts

️⌛ApiDocPreview pending [Detail]

️⌛SDK Breaking Change Tracking pending [Detail]

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

• ️✔️Succeeded [Logs]Release - Generate from 5582a35. SDK Automation 14.0.0

  command	sh ./eng/initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
  command	generator automation ../../../../../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]
  Only show 120 items here, please refer to log for details.
  

  info	[Changelog] - New function `ResourceDeleteCancelData.MarshalJSON() ([]byte, error)`
  info	[Changelog] - New function `AcsChatMessageEditedEventData.MarshalJSON() ([]byte, error)`
  info	[Changelog] - New function `AcsChatThreadCreatedEventData.MarshalJSON() ([]byte, error)`
  info	[Changelog] - New function `ResourceWriteCancelData.MarshalJSON() ([]byte, error)`
  info	[Changelog] - New function `MediaLiveEventChannelArchiveHeartbeatEventData.MarshalJSON() ([]byte, error)`
  info	[Changelog] - New function `AcsChatMessageEditedInThreadEventData.MarshalJSON() ([]byte, error)`
  info	[Changelog] - New function `ResourceDeleteFailureData.MarshalJSON() ([]byte, error)`
  info	[Changelog] - New function `AcsChatThreadPropertiesUpdatedPerUserEventData.MarshalJSON() ([]byte, error)`
  info	[Changelog] - New function `PossibleRecordingContentTypeValues() []RecordingContentType`
  info	[Changelog] - New function `ResourceWriteFailureData.MarshalJSON() ([]byte, error)`
  info	[Changelog] - New function `ResourceActionCancelData.MarshalJSON() ([]byte, error)`
  info	[Changelog] - New function `PossibleRecordingChannelTypeValues() []RecordingChannelType`
  info	[Changelog] - New function `AcsChatThreadCreatedWithUserEventData.MarshalJSON() ([]byte, error)`
  info	[Changelog] - New function `ResourceActionFailureData.MarshalJSON() ([]byte, error)`
  info	[Changelog] - New function `PossibleCommunicationCloudEnvironmentModelValues() []CommunicationCloudEnvironmentModel`
  info	[Changelog] - New function `ResourceAuthorization.MarshalJSON() ([]byte, error)`
  info	[Changelog] - New function `AcsChatMessageReceivedInThreadEventData.MarshalJSON() ([]byte, error)`
  info	[Changelog] - New function `ResourceWriteSuccessData.MarshalJSON() ([]byte, error)`
  info	[Changelog] - New function `ResourceActionSuccessData.MarshalJSON() ([]byte, error)`
  info	[Changelog] - New function `PossibleRecordingFormatTypeValues() []RecordingFormatType`
  info	[Changelog] - New struct `APIManagementAPICreatedEventData`
  info	[Changelog] - New struct `APIManagementAPIDeletedEventData`
  info	[Changelog] - New struct `APIManagementAPIReleaseCreatedEventData`
  info	[Changelog] - New struct `APIManagementAPIReleaseDeletedEventData`
  info	[Changelog] - New struct `APIManagementAPIReleaseUpdatedEventData`
  info	[Changelog] - New struct `APIManagementAPIUpdatedEventData`
  info	[Changelog] - New struct `APIManagementProductCreatedEventData`
  info	[Changelog] - New struct `APIManagementProductDeletedEventData`
  info	[Changelog] - New struct `APIManagementProductUpdatedEventData`
  info	[Changelog] - New struct `APIManagementSubscriptionCreatedEventData`
  info	[Changelog] - New struct `APIManagementSubscriptionDeletedEventData`
  info	[Changelog] - New struct `APIManagementSubscriptionUpdatedEventData`
  info	[Changelog] - New struct `APIManagementUserCreatedEventData`
  info	[Changelog] - New struct `APIManagementUserDeletedEventData`
  info	[Changelog] - New struct `APIManagementUserUpdatedEventData`
  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 `AcsUserDisconnectedEventData`
  info	[Changelog] - New struct `CommunicationIdentifierModel`
  info	[Changelog] - New struct `CommunicationUserIdentifierModel`
  info	[Changelog] - New struct `ContainerRegistryEventConnectedRegistry`
  info	[Changelog] - New struct `ContainerServiceNewKubernetesVersionAvailableEventData`
  info	[Changelog] - New struct `MediaLiveEventChannelArchiveHeartbeatEventData`
  info	[Changelog] - New struct `MicrosoftTeamsUserIdentifierModel`
  info	[Changelog] - New struct `PhoneNumberIdentifierModel`
  info	[Changelog] - New struct `PolicyInsightsPolicyStateChangedEventData`
  info	[Changelog] - New struct `PolicyInsightsPolicyStateCreatedEventData`
  info	[Changelog] - New struct `PolicyInsightsPolicyStateDeletedEventData`
  info	[Changelog] - New struct `ResourceAuthorization`
  info	[Changelog] - New struct `ResourceHTTPRequest`
  info	[Changelog] - New struct `ServiceBusActiveMessagesAvailablePeriodicNotificationsEventData`
  info	[Changelog] - New struct `ServiceBusDeadletterMessagesAvailablePeriodicNotificationsEventData`
  info	[Changelog] - New struct `StorageAsyncOperationInitiatedEventData`
  info	[Changelog] - New struct `StorageBlobInventoryPolicyCompletedEventData`
  info	[Changelog] - New struct `StorageBlobTierChangedEventData`
  info	[Changelog] - New field `NBF` in struct `KeyVaultCertificateNearExpiryEventData`
  info	[Changelog] - New field `EXP` in struct `KeyVaultCertificateNearExpiryEventData`
  info	[Changelog] - New field `NBF` in struct `KeyVaultCertificateNewVersionCreatedEventData`
  info	[Changelog] - New field `EXP` in struct `KeyVaultCertificateNewVersionCreatedEventData`
  info	[Changelog] - New field `NBF` in struct `KeyVaultKeyNearExpiryEventData`
  info	[Changelog] - New field `EXP` in struct `KeyVaultKeyNearExpiryEventData`
  info	[Changelog] - New field `ConnectedRegistry` in struct `ContainerRegistryEventData`
  info	[Changelog] - New field `Location` in struct `ContainerRegistryEventData`
  info	[Changelog] - New field `NBF` in struct `KeyVaultKeyNewVersionCreatedEventData`
  info	[Changelog] - New field `EXP` in struct `KeyVaultKeyNewVersionCreatedEventData`
  info	[Changelog] - New field `TranscriptionLanguage` in struct `MediaLiveEventIngestHeartbeatEventData`
  info	[Changelog] - New field `TranscriptionState` in struct `MediaLiveEventIngestHeartbeatEventData`
  info	[Changelog] - New field `IngestDriftValue` in struct `MediaLiveEventIngestHeartbeatEventData`
  info	[Changelog] - New field `LastFragmentArrivalTime` in struct `MediaLiveEventIngestHeartbeatEventData`
  info	[Changelog] - New field `Location` in struct `ContainerRegistryImageDeletedEventData`
  info	[Changelog] - New field `ConnectedRegistry` in struct `ContainerRegistryImageDeletedEventData`
  info	[Changelog] - New field `Location` in struct `ContainerRegistryChartDeletedEventData`
  info	[Changelog] - New field `ConnectedRegistry` in struct `ContainerRegistryChartDeletedEventData`
  info	[Changelog] - New field `Location` in struct `ContainerRegistryImagePushedEventData`
  info	[Changelog] - New field `ConnectedRegistry` in struct `ContainerRegistryImagePushedEventData`
  info	[Changelog] - New field `Location` in struct `ContainerRegistryArtifactEventData`
  info	[Changelog] - New field `ConnectedRegistry` in struct `ContainerRegistryArtifactEventData`
  info	[Changelog] - New field `NBF` in struct `KeyVaultSecretNewVersionCreatedEventData`
  info	[Changelog] - New field `EXP` in struct `KeyVaultSecretNewVersionCreatedEventData`
  info	[Changelog] - New field `ConnectedRegistry` in struct `ContainerRegistryChartPushedEventData`
  info	[Changelog] - New field `Location` in struct `ContainerRegistryChartPushedEventData`
  info	[Changelog] - New field `NBF` in struct `KeyVaultCertificateExpiredEventData`
  info	[Changelog] - New field `EXP` in struct `KeyVaultCertificateExpiredEventData`
  info	[Changelog] - New field `NBF` in struct `KeyVaultSecretExpiredEventData`
  info	[Changelog] - New field `EXP` in struct `KeyVaultSecretExpiredEventData`
  info	[Changelog] - New field `SyncToken` in struct `AppConfigurationKeyValueDeletedEventData`
  info	[Changelog] - New field `NBF` in struct `KeyVaultVaultAccessPolicyChangedEventData`
  info	[Changelog] - New field `EXP` in struct `KeyVaultVaultAccessPolicyChangedEventData`
  info	[Changelog] - New field `SyncToken` in struct `AppConfigurationKeyValueModifiedEventData`
  info	[Changelog] - New field `NBF` in struct `KeyVaultKeyExpiredEventData`
  info	[Changelog] - New field `EXP` in struct `KeyVaultKeyExpiredEventData`
  info	[Changelog] - New field `NBF` in struct `KeyVaultSecretNearExpiryEventData`
  info	[Changelog] - New field `EXP` in struct `KeyVaultSecretNearExpiryEventData`
  info	[Changelog] - New field `Tag` in struct `AcsSmsDeliveryReportReceivedEventData`
  info	[Changelog]
  info	[Changelog] Total 51 breaking change(s), 173 additive change(s).

️⚠️ azure-sdk-for-python warning [Detail]

• ⚠️Warning [Logs]Release - Generate from 5582a35. 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] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
  cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
  cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
  cmderr	[automation_init.sh] opencensus-ext-azure 1.1.1 requires azure-core<2.0.0,>=1.12.0, but you have azure-core 1.6.0 which is incompatible.
  cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
  cmderr	[automation_init.sh] azure-identity 1.7.1 requires azure-core<2.0.0,>=1.11.0, but you have azure-core 1.6.0 which is incompatible.
  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
  cmderr	[automation_generate.sh] npm notice
  cmderr	[automation_generate.sh] npm notice New minor version of npm available! 8.1.2 -> 8.4.0
  cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.4.0>
  cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@8.4.0` to update!
  cmderr	[automation_generate.sh] npm notice

• ️✔️azure-eventgrid [View full logs]  [Release SDK Changes]
  • azure-eventgrid-1.3.0.zip
  • azure_eventgrid-1.3.0-py2.py3-none-any.whl

  info	[Changelog] data-plan skip changelog generation temporarily

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

• ️✔️Succeeded [Logs]Release - Generate from 5582a35. SDK Automation 14.0.0

  command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
  warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
  command	pwsh ./eng/scripts/Automation-Sdk-Generate.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

• ️✔️Azure.Messaging.EventGrid [View full logs]  [Release SDK Changes] Breaking Change Detected
  • Azure.Messaging.EventGrid.4.9.0-alpha.20220203.1.nupkg
  • Azure.Messaging.EventGrid.4.9.0-alpha.20220203.1.symbols.nupkg

  info	[Changelog] Breaking Changes: /home/vsts/.nuget/packages/microsoft.dotnet.apicompat/5.0.0-beta.20467.1/build/Microsoft.DotNet.ApiCompat.targets(96,5): error : ApiCompat failed for '/home/vsts/work/1/s/azure-sdk-for-net/artifacts/bin/Azure.Messaging.EventGrid/Debug/netstandard2.0/Azure.Messaging.EventGrid.dll' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/eventgrid/Azure.Messaging.EventGrid/src/Azure.Messaging.EventGrid.csproj]

️❌ azure-sdk-for-js failed [Detail]

• ❌Failed [Logs]Release - Generate from 5582a35. SDK Automation 14.0.0

  command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
  cmderr	[automation_init.sh]  read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
  cmderr	[automation_init.sh]  uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
  cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
  cmderr	[automation_init.sh] notice created a lockfile as package-lock.json. You should commit this file.
  cmderr	[automation_init.sh]  @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
  warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
  command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
  error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-js]: sh .scripts/automation_generate.sh
  warn	Skip package processing as generation is failed

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-workflow-bot]

Hi @VidyaKukke, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

[openapi-workflow-bot]

NewApiVersionRequired reason:

A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.