[Hub Generated] Review request for Microsoft.AgFoodPlatform to add version preview/2020-05-12-preview

[priyankajayaswal1]

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

This PR is about merging AgFoodPlatform RP swagger.json for client sdk creation. We are approaching public preview next month and looking to initiate client creation process for the first time. We have already got approval for the changes mentioned in this PR in private repo (https://github.com/Azure/azure-rest-api-specs-pr/pull/3352).

I have used private repo commit as base in this PR (77c5db2 and 6527fd8 in this PR ) so that it is easy for you to review the changes appropriately. We want to merge this ASAP. Last commit contains only description updates.

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

• 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

• 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]

Hi, @priyankajayaswal1 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]

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️LintDiff: 7 Warnings warning [Detail]

• Linted configuring files (Based on source branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
  • agfood/resource-manager/readme.md tag:package-2020-05-12-preview
• Linted configuring files (Based on target branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
  • agfood/resource-manager/readme.md tag:default

The following errors/warnings are introduced by current PR:

Rule	Message
⚠️ R3010 - TrackedResourceListByImmediateParent	The child tracked resource, 'extensions' with immediate parent 'FarmBeats', must have a list by immediate parent operation. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L690
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: common-types/resource-management/v2/types.json#L348
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable Location: common-types/resource-management/v2/types.json#L604
⚠️ R4021 - DescriptionAndTitleMissing	'systemData' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L733
⚠️ R4021 - DescriptionAndTitleMissing	'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L736
⚠️ R4021 - DescriptionAndTitleMissing	'systemData' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L800
⚠️ R4021 - DescriptionAndTitleMissing	'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L803

️️✔️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.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

• The following tags are being changed in this PR
• agfood/resource-manager/readme.md#package-2020-05-12-preview

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"agfood/resource-manager/readme.md",
"tag":"package-2020-05-12-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"agfood/resource-manager/readme.md",
"tag":"package-2020-05-12-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"agfood/resource-manager/readme.md",
"tag":"package-2020-05-12-preview",
"details":"> Installing AutoRest extension '@autorest/modelerfour' (4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"agfood/resource-manager/readme.md",
"tag":"package-2020-05-12-preview",
"details":"> Installed 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.

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

[openapi-pipeline-app]

Swagger Generation Artifacts

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

• ️✔️Succeeded [Logs]Release - Generate from 142e0d8. 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/agfood/resource-manager/readme.md

• ️✔️@azure/arm-agfood [View full logs]  [Release SDK Changes]
  • azure-arm-agfood-1.0.0.tgz

  cmderr	[npmPack] loaded rollup.config.js with warnings
  cmderr	[npmPack] (!) Unused external imports
  cmderr	[npmPack] default imported from external module 'rollup' but never used
  cmderr	[npmPack] ./esm/azureAgFoodPlatformRPService.js → ./dist/arm-agfood.js...
  cmderr	[npmPack] created ./dist/arm-agfood.js in 201ms

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

• ️✔️Succeeded [Logs]Release - Generate from 142e0d8. 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

• ️✔️preview/agfood/mgmt/2020-05-12-preview/agfood [View full logs]  [Release SDK Changes]

  info	[Changelog] This is a new package

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

• ⚠️Warning [Logs]Release - Generate from 142e0d8. 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

• ️✔️track2_azure-mgmt-agfood [View full logs]  [Release SDK Changes]
  • azure-mgmt-agfood-1.0.0b1.zip
  • azure_mgmt_agfood-1.0.0b1-py2.py3-none-any.whl

  info	[Changelog]   - Initial Release

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account. 

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

[priyankajayaswal1]

/azp run unifiedPipeline

[azure-pipelines]

No pipelines are associated with this pull request.

[priyankajayaswal1]

/azp run unifiedPipeline

[azure-pipelines]

No pipelines are associated with this pull request.

[openapi-workflow-bot]

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

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

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

[openapi-workflow-bot]

Hi, @priyankajayaswal1 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @jianyexi

[sulabh-msft]

@Azure/arm-api-review-board Please review the PR.

[sulabh-msft]

@chiragg4u,
Can you please review the PR ?

CC: @jsharmaMSFT

[chiragg4u]

Overall model looks ok, I've minor non-blocking comments. Marking it ARMSignedoff, follow the process given @ https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/212/Swagger-PR-Review to complete and get the PR merged

[priyankajayaswal1]

@chiragg4u thank you for your review. really appreciate it.
@jianyexi The last commit that you see I had unintentionally pushed which I reverted to keep it in sync with what Chirag approved.

Do let me know if there is anything else needed from our end to get this PR merged.
Looking forward to you merging it ASAP.

[ArcturusZhang]

LGTM for the readme.go.md

[msyyc]

@priyankajayaswal1 Please replace 'readme.python.md' with attachment :
readme.python.md
For new service, we only need to keep track2 configuration.