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

Added Azure FarmBeats(Public Preview) Event Grid Events for first time (RP Namespace: Microsoft.AgFoodPlatform) #14201

Conversation

BlackRider97
Copy link
Member

@BlackRider97 BlackRider97 commented Apr 30, 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?
    • 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
      Publish the event schemas for Microsoft.AgFoodPlatform's Azure FarmBeats resource Event Grid system topic.
  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.
    We are planning to go Public Preview on 11th May, 2021
  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.

…e (RP Namespace: Microsoft.AgFoodPlatform)
@openapi-workflow-bot
Copy link

Hi, @BlackRider97 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 Apr 30, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌LintDiff: 1 Errors, 0 Warnings failed [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    AutoRest exception "readme":"eventgrid/data-plane/readme.md",
    "tag":"package-2018-01",
    "details":"Syntax Error Encountered: Unexpected token : in JSON"


    The following errors/warnings exist before current PR submission:

    Rule Message
    AutoRest exception "readme":"eventgrid/data-plane/readme.md",
    "tag":"package-2018-01",
    "details":"Syntax Error Encountered: Unexpected token : in JSON"
    ️️✔️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 BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️🔄[Staging] SDK Track2 Validation inProgress [Detail]
    ️️✔️[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 Apr 30, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌ azure-sdk-for-python failed [Detail]
    • Failed [Logs] Generate from efefcdec604371c4c9755e568411675e8ebb864d. 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]
      cmdout	[automation_generate.sh] [Autorest]    Loading AutoRest core      '/home/vsts/.autorest/@[email protected]/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4417)
      cmdout	[automation_generate.sh] [Autorest] ERROR: Syntax Error Encountered: Unexpected token : in JSON
      cmdout	[automation_generate.sh] [Autorest]     - file:///home/vsts/work/1/s/azure-rest-api-specs/specification/eventgrid/data-plane/readme.md:23:33
      cmdout	[automation_generate.sh] [Autorest] [OperationAbortedException] Error occurred. Exiting.
      cmdout	[automation_generate.sh] [Autorest]/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen
      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] Generate from efefcdec604371c4c9755e568411675e8ebb864d. 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
      cmderr	[Autorest] ERROR: Syntax Error Encountered: Unexpected token : in JSON
      cmderr	[Autorest]     - file:///home/vsts/work/1/s/azure-rest-api-specs/specification/eventgrid/data-plane/readme.md:23:33
      cmdout	[Autorest] [OperationAbortedException] Error occurred. Exiting.
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-js/azure-sdk-for-js]: autorest
      warn	Skip package processing as generation is failed
    ️❌ azure-sdk-for-go failed [Detail]
    • Failed [Logs] Generate from efefcdec604371c4c9755e568411675e8ebb864d. 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
      cmderr	[main.go] [AUTOREST] ERROR: Syntax Error Encountered: Unexpected token : in JSON
      cmderr	[main.go] [AUTOREST]     - file:///home/vsts/work/1/s/azure-rest-api-specs/specification/eventgrid/data-plane/readme.md:23:33
      cmderr	[main.go] [ERROR] total 1 error(s):
      cmderr	[main.go] [ERROR] cannot generate readme 'specification/eventgrid/data-plane/readme.md': autorest error with arguments '[email protected]/[email protected], --go, --verbose, --go-sdk-folder=., --multiapi, --use-onever, --version=V2, --go.license-header=MICROSOFT_MIT_NO_VERSION, ../../../../../azure-rest-api-specs/specification/eventgrid/data-plane/readme.md, --metadata-output-folder=../../../../../azure-rest-api-specs/specification/eventgrid/data-plane':
      cmderr	[main.go] [ERROR] exit status 1
      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
      warn	Skip package processing as generation is failed
    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.

    @openapi-workflow-bot
    Copy link

    Hi @BlackRider97, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @BlackRider97
    Copy link
    Member Author

    BlackRider97 commented Apr 30, 2021

    SDK generation is failing before my changes. Am I missing something here ?

    …able/2018-01-01/AzureFarmBeats.json
    
    Co-authored-by: Rakshith Bhyravabhotla <[email protected]>
    Copy link
    Member

    @ellismg ellismg left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Small nit around the description for one event (just missing a space) but otherwise LGTM!

    "type": "string"
    },
    "parentId": {
    "description": "Id of the parent(field or seasonalField) it belongs to.",
    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Suggested change
    "description": "Id of the parent(field or seasonalField) it belongs to.",
    "description": "Id of the parent (field or seasonalField) it belongs to.",

    @lmazuel lmazuel merged commit 66e560e into dev-eventgrid-Microsoft.AgFoodPlatform-preview-firstTimeCreate May 17, 2021
    @lmazuel lmazuel deleted the event_grid_events branch May 17, 2021 21:02
    lmazuel pushed a commit that referenced this pull request Jun 1, 2021
    …e (RP Namespace: Microsoft.AgFoodPlatform) (#14201) (#14603)
    
    * Added Azure FarmBeats(Public Preview) Event Grid Events for first time (RP Namespace: Microsoft.AgFoodPlatform)
    
    * Fixed spelling mistakes
    
    * Update specification/eventgrid/data-plane/Microsoft.AgFoodPlatform/stable/2018-01-01/AzureFarmBeats.json
    
    Co-authored-by: Rakshith Bhyravabhotla <[email protected]>
    
    Co-authored-by: Rajneesh Mitharwal <[email protected]>
    Co-authored-by: Rakshith Bhyravabhotla <[email protected]>
    
    Co-authored-by: Rajneesh Mitharwal <[email protected]>
    Co-authored-by: Rakshith Bhyravabhotla <[email protected]>
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    …e (RP Namespace: Microsoft.AgFoodPlatform) (Azure#14201) (Azure#14603)
    
    * Added Azure FarmBeats(Public Preview) Event Grid Events for first time (RP Namespace: Microsoft.AgFoodPlatform)
    
    * Fixed spelling mistakes
    
    * Update specification/eventgrid/data-plane/Microsoft.AgFoodPlatform/stable/2018-01-01/AzureFarmBeats.json
    
    Co-authored-by: Rakshith Bhyravabhotla <[email protected]>
    
    Co-authored-by: Rajneesh Mitharwal <[email protected]>
    Co-authored-by: Rakshith Bhyravabhotla <[email protected]>
    
    Co-authored-by: Rajneesh Mitharwal <[email protected]>
    Co-authored-by: Rakshith Bhyravabhotla <[email protected]>
    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