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 preview/2020-09-01-preview #12036

Conversation

mrohera
Copy link
Member

@mrohera mrohera commented Dec 9, 2020

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 Dec 9, 2020

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌LintDiff: 1 Errors, 0 Warnings failed [Detail]
Rule Message
AutoRest Exception "details":" "Channel": "fatal",
"Text": "swagger-document/compose - FAILED" "Channel": "fatal",
"Text": "Error: '$.paths[\"/providers/Microsoft.Devices/operations\"].get[\"x-ms-examples\"].DPSOperations.parameters[\"api-version\"]' has incompatible values (---\n2020-09-01-preview.1\n,
---\n2020-09-01-preview\n)."(node:6131) UnhandledPromiseRejectionWarning: Error: '$.paths["/providers/Microsoft.Devices/operations"].get["x-ms-examples"].DPSOperations.parameters["api-version"]' has incompatible values (---2020-09-01-preview.1",
"location":"https://github.com/Azure/azure-rest-api-specs/blob/142d1081a79b733c0c9acd7f2ff5db27057cd3f4/specification/deviceprovisioningservices/resource-manager/readme.md"
️❌Avocado: 25 Errors, 0 Warnings failed [Detail] Only 10 items are listed, please refer to log for more details.
Rule Message
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/deviceprovisioningservices/resource-manager/readme.md
json: preview/2020-09-01-preview.1/examples/DPSCertificateCreateOrUpdate.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/deviceprovisioningservices/resource-manager/readme.md
json: preview/2020-09-01-preview.1/examples/DPSCheckNameAvailability.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/deviceprovisioningservices/resource-manager/readme.md
json: preview/2020-09-01-preview.1/examples/DPSCreate.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/deviceprovisioningservices/resource-manager/readme.md
json: preview/2020-09-01-preview.1/examples/DPSCreateOrUpdatePrivateEndpointConnection.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/deviceprovisioningservices/resource-manager/readme.md
json: preview/2020-09-01-preview.1/examples/DPSDelete.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/deviceprovisioningservices/resource-manager/readme.md
json: preview/2020-09-01-preview.1/examples/DPSDeleteCertificate.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/deviceprovisioningservices/resource-manager/readme.md
json: preview/2020-09-01-preview.1/examples/DPSDeletePrivateEndpointConnection.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/deviceprovisioningservices/resource-manager/readme.md
json: preview/2020-09-01-preview.1/examples/DPSGenerateVerificationCode.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/deviceprovisioningservices/resource-manager/readme.md
json: preview/2020-09-01-preview.1/examples/DPSGet.json
UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
readme: specification/deviceprovisioningservices/resource-manager/readme.md
json: preview/2020-09-01-preview.1/examples/DPSGetCertificate.json
️️✔️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.

Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Dec 9, 2020

Swagger Generation Artifacts

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
 Please click here to preview with your @microsoft account. 
️❌ azure-sdk-for-net failed [Detail]
  • Failed [Logs] Generate from 6b9fddf6dfc67b5f8ab92076c87306b1da588c15. 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 [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/deviceprovisioningservices/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
    cmderr	[Autorest] FATAL: swagger-document/compose - FAILED
    cmderr	[Autorest] FATAL: Error: '$.paths["/providers/Microsoft.Devices/operations"].get["x-ms-examples"].DPSOperations.parameters["api-version"]' has incompatible values (---
    cmderr	[Autorest] 2020-09-01-preview.1
    cmderr	[Autorest] , ---
    cmderr	[Autorest] 2020-09-01-preview
    cmderr	[Autorest] ).
    cmderr	[Autorest]   Error: '$.paths["/providers/Microsoft.Devices/operations"].get["x-ms-examples"].DPSOperations.parameters["api-version"]' has incompatible values (---
    cmderr	[Autorest] 2020-09-01-preview.1
    cmderr	[Autorest] , ---
    cmderr	[Autorest] 2020-09-01-preview
    cmderr	[Autorest] ).
    error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
    warn	Skip package processing as generation is failed
️❌ azure-sdk-for-python failed [Detail]
  • Failed [Logs] Generate from 6b9fddf6dfc67b5f8ab92076c87306b1da588c15. 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 [email protected]/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/deviceprovisioningservices/resource-manager/readme.md
    cmderr	[Autorest] FATAL: swagger-document/compose - FAILED
    cmderr	[Autorest] FATAL: Error: '$.paths["/providers/Microsoft.Devices/operations"].get["x-ms-examples"].DPSOperations.parameters["api-version"]' has incompatible values (---
    cmderr	[Autorest] 2020-09-01-preview.1
    cmderr	[Autorest] , ---
    cmderr	[Autorest] 2020-09-01-preview
    cmderr	[Autorest] ).
    cmderr	[Autorest]   Error: '$.paths["/providers/Microsoft.Devices/operations"].get["x-ms-examples"].DPSOperations.parameters["api-version"]' has incompatible values (---
    cmderr	[Autorest] 2020-09-01-preview.1
    cmderr	[Autorest] , ---
    cmderr	[Autorest] 2020-09-01-preview
    cmderr	[Autorest] ).
    error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: autorest
    warn	Skip package processing as generation is failed
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs] Generate from 6b9fddf6dfc67b5f8ab92076c87306b1da588c15. 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] 2020-12-10 07:29:39 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-deviceprovisioningservices"
    cmderr	[generate.py] 2020-12-10 07:29:39 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
    cmderr	[generate.py] 2020-12-10 07:29:39 INFO autorest --version=3.0.6327 --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  --package-version=1.0.0-beta.1 --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --pipeline.modelerfour.flatten-payloads=false --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] 2020-12-10 07:30:18 INFO [CI][Success] Write to ci.yml
    cmderr	[generate.py] 2020-12-10 07:30:18 INFO [POM][Process] dealing with pom.xml
    cmderr	[generate.py] 2020-12-10 07:30:18 INFO [POM][Success] Write to pom.xml
    cmderr	[generate.py] 2020-12-10 07:30:18 INFO [POM][Process] dealing with root pom
    cmderr	[generate.py] 2020-12-10 07:30:18 INFO [POM][Success] Write to root pom
    cmderr	[generate.py] 2020-12-10 07:30:41 ERROR [GENERATE] Maven build fail
  • ️✔️azure-resourcemanager-deviceprovisioningservices [View full logs]  [Preview SDK Changes]
    cmderr	[Inst] 2020-12-10 07:31:24 DEBUG Got artifact_id: azure-resourcemanager-deviceprovisioningservices
    cmderr	[Inst] 2020-12-10 07:31:24 DEBUG Got artifact: pom.xml
    cmderr	[Inst] 2020-12-10 07:31:24 ERROR Unmatch any jar in artifacts
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 6b9fddf6dfc67b5f8ab92076c87306b1da588c15. 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
  • ️✔️provisioningservices/mgmt/2018-01-22/iothub [View full logs]  [Preview SDK Changes]
    info	[Changelog] No exported changes
  • ️✔️provisioningservices/mgmt/2017-11-15/iothub [View full logs]  [Preview SDK Changes]
    info	[Changelog] No exported changes
  • ️✔️preview/provisioningservices/mgmt/2017-08-21-preview/iothub [View full logs]  [Preview SDK Changes]
    info	[Changelog] No exported changes
️❌ azure-sdk-for-js failed [Detail]
  • Failed [Logs] Generate from 6b9fddf6dfc67b5f8ab92076c87306b1da588c15. 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
    cmderr	[Autorest] FATAL: swagger-document/compose - FAILED
    cmderr	[Autorest] FATAL: Error: '$.paths["/providers/Microsoft.Devices/operations"].get["x-ms-examples"].DPSOperations.parameters["api-version"]' has incompatible values (---
    cmderr	[Autorest] 2020-09-01-preview.1
    cmderr	[Autorest] , ---
    cmderr	[Autorest] 2020-09-01-preview
    cmderr	[Autorest] ).
    cmderr	[Autorest]   Error: '$.paths["/providers/Microsoft.Devices/operations"].get["x-ms-examples"].DPSOperations.parameters["api-version"]' has incompatible values (---
    cmderr	[Autorest] 2020-09-01-preview.1
    cmderr	[Autorest] , ---
    cmderr	[Autorest] 2020-09-01-preview
    cmderr	[Autorest] ).
    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-resource-manager-schemas succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from 6b9fddf6dfc67b5f8ab92076c87306b1da588c15. Schema Automation 14.0.0
    warn	Skip initScript due to not configured
    command	npx n 12
    command	autorest --use=@autorest/[email protected] --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/deviceprovisioningservices/resource-manager/readme.md
  • ️✔️deviceprovisioningservices [View full logs]  [Preview Schema Changes]
    cmderr	[resource-manager] node-pre-gyp
    cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
    cmderr	[resource-manager] WARN [email protected] No repository field.
    cmderr	[resource-manager] optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/fsevents):
    cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    cmderr	[resource-manager]  ERR! code ELIFECYCLE
    cmderr	[resource-manager] npm ERR! errno 31
    cmderr	[resource-manager] npm ERR! [email protected] test: `mocha -r ts-node/register tests.ts`
    cmderr	[resource-manager] npm ERR! Exit status 31
    cmderr	[resource-manager] npm ERR!
    cmderr	[resource-manager] npm ERR! Failed at the [email protected] test script.
    cmderr	[resource-manager] npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
    cmderr	[resource-manager] npm ERR! A complete log of this run can be found in:
    cmderr	[resource-manager] npm ERR!     /home/vsts/.npm/_logs/2020-12-10T07_29_30_780Z-debug.log
    cmderr	[resource-manager] Error: Command failed: npm run test --prefix tools
    cmderr	[resource-manager]     at checkExecSyncError (child_process.js:635:11)
    cmderr	[resource-manager]     at Object.execSync (child_process.js:671:15)
    cmderr	[resource-manager]     at Object.<anonymous> (/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas/sdkauto_afterscript.js:13:28)
    cmderr	[resource-manager]     at Module._compile (internal/modules/cjs/loader.js:999:30)
    cmderr	[resource-manager]     at Object.Module._extensions..js (internal/modules/cjs/loader.js:1027:10)
    cmderr	[resource-manager]     at Module.load (internal/modules/cjs/loader.js:863:32)
    cmderr	[resource-manager]     at Function.Module._load (internal/modules/cjs/loader.js:708:14)
    cmderr	[resource-manager]     at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:60:12)
    cmderr	[resource-manager]     at internal/main/run_main_module.js:17:47 {
    cmderr	[resource-manager]   status: 31,
    cmderr	[resource-manager]   signal: null,
    cmderr	[resource-manager]   output: [ null, null, null ],
    cmderr	[resource-manager]   pid: 3062,
    cmderr	[resource-manager]   stdout: null,
    cmderr	[resource-manager]   stderr: null
    cmderr	[resource-manager] }
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi, @mrohera your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @raych1

@mrohera
Copy link
Member Author

mrohera commented Dec 9, 2020

@akning-ms copying you here since you have context.

@openapi-workflow-bot
Copy link

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

    @raych1
    Copy link
    Member

    raych1 commented Dec 10, 2020

    @mrohera , could you fix the CI check failures? Please starts from avocado errors.

    @raych1 raych1 added the Reviewed-ChangesRequested <valid label in PR review process>add this label when assignee request changes after review label Dec 10, 2020
    @mrohera
    Copy link
    Member Author

    mrohera commented Dec 10, 2020

    @akning-ms are these errors due to the recommended versioning pattern that is not supported?

    @akning-ms
    Copy link
    Contributor

    akning-ms commented Dec 10, 2020

    @akning-ms are these errors due to the recommended versioning pattern that is not supported?

    No, it is due to your PR still change for /preview/2020-09-01-preview/iotdps.json. it should be /preview/2020-09-01-preview.1/iotdps.json

    @mrohera
    Copy link
    Member Author

    mrohera commented Dec 10, 2020

    Thanks @akning-ms, I've fixed it. I accidentally updated the wrong file.

    @mrohera
    Copy link
    Member Author

    mrohera commented Dec 10, 2020

    @akning-ms please have a look now and let me know if these failures are expected?

    @akning-ms
    Copy link
    Contributor

    @akning-ms please have a look now and let me know if these failures are expected?

    The avocado error is still there, you need to also remove /preview/2020-09-01-preview/iotdps.json from PR to fix it.

    @akning-ms akning-ms removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 10, 2020
    @akning-ms
    Copy link
    Contributor

    ARM review is not required as it is just add optional properties as this PR #11809

    @akning-ms
    Copy link
    Contributor

    Looks ARM still not support new version format which still in progress. The PR will hold until ARM support. will update this in breaking change intake form.

    @ghost
    Copy link

    ghost commented Dec 27, 2020

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

    @ghost ghost added the no-recent-activity label Dec 27, 2020
    @mrohera
    Copy link
    Member Author

    mrohera commented Dec 28, 2020

    Closing PR since this style of API versioning is unsupported.

    @mrohera mrohera closed this Dec 28, 2020
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Reviewed-ChangesRequested <valid label in PR review process>add this label when assignee request changes after review
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants