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

[Hub Generated] Review request for Microsoft.IoTCentral to add version stable/2018-09-01 #12318

Conversation

poanchen
Copy link
Member

@poanchen poanchen commented Jan 7, 2021

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

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
    • 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 API 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 version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

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-pipeline-app
Copy link

openapi-pipeline-app bot commented Jan 7, 2021

Swagger Validation Report

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

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.IoTCentral/IoTApps/{resourceName}' removed or restructured?
New: azure-rest-api-specs/blob/cdfecb717df9002d0ff46eeb7fcb6150bbc0723b/
Old: Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json#L37:5
1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/IoTApps' removed or restructured?
New: azure-rest-api-specs/blob/cdfecb717df9002d0ff46eeb7fcb6150bbc0723b/
Old: Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json#L238: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.IoTCentral/IoTApps' removed or restructured?
New: azure-rest-api-specs/blob/cdfecb717df9002d0ff46eeb7fcb6150bbc0723b/
Old: Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json#L278:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json#L37:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json#L238:5
1038 - AddedPath The new version is adding a path that was not found in the old version.
New: Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json#L278:5
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.

️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Jan 7, 2021

Swagger Generation Artifacts

️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 0237dcd. SDK Automation 14.0.0
    warn	Skip initScript due to not configured
    command	sudo apt-get install -y dotnet-sdk-5.0
    command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/iotcentral/resource-manager/readme.md
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
    cmderr	[Autorest] realpath(): Permission denied
  • ️✔️Microsoft.Azure.Management.IotCentral [View full logs]  [Release SDK Changes]
️️✔️ azure-sdk-for-python succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 0237dcd. SDK Automation 14.0.0
    warn	Skip initScript due to not configured
    command	npx n 12
    command	python3 -m venv venv
    command	pip install --upgrade setuptools wheel pip
    command	pip install pathlib jinja2 msrestazure
    command	autorest --version=V2 --use=@microsoft.azure/autorest.python@~4.0.71 --python --python-mode=update --multiapi --keep-version-file --no-async --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk ../azure-rest-api-specs/specification/iotcentral/resource-manager/readme.md
  • ️✔️azure-mgmt-iotcentral [View full logs]  [Release SDK Changes]
    cmderr	[buildConf] INFO:packaging_tools:Building template azure-mgmt-iotcentral
    cmderr	[buildConf] INFO:packaging_tools.conf:Skipping default conf since the file exists
    cmderr	[buildConf] INFO:packaging_tools:Skipping CHANGELOG.md template, since a previous one was found
    cmderr	[buildConf] INFO:packaging_tools:Template done azure-mgmt-iotcentral
    cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
    cmderr	[changelogReport] INFO:__main__:Looking for Autorest generated package in azure.mgmt.iotcentral
    cmderr	[changelogReport] INFO:__main__:Found azure.mgmt.iotcentral
    cmderr	[changelogReport] INFO:__main__:Working on azure.mgmt.iotcentral
    cmderr	[changelogReport] INFO:__main__:Report written to sdk/iothub/azure-mgmt-iotcentral/code_reports/latest/report.json
    cmderr	[changelogReportLatest] INFO:__main__:Download versions of azure-mgmt-iotcentral on PyPI
    cmderr	[changelogReportLatest] INFO:__main__:Got ['0.1.0', '0.2.0', '1.0.0', '2.0.0', '3.0.0', '3.1.0', '4.0.0']
    cmderr	[changelogReportLatest] INFO:__main__:Only keep last PyPI version
    cmderr	[changelogReportLatest] INFO:__main__:Installing version 4.0.0 of azure-mgmt-iotcentral in a venv
    cmderr	[changelogReportLatest] Cache entry deserialization failed, entry ignored
    cmderr	[changelogReportLatest] INFO:__main__:Looking for Autorest generated package in azure.mgmt.iotcentral
    cmderr	[changelogReportLatest] INFO:__main__:Found azure.mgmt.iotcentral
    cmderr	[changelogReportLatest] INFO:__main__:Working on azure.mgmt.iotcentral
    cmderr	[changelogReportLatest] INFO:__main__:Report written to sdk/iothub/azure-mgmt-iotcentral/code_reports/4.0.0/report.json
    cmdout	[Changelog] Size of delta 14.680% size of original (original: 7786 chars, delta: 1143 chars)
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 0237dcd. 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/iotcentral/resource-manager/readme.md
  • ️✔️@azure/arm-iotcentral [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/iotCentralClient.js → ./dist/arm-iotcentral.js...
    cmderr	[npmPack] created ./dist/arm-iotcentral.js in 185ms
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 0237dcd. 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
  • ️✔️iotcentral/mgmt/2018-09-01/iotcentral [View full logs]  [Release SDK Changes] Breaking Change Detected
    info	[Changelog] ## Breaking Changes
    info	[Changelog]
    info	[Changelog] - Field `AppTemplateName` of struct `AppTemplate` has been removed
    info	[Changelog]
    info	[Changelog] ## New Content
    info	[Changelog]
    info	[Changelog] - New field `Name` in struct `AppTemplate`
    info	[Changelog]
    info	[Changelog] Total 1 breaking change(s), 1 additive change(s).
    info	[Changelog]
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 0237dcd. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    cmderr	[generate.py] 2021-01-08 02:15:38 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-iotcentral"
    cmderr	[generate.py] 2021-01-08 02:15:38 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
    cmderr	[generate.py] 2021-01-08 02:15:38 INFO autorest --version=3.0.6350 --use=@autorest/java@4.0.8 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/iotcentral/azure-resourcemanager-iotcentral --java.namespace=com.azure.resourcemanager.iotcentral  --package-version=1.0.0-beta.1 --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/iotcentral/resource-manager/readme.md
    cmderr	[generate.py] 2021-01-08 02:16:17 INFO [CI][Success] Write to ci.yml
    cmderr	[generate.py] 2021-01-08 02:16:17 INFO [POM][Process] dealing with pom.xml
    cmderr	[generate.py] 2021-01-08 02:16:17 INFO [POM][Success] Write to pom.xml
    cmderr	[generate.py] 2021-01-08 02:16:17 INFO [POM][Process] dealing with root pom
    cmderr	[generate.py] 2021-01-08 02:16:17 ERROR [POM][Skip] find more than one <modules> in pom
    cmderr	[generate.py] 2021-01-08 02:16:26 ERROR [GENERATE] Maven build fail
  • ️✔️azure-resourcemanager-iotcentral [View full logs]  [Release SDK Changes]
    cmderr	[Inst] 2021-01-08 02:17:01 DEBUG Got artifact_id: azure-resourcemanager-iotcentral
    cmderr	[Inst] 2021-01-08 02:17:01 DEBUG Got artifact: pom.xml
    cmderr	[Inst] 2021-01-08 02:17:01 ERROR Unmatch any jar in artifacts
️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 0237dcd. Schema Automation 14.0.0
    warn	Skip initScript due to not configured
    command	npx n 12
    command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6320 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/iotcentral/resource-manager/readme.md
  • ️✔️iotcentral [View full logs]  [Release Schema Changes]
    cmderr	[resource-manager] node-pre-gyp
    cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
    cmderr	[resource-manager] npm WARN template-schema-validation-tools@1.0.0 No repository field.
    cmderr	[resource-manager] optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
    cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi, @poanchen 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-workflow-bot
    Copy link

    Hi @poanchen, 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.

    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @poanchen
    Copy link
    Member Author

    poanchen commented Jan 7, 2021

    There should be no breaking change here. This is to fix the S360 issue - R3021 PathResourceTypeNameCamelCase

    @poanchen
    Copy link
    Member Author

    poanchen commented Jan 7, 2021

    @weidongxu-microsoft please let us know what we need to do to close this issue. AFAIK, there isn't breaking change, just camel case fix for S360

    @weidongxu-microsoft weidongxu-microsoft added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 8, 2021
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Go
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants