[Hub Generated] Review request for Microsoft.SerialConsole to add version stable/2018-05-01 #12109

CraigWiand · 2020-12-14T21:34:54Z

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.

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
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.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
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
- 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 · 2020-12-14T21:34:58Z

Swagger Validation Report

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

There are no breaking changes.

️⚠️LintDiff: 2 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
- serialconsole/resource-manager/readme.md tag:package-2018-05
Linted configuring files (Based on target branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
- serialconsole/resource-manager/readme.md tag:package-2018-05

Rule	Message
⚠️ R2029 - PageableOperation	Based on the response model schema, operation 'SerialPorts_List' might be pageable. Consider adding the x-ms-pageable extension. New: Microsoft.SerialConsole/stable/2018-05-01/serialport.json#L38
⚠️ R2029 - PageableOperation	Based on the response model schema, operation 'SerialPorts_ListBySubscriptions' might be pageable. Consider adding the x-ms-pageable extension. New: Microsoft.SerialConsole/stable/2018-05-01/serialport.json#L256

️️✔️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 · 2020-12-14T21:34:59Z

Swagger Generation Artifacts

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

⚠️Warning [Logs]Release - Generate from ffc5119. 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/serialconsole/resource-manager/readme.md

⚠️azure-mgmt-serialconsole [View full logs] [Release SDK Changes]

cmderr	[buildConf] INFO:packaging_tools:Building template azure-mgmt-serialconsole
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-serialconsole
cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
cmderr	[changelogReport] INFO:__main__:Looking for Autorest generated package in azure.mgmt.serialconsole
cmderr	[changelogReport] INFO:__main__:Found azure.mgmt.serialconsole
cmderr	[changelogReport] INFO:__main__:Working on azure.mgmt.serialconsole
cmderr	[changelogReport] INFO:__main__:Report written to sdk/serialconsole/azure-mgmt-serialconsole/code_reports/latest/report.json
cmderr	[changelogReportLatest] INFO:__main__:Download versions of azure-mgmt-serialconsole on PyPI
cmderr	[changelogReportLatest] INFO:__main__:Got ['0.1.0', '1.0.0b1']
cmderr	[changelogReportLatest] INFO:__main__:Only keep last PyPI version
cmderr	[changelogReportLatest] INFO:__main__:Installing version 0.1.0 of azure-mgmt-serialconsole in a venv
cmderr	[changelogReportLatest] Cache entry deserialization failed, entry ignored
cmderr	[changelogReportLatest] INFO:__main__:Looking for Autorest generated package in azure.mgmt.serialconsole
cmderr	[changelogReportLatest] INFO:__main__:Found azure.mgmt.serialconsole
cmderr	[changelogReportLatest] INFO:__main__:Working on azure.mgmt.serialconsole
cmderr	[changelogReportLatest] INFO:__main__:Report written to sdk/serialconsole/azure-mgmt-serialconsole/code_reports/0.1.0/report.json
cmderr	[Changelog] Traceback (most recent call last):
cmderr	[Changelog]   File "/usr/lib/python3.6/runpy.py", line 193, in _run_module_as_main
cmderr	[Changelog]     "__main__", mod_spec)
cmderr	[Changelog]   File "/usr/lib/python3.6/runpy.py", line 85, in _run_code
cmderr	[Changelog]     exec(code, run_globals)
cmderr	[Changelog]   File "/home/vsts/work/1/s/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/change_log.py", line 200, in <module>
cmderr	[Changelog]     change_log = build_change_log(old_report, new_report)
cmderr	[Changelog]   File "/home/vsts/work/1/s/azure-sdk-for-python/tools/azure-sdk-tools/packaging_tools/change_log.py", line 146, in build_change_log
cmderr	[Changelog]     if diff_line[0][0] == "operations":
cmderr	[Changelog] IndexError: list index out of range
cmdout	[Changelog] Size of delta 100.104% size of original (original: 6727 chars, delta: 6734 chars)
warn	Script return with result [warning] code [1] signal [null] cwd [azure-sdk-for-python/sdk/serialconsole/azure-mgmt-serialconsole]: python

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

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

️✔️serialconsole/mgmt/2018-05-01/serialconsole [View full logs] [Release SDK Changes]

info	[Changelog] ## New Content
info	[Changelog]
info	[Changelog] - New const `Disabled`
info	[Changelog] - New const `Enabled`
info	[Changelog] - New function `SerialPortsClient.CreatePreparer(context.Context, string, string, string, string, string, SerialPort) (*http.Request, error)`
info	[Changelog] - New function `NewSerialPortsClient(string) SerialPortsClient`
info	[Changelog] - New function `PossibleSerialPortStateValues() []SerialPortState`
info	[Changelog] - New function `SerialPortsClient.ConnectPreparer(context.Context, string, string, string, string, string) (*http.Request, error)`
info	[Changelog] - New function `SerialPortsClient.CreateSender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `SerialPortsClient.DeletePreparer(context.Context, string, string, string, string, string) (*http.Request, error)`
info	[Changelog] - New function `SerialPortsClient.Create(context.Context, string, string, string, string, string, SerialPort) (SerialPort, error)`
info	[Changelog] - New function `SerialPortsClient.GetSender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `SerialPortsClient.ListResponder(*http.Response) (SerialPortListResult, error)`
info	[Changelog] - New function `SerialPort.MarshalJSON() ([]byte, error)`
info	[Changelog] - New function `SerialPortsClient.GetPreparer(context.Context, string, string, string, string, string) (*http.Request, error)`
info	[Changelog] - New function `SerialPortsClient.ListBySubscriptionsPreparer(context.Context) (*http.Request, error)`
info	[Changelog] - New function `SerialPortsClient.List(context.Context, string, string, string, string) (SerialPortListResult, error)`
info	[Changelog] - New function `SerialPortsClient.DeleteResponder(*http.Response) (autorest.Response, error)`
info	[Changelog] - New function `SerialPortsClient.ListPreparer(context.Context, string, string, string, string) (*http.Request, error)`
info	[Changelog] - New function `SerialPortsClient.Get(context.Context, string, string, string, string, string) (SerialPort, error)`
info	[Changelog] - New function `SerialPortsClient.ListSender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `SerialPortsClient.ConnectResponder(*http.Response) (SerialPortConnectResult, error)`
info	[Changelog] - New function `SerialPortsClient.Delete(context.Context, string, string, string, string, string) (autorest.Response, error)`
info	[Changelog] - New function `SerialPortsClient.DeleteSender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `SerialPortsClient.GetResponder(*http.Response) (SerialPort, error)`
info	[Changelog] - New function `SerialPortsClient.CreateResponder(*http.Response) (SerialPort, error)`
info	[Changelog] - New function `*SerialPort.UnmarshalJSON([]byte) error`
info	[Changelog] - New function `NewSerialPortsClientWithBaseURI(string, string) SerialPortsClient`
info	[Changelog] - New function `SerialPortsClient.ConnectSender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `SerialPortsClient.ListBySubscriptionsResponder(*http.Response) (SerialPortListResult, error)`
info	[Changelog] - New function `SerialPortsClient.ListBySubscriptionsSender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `SerialPortsClient.Connect(context.Context, string, string, string, string, string) (SerialPortConnectResult, error)`
info	[Changelog] - New function `SerialPortsClient.ListBySubscriptions(context.Context) (SerialPortListResult, error)`
info	[Changelog] - New struct `CloudError`
info	[Changelog] - New struct `CloudErrorBody`
info	[Changelog] - New struct `ProxyResource`
info	[Changelog] - New struct `Resource`
info	[Changelog] - New struct `SerialPort`
info	[Changelog] - New struct `SerialPortConnectResult`
info	[Changelog] - New struct `SerialPortListResult`
info	[Changelog] - New struct `SerialPortProperties`
info	[Changelog] - New struct `SerialPortsClient`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 49 additive change(s).
info	[Changelog]

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

️✔️Succeeded [Logs]Release - Generate from ffc5119. 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/serialconsole/resource-manager/readme.md

️✔️@azure/arm-serialconsole [View full logs] [Release SDK Changes]

azure-arm-serialconsole-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/microsoftSerialConsoleClient.js → ./dist/arm-serialconsole.js...
cmderr	[npmPack] created ./dist/arm-serialconsole.js in 177ms

️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from ffc5119. 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/serialconsole/resource-manager/readme.md

️✔️serialconsole [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]  [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"})

️️✔️[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 · 2020-12-15T00:38:03Z

Hi, @CraigWiand 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-workflow-bot · 2020-12-15T00:38:05Z

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

pilor

No real changes from serialPorts API here: https://github.com/Azure/azure-rest-api-specs-pr/pull/1387

ghost · 2021-01-03T16:00:59Z

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

jianyexi · 2021-01-04T05:42:38Z

@CraigWiand strongly recommend you to lint warning ⚠️ R4030 - UniqueXmsExample , it will cause the test case auto-generate fail

openapi-workflow-bot · 2021-01-06T03:04:17Z

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.

openapi-workflow-bot · 2021-01-07T02:32:36Z

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

CraigWiand · 2021-01-07T14:56:33Z

Created VSTS 9076196: Azure Serial Console - serialPorts api-version with breaking change template to track this change

…t.SerialConsole to add version stable/2018-05-01 (#1456) Create to sync Azure/azure-rest-api-specs#12109 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/master...AzureSDKAutomation:sdkAuto/serialconsole?expand=1)

CraigWiand added 2 commits December 14, 2020 16:00

add serialPort operations

138b0dc

linting fixes

ea75bfe

openapi-pipeline-app bot added the CI-BreakingChange-Python label Dec 14, 2020

CraigWiand marked this pull request as ready for review December 15, 2020 00:29

CraigWiand requested a review from lirenhe as a code owner December 15, 2020 00:29

openapi-assignment-bot bot assigned jianyexi Dec 15, 2020

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 15, 2020

fixing whitespacing for prettier check failure

e8e1bb9

pilor self-requested a review December 17, 2020 20:27

pilor added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Dec 17, 2020

pilor approved these changes Dec 17, 2020

View reviewed changes

ghost added the no-recent-activity label Jan 3, 2021

fix to example naming

7426604

ghost removed the no-recent-activity label Jan 4, 2021

openapi-pipeline-app bot removed the CI-BreakingChange-Python label Jan 4, 2021

lirenhe added the NewApiVersionRequired label Jan 6, 2021

akning-ms added BreakingChangeReviewRequired and removed NewApiVersionRequired labels Jan 7, 2021

JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 7, 2021

JeffreyRichter approved these changes Jan 7, 2021

View reviewed changes

lirenhe approved these changes Jan 7, 2021

View reviewed changes

jianyexi merged commit ffc5119 into Azure:master Jan 11, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Hub Generated] Review request for Microsoft.SerialConsole to add version stable/2018-05-01 #12109

[Hub Generated] Review request for Microsoft.SerialConsole to add version stable/2018-05-01 #12109

CraigWiand commented Dec 14, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 14, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 14, 2020 •

edited

Loading

openapi-workflow-bot bot commented Dec 15, 2020

openapi-workflow-bot bot commented Dec 15, 2020

pilor left a comment

ghost commented Jan 3, 2021

jianyexi commented Jan 4, 2021

openapi-workflow-bot bot commented Jan 6, 2021

openapi-workflow-bot bot commented Jan 7, 2021

CraigWiand commented Jan 7, 2021

[Hub Generated] Review request for Microsoft.SerialConsole to add version stable/2018-05-01 #12109

[Hub Generated] Review request for Microsoft.SerialConsole to add version stable/2018-05-01 #12109

Conversation

CraigWiand commented Dec 14, 2020 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-pipeline-app bot commented Dec 14, 2020 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Dec 14, 2020 • edited Loading

Swagger Generation Artifacts

openapi-workflow-bot bot commented Dec 15, 2020

openapi-workflow-bot bot commented Dec 15, 2020

pilor left a comment

Choose a reason for hiding this comment

ghost commented Jan 3, 2021

jianyexi commented Jan 4, 2021

openapi-workflow-bot bot commented Jan 6, 2021

openapi-workflow-bot bot commented Jan 7, 2021

CraigWiand commented Jan 7, 2021

CraigWiand commented Dec 14, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 14, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 14, 2020 •

edited

Loading