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.Devices to add version stable/2020-03-01 #12427

Merged
merged 1 commit into from
Jul 8, 2021
Merged

[Hub Generated] Review request for Microsoft.Devices to add version stable/2020-03-01 #12427

merged 1 commit into from
Jul 8, 2021

Conversation

artemrd
Copy link
Member

@artemrd artemrd commented Jan 14, 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.
    May 2021
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
    June 2021
  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-workflow-bot
Copy link

Hi, @artemrd 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 Jan 14, 2021

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    1045 - AddedOptionalProperty The new version has a new optional property 'isVerified' that was not found in the old version.
    New: Microsoft.Devices/stable/2020-03-01/iotdps.json#L1656:7
    Old: Microsoft.Devices/stable/2020-03-01/iotdps.json#L1656:7
    ️⚠️LintDiff: 1 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isVerified
    Location: Microsoft.Devices/stable/2020-03-01/iotdps.json#L1661


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2020-03-01/iotdps.json#L64
    R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2020-03-01/iotdps.json#L135
    R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2020-03-01/iotdps.json#L208
    R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2020-03-01/iotdps.json#L349
    R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2020-03-01/iotdps.json#L400
    R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2020-03-01/iotdps.json#L471
    R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2020-03-01/iotdps.json#L596
    R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2020-03-01/iotdps.json#L650
    R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2020-03-01/iotdps.json#L687
    R4007 - DefaultErrorResponseSchema the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content.
    Location: Microsoft.Devices/stable/2020-03-01/iotdps.json#L737
    ️️✔️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] [Expand]
    Validation passes for SDKTrack2Validation

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"deviceprovisioningservices/resource-manager/readme.md",
    "tag":"package-2020-03",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"deviceprovisioningservices/resource-manager/readme.md",
    "tag":"package-2020-03",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: AutorestCore/Exception|"readme":"deviceprovisioningservices/resource-manager/readme.md",
    "tag":"package-2020-03",
    "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 Jan 14, 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-iothubprovisioningservices - 1.0.0b1
    ️✔️azure-sdk-for-go - provisioningservices/mgmt/2018-01-22/iothub - v55.2.0
    ️✔️azure-sdk-for-go - provisioningservices/mgmt/2017-11-15/iothub - v55.2.0
    ️✔️azure-sdk-for-go - preview/provisioningservices/mgmt/2017-08-21-preview/iothub - v55.2.0
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8730c1b. 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-07-08 08:11:49 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-deviceprovisioningservices;1.0.0;1.1.0-beta.1"
      cmderr	[generate.py] 2021-07-08 08:11:49 WARNING [VERSION][Not Implement] set to current version "1.1.0-beta.1" by default
      cmderr	[generate.py] 2021-07-08 08:11:49 INFO autorest --version=3.1.3 --use=@autorest/[email protected] --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/deviceprovisioningservices/azure-resourcemanager-deviceprovisioningservices --java.namespace=com.azure.resourcemanager.deviceprovisioningservices   --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/deviceprovisioningservices/resource-manager/readme.md
      cmderr	[generate.py] 2021-07-08 08:12:23 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-deviceprovisioningservices
      cmderr	[generate.py] 2021-07-08 08:12:23 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-07-08 08:12:23 INFO [POM][Skip] pom already has module azure-resourcemanager-deviceprovisioningservices
      cmderr	[generate.py] 2021-07-08 08:12:23 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-07-08 08:12:23 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-07-08 08:12:23 INFO [POM][Skip] pom already has module sdk/deviceprovisioningservices
      cmderr	[generate.py] 2021-07-08 08:12:23 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-deviceprovisioningservices [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-07-08 08:15:00 DEBUG Got artifact_id: azure-resourcemanager-deviceprovisioningservices
      cmderr	[Inst] 2021-07-08 08:15:00 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-07-08 08:15:00 DEBUG Got artifact: azure-resourcemanager-deviceprovisioningservices-1.1.0-beta.1-sources.jar
      cmderr	[Inst] 2021-07-08 08:15:00 DEBUG Got artifact: azure-resourcemanager-deviceprovisioningservices-1.1.0-beta.1-javadoc.jar
      cmderr	[Inst] 2021-07-08 08:15:00 DEBUG Got artifact: azure-resourcemanager-deviceprovisioningservices-1.1.0-beta.1.jar
      cmderr	[Inst] 2021-07-08 08:15:00 DEBUG Match jar package: azure-resourcemanager-deviceprovisioningservices-1.1.0-beta.1.jar
      cmderr	[Inst] 2021-07-08 08:15:00 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/12427/azure-sdk-for-java/azure-resourcemanager-deviceprovisioningservices/azure-resourcemanager-deviceprovisioningservices-1.1.0-beta.1.jar\" -o azure-resourcemanager-deviceprovisioningservices-1.1.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-deviceprovisioningservices -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-deviceprovisioningservices-1.1.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8730c1b. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️provisioningservices/mgmt/2018-01-22/iothub [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️provisioningservices/mgmt/2017-11-15/iothub [View full logs
      info	[Changelog] No exported changes
    • ️✔️preview/provisioningservices/mgmt/2017-08-21-preview/iothub [View full logs
      info	[Changelog] No exported changes
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8730c1b. 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/deviceprovisioningservices/resource-manager/readme.md
    • ️✔️@azure/arm-deviceprovisioningservices [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/iotDpsClient.js → ./dist/arm-deviceprovisioningservices.js...
      cmderr	[npmPack] created ./dist/arm-deviceprovisioningservices.js in 355ms
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 8730c1b. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh]
      cmderr	[initScript.sh]  The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh]  so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh]
      cmderr	[initScript.sh]  This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh]
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
    • ️✔️deviceprovisioningservices [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @artemrd
    Copy link
    Member Author

    artemrd commented Apr 29, 2021

    /azp run unifiedPipeline

    @azure-pipelines
    Copy link

    No pipelines are associated with this pull request.

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

    @artemrd
    Copy link
    Member Author

    artemrd commented Apr 29, 2021

    Is this a new requirement? It wasn't considered as a breaking change when this was submitted.

    @ghost
    Copy link

    ghost commented May 16, 2021

    Hi, @artemrd. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @artemrd
    Copy link
    Member Author

    artemrd commented Jun 9, 2021

    @openapi-workflow-bot
    Copy link

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

    @zhenglaizhang
    Copy link
    Contributor

    Hi @artemrd It seems that you have just started breaking change review process. Let's wait for the review result, others aspects of the PR LGTM.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jun 15, 2021
    @zhenglaizhang zhenglaizhang added Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 and removed Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 labels Jun 16, 2021
    @zhenglaizhang
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @jlian
    Copy link
    Member

    jlian commented Jun 29, 2021

    @zhenglaizhang can we merge this PR now that it has all the approval tags?

    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 Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants