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

adding ContainerService eventgrid event schema #15118

Merged
merged 3 commits into from
Jul 15, 2021

Conversation

serbrech
Copy link
Member

@serbrech serbrech commented Jul 8, 2021

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?
    • Other, please clarify: Adding a dataplane for AKS type to EventGrid
  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.
    July 16th
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
    This is Eventgris swagger.
    functionality works without publishing the swagger as this is dataplane types. Depends on Eventgrid.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.

Unsure, eventgrid team would know better if that is needed

  - [ ] 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
  - [x] 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, @serbrech 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. [email protected]

    @openapi-workflow-bot
    Copy link

    [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
    Copy link

    openapi-pipeline-app bot commented Jul 8, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.Devices/stable/2018-01-01/IotHub.json#L103
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.Devices/stable/2018-01-01/IotHub.json#L147
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L146
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L174
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L245
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L271
    ️️✔️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 succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail]
    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"eventgrid/data-plane/readme.md",
    "tag":"package-2018-01",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"eventgrid/data-plane/readme.md",
    "tag":"package-2018-01",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    Rule Message
    AutorestCore/Exception "readme":"eventgrid/data-plane/readme.md",
    "tag":"package-2018-01",
    "details":"Error: Semantic validation failed. There was some errors"
    💬 AutorestCore/Exception "readme":"eventgrid/data-plane/readme.md",
    "tag":"package-2018-01",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"
    ️️✔️[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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 8, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌[Staging] SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    azure-sdk-for-go - eventgrid/2018-01-01/eventgrid - v55.6.0
    +	Const `AseV1` has been removed
    +	Const `AseV2` has been removed
    +	Const `Public` type has been changed from `StampKind` to `CommunicationCloudEnvironmentModel`
    +	Function `ACSChatThreadCreatedWithUserEventData.MarshalJSON` has been removed
    +	Function `ACSChatThreadPropertiesUpdatedPerUserEventData.MarshalJSON` has been removed
    +	Struct `ACSChatEventBaseProperties` has been removed
    +	Struct `ACSChatMemberAddedToThreadWithUserEventData` has been removed
    +	Struct `ACSChatMemberRemovedFromThreadWithUserEventData` has been removed
    +	Struct `ACSChatMessageDeletedEventData` has been removed
    +	Struct `ACSChatMessageEditedEventData` has been removed
    +	Struct `ACSChatMessageEventBaseProperties` has been removed
    +	Struct `ACSChatMessageReceivedEventData` has been removed
    +	Struct `ACSChatThreadCreatedWithUserEventData` has been removed
    +	Struct `ACSChatThreadEventBaseProperties` has been removed
    +	Struct `ACSChatThreadMemberProperties` has been removed
    +	Struct `ACSChatThreadPropertiesUpdatedPerUserEventData` has been removed
    +	Struct `ACSChatThreadWithUserDeletedEventData` has been removed
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 7026463. SDK Automation 14.0.0
      command	sh ./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] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Const `Public` type has been changed from `StampKind` to `CommunicationCloudEnvironmentModel`
      info	[Changelog] - Const `AseV2` has been removed
      info	[Changelog] - Const `AseV1` has been removed
      info	[Changelog] - Function `ACSChatThreadPropertiesUpdatedPerUserEventData.MarshalJSON` has been removed
      info	[Changelog] - Function `ACSChatThreadCreatedWithUserEventData.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 `StampKindAseV2`
      info	[Changelog] - New const `Dod`
      info	[Changelog] - New const `Gcch`
      info	[Changelog] - New const `StampKindPublic`
      info	[Changelog] - New const `StampKindAseV1`
      info	[Changelog] - New function `PossibleCommunicationCloudEnvironmentModelValues() []CommunicationCloudEnvironmentModel`
      info	[Changelog] - New function `AcsChatMessageEditedInThreadEventData.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `AcsChatThreadCreatedWithUserEventData.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `AcsChatMessageReceivedInThreadEventData.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `AcsChatMessageReceivedEventData.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `AcsChatThreadCreatedEventData.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `AcsChatThreadPropertiesUpdatedEventData.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `AcsChatThreadPropertiesUpdatedPerUserEventData.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `AcsChatMessageEditedEventData.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 `ContainerServiceNewKubernetesVersionAvailableEventData`
      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 `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 `Tag` in struct `AcsSmsDeliveryReportReceivedEventData`
      info	[Changelog] - New field `SyncToken` in struct `AppConfigurationKeyValueModifiedEventData`
      info	[Changelog] - New field `SyncToken` in struct `AppConfigurationKeyValueDeletedEventData`
      info	[Changelog]
      info	[Changelog] Total 29 breaking change(s), 95 additive change(s).
      info	[Changelog]
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 7026463. 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] 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] 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
    • ️✔️azure-eventgrid [View full logs]  [Release SDK Changes]
      info	[Changelog] data-plan skip changelog generation temporarily
    ️❌ azure-sdk-for-js failed [Detail]
    • Failed [Logs]Release - Generate from 7026463. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --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
    Posted by Swagger Pipeline | How to fix these errors?

    @serbrech
    Copy link
    Member Author

    serbrech commented Jul 8, 2021

    readme.md in the specifications/eventgrid/data-plane folder states :

    To build the SDK for EventGrid, simply Install AutoRest and in this folder, run:

    autorest

    This fails with

    ERROR: Semantic violation: Discriminator must be a required property. (components > schemas > MediaJobOutput)
      discriminator: { propertyName: '@odata.type' }
        - file:///workspaces/azure-rest-api-specs/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/MediaServices.json:280:3
      Error: Semantic validation failed. There was some errors

    @serbrech
    Copy link
    Member Author

    /azp run

    @azure-pipelines
    Copy link

    Commenter does not have sufficient privileges for PR 15118 in repo Azure/azure-rest-api-specs

    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.

    2 participants