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

Rename agfood to agrifood #14735

Merged
merged 2 commits into from
Jun 10, 2021
Merged

Rename agfood to agrifood #14735

merged 2 commits into from
Jun 10, 2021

Conversation

RGKarthik
Copy link
Member

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

@openapi-workflow-bot
Copy link

Hi, @RGKarthik 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
    Copy link

    openapi-pipeline-app bot commented Jun 9, 2021

    Swagger Validation Report

    ️❌BreakingChange: 20 Errors, 0 Warnings failed [Detail]

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

    Rule Message
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions/{extensionId}' removed or restructured?
    Old: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L9:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}/extensions' removed or restructured?
    Old: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L195:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.AgFoodPlatform/farmBeatsExtensionDefinitions' removed or restructured?
    Old: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L279:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.AgFoodPlatform/farmBeatsExtensionDefinitions/{farmBeatsExtensionId}' removed or restructured?
    Old: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L368:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats/{farmBeatsResourceName}' removed or restructured?
    Old: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L412:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/farmBeats' removed or restructured?
    Old: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L616:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AgFoodPlatform/farmBeats' removed or restructured?
    Old: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L674:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.AgFoodPlatform/checkNameAvailability' removed or restructured?
    Old: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L735:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.AgFoodPlatform/operations' removed or restructured?
    Old: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L789:5
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'FarmBeatsProperties' removed or renamed?
    New: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L9:3
    Old: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/agfood.json#L829:3
    ️❌LintDiff: 8 Errors, 50 Warnings failed [Detail]
    The following errors/warnings are introduced by current PR:

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

    Rule Message
    R4037 - MissingTypeObject The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: common-types/resource-management/v2/types.json#L9
    R4037 - MissingTypeObject The schema 'AzureEntityResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: common-types/resource-management/v2/types.json#L31
    R4037 - MissingTypeObject The schema 'TrackedResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: common-types/resource-management/v2/types.json#L48
    R4037 - MissingTypeObject The schema 'ErrorDetail' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: common-types/resource-management/v2/types.json#L277
    R4037 - MissingTypeObject The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: common-types/resource-management/v2/types.json#L313
    R4037 - MissingTypeObject The schema 'ErrorAdditionalInfo' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: common-types/resource-management/v2/types.json#L323
    R4037 - MissingTypeObject The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: common-types/resource-management/v2/types.json#L353
    R4037 - MissingTypeObject The schema 'OperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: common-types/resource-management/v2/types.json#L406
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L8932
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/agfood.json#L9205
    ️❌Avocado: 6 Errors, 0 Warnings failed [Detail]
    Rule Message
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: data-plane/Microsoft.AgFoodPlatform/preview/2021-03-31-preview
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: Microsoft.AgFoodPlatform/preview/2021-03-31-preview/examples
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: 201e205d2ec657e244cd8db34d46bdbad925e503/specification/agfood/data-plane
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: resource-manager/Microsoft.AgFoodPlatform/preview/2020-05-12-preview
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: Microsoft.AgFoodPlatform/preview/2020-05-12-preview/examples
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: 201e205d2ec657e244cd8db34d46bdbad925e503/specification/agfood/resource-manager
    ️️✔️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] [Expand]
    Validation passes for SDKTrack2Validation
    ️️✔️[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-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 Jun 9, 2021

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-agrifood - first release
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 3ac6ce2. 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.
      warn		specification/agrifood/data-plane/readme.md skipped due to azure-sdk-for-python-track2 not found in swagger-to-sdk
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 3ac6ce2. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      warn		specification/agrifood/data-plane/readme.md skipped due to azure-sdk-for-js not found in swagger-to-sdk
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.6.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/agrifood/resource-manager/readme.md
    • ️✔️@azure/arm-agrifood [View full logs]  [Release SDK Changes]
      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/azureAgriFoodRPService.js → ./dist/arm-agrifood.js...
      cmderr	[npmPack] created ./dist/arm-agrifood.js in 264ms
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @RGKarthik, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @lmazuel lmazuel merged commit 3ac6ce2 into master Jun 10, 2021
    @lmazuel lmazuel deleted the namechange branch June 10, 2021 22:49
    asager pushed a commit to asager/azure-rest-api-specs that referenced this pull request Jun 24, 2021
    * Rename agfood to agrifood
    
    * Agfood to Agri in swagger
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * Rename agfood to agrifood
    
    * Agfood to Agri in swagger
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants