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

[EventGrid] Add "FarmBeats" prefix to two enums #14628

Merged

Conversation

ellismg
Copy link
Member

@ellismg ellismg commented Jun 1, 2021

The JobStatus and ResourceActionType has very general names and
did not indicate they were specific to FarmBeats. Add a prefix to the
names so the generated types in the SDKs have more specific names.

The `JobStatus` and `ResourceActionType` has very general names and
did not indicate they were specific to FarmBeats. Add a prefix to the
names so the generated types in the SDKs have more specific names.
@ellismg ellismg requested review from lmazuel and JoshLove-msft June 1, 2021 22:58
@ellismg ellismg requested review from ahamad-MS and Kishp01 as code owners June 1, 2021 22:58
@openapi-workflow-bot
Copy link

Hi, @ellismg 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 1, 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:

    Only 10 items are listed, please refer to log for more details.

    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#L118
    ⚠️ 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#L217
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json#L243
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.AgFoodPlatform/stable/2018-01-01/AzureFarmBeats.json#L76
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.AgFoodPlatform/stable/2018-01-01/AzureFarmBeats.json#L122
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.AgFoodPlatform/stable/2018-01-01/AzureFarmBeats.json#L172
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.AgFoodPlatform/stable/2018-01-01/AzureFarmBeats.json#L222
    ️️✔️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 Jun 1, 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.0.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 failed [Detail]
    • Failed [Logs]Release - Generate from bc43918. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: sh ./initScript.sh
      warn	File azure-sdk-for-go_tmp/initOutput.json not found to read
      command	go run ./tools/generator/main.go automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: go run ./tools/generator/main.go automation
      warn	Skip package processing as generation is failed
    ️❌ azure-sdk-for-python failed [Detail]
    • Failed [Logs]Release - Generate from bc43918. 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.2.2 requires azure-core<2.0.0,>=1.9.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.2.2 requires azure-core<2.0.0,>=1.9.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
      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-js failed [Detail]
    • Failed [Logs]Release - Generate from bc43918. 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?

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

    @ellismg
    Copy link
    Member Author

    ellismg commented Jun 1, 2021

    @lmazuel Sorry for not noticing this when the events were in PR, it didn't become obvious to me before reviewing the surface area changes to the SDKs after ingesting the new events.

    @lmazuel lmazuel merged commit bc43918 into Azure:master Jun 2, 2021
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    The `JobStatus` and `ResourceActionType` has very general names and
    did not indicate they were specific to FarmBeats. Add a prefix to the
    names so the generated types in the SDKs have more specific names.
    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.

    4 participants