refine readme.go.md #13906

chenjianfei2017 · 2021-04-13T05:49:07Z

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.

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
- 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 · 2021-04-13T05:49:10Z

Hi, @chenjianfei2017 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 · 2021-04-13T05:49:11Z

Swagger Validation Report

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

There are no breaking changes.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

️⚠️Avocado: 1 Warnings warning [Detail]

Rule	Message
⚠️ MULTIPLE_API_VERSION	The default tag contains multiple API versions swaggers. readme: specification/streamanalytics/resource-manager/readme.md tag: specification/streamanalytics/resource-manager/readme.md#tag-package-2020-03-preview

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Cross Version BreakingChange (Base on stable version) 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.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2021-04-13T05:49:11Z

[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 · 2021-04-13T05:49:12Z

Swagger Generation Artifacts

️❌ azure-sdk-for-go failed [Detail]

❌Failed [Logs]Release - Generate from 2493fb5. 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
cmderr	[main.go] [ERROR] cannot open file /home/vsts/work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/services/classic/management/affinitygroup/CHANGELOG.md: open /home/vsts/work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/services/classic/management/affinitygroup/CHANGELOG.md: no such file or directory
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: go run ./tools/generator/main.go
warn	Skip package processing as generation is failed

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

⚠️Warning [Logs]Release - Generate from 2493fb5. 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/streamanalytics/resource-manager/readme.md
warn	No file changes detected after generation
warn	No package detected after generation

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

️✔️Succeeded [Logs]Release - Generate from 2493fb5. 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/streamanalytics/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.StreamAnalytics [View full logs] [Release SDK Changes]
- Microsoft.Azure.Management.StreamAnalytics.3.0.0-preview.nupkg
- Microsoft.Azure.Management.StreamAnalytics.3.0.0-preview.snupkg

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

⚠️Warning [Logs]Release - Generate from 2493fb5. 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] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

️✔️track2_azure-mgmt-streamanalytics [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Added operation FunctionsOperations.test
info	[Changelog]   - Added operation PrivateEndpointsOperations.delete
info	[Changelog]   - Added operation OutputsOperations.test
info	[Changelog]   - Added operation ClustersOperations.delete
info	[Changelog]   - Added operation ClustersOperations.create_or_update
info	[Changelog]   - Added operation ClustersOperations.update
info	[Changelog]   - Added operation InputsOperations.test
info	[Changelog]   - Added operation StreamingJobsOperations.delete
info	[Changelog]   - Added operation StreamingJobsOperations.stop
info	[Changelog]   - Added operation StreamingJobsOperations.start
info	[Changelog]   - Added operation StreamingJobsOperations.create_or_replace
info	[Changelog]
info	[Changelog] **Breaking changes**
info	[Changelog]
info	[Changelog]   - Operation PrivateEndpointsOperations.create_or_update has a new signature
info	[Changelog]   - Operation TransformationsOperations.get has a new signature
info	[Changelog]   - Operation SubscriptionsOperations.list_quotas has a new signature
info	[Changelog]   - Operation StreamingJobsOperations.list_by_resource_group has a new signature
info	[Changelog]   - Operation StreamingJobsOperations.list has a new signature
info	[Changelog]   - Operation StreamingJobsOperations.get has a new signature
info	[Changelog]   - Operation PrivateEndpointsOperations.list_by_cluster has a new signature
info	[Changelog]   - Operation PrivateEndpointsOperations.get has a new signature
info	[Changelog]   - Operation PrivateEndpointsOperations.create_or_update has a new signature
info	[Changelog]   - Operation OutputsOperations.list_by_streaming_job has a new signature
info	[Changelog]   - Operation OutputsOperations.get has a new signature
info	[Changelog]   - Operation OutputsOperations.delete has a new signature
info	[Changelog]   - Operation InputsOperations.list_by_streaming_job has a new signature
info	[Changelog]   - Operation InputsOperations.get has a new signature
info	[Changelog]   - Operation InputsOperations.delete has a new signature
info	[Changelog]   - Operation FunctionsOperations.retrieve_default_definition has a new signature
info	[Changelog]   - Operation FunctionsOperations.list_by_streaming_job has a new signature
info	[Changelog]   - Operation FunctionsOperations.get has a new signature
info	[Changelog]   - Operation FunctionsOperations.delete has a new signature
info	[Changelog]   - Operation ClustersOperations.list_streaming_jobs has a new signature
info	[Changelog]   - Operation ClustersOperations.list_by_resource_group has a new signature
info	[Changelog]   - Operation ClustersOperations.get has a new signature
info	[Changelog]   - Operation Operations.list has a new signature
info	[Changelog]   - Operation FunctionsOperations.create_or_replace has a new signature
info	[Changelog]   - Operation FunctionsOperations.update has a new signature
info	[Changelog]   - Operation OutputsOperations.create_or_replace has a new signature
info	[Changelog]   - Operation OutputsOperations.update has a new signature
info	[Changelog]   - Operation ClustersOperations.list_by_subscription has a new signature
info	[Changelog]   - Operation TransformationsOperations.update has a new signature
info	[Changelog]   - Operation TransformationsOperations.create_or_replace has a new signature
info	[Changelog]   - Operation InputsOperations.create_or_replace has a new signature
info	[Changelog]   - Operation InputsOperations.update has a new signature
info	[Changelog]   - Operation StreamingJobsOperations.update has a new signature
info	[Changelog]   - Removed operation FunctionsOperations.begin_test
info	[Changelog]   - Removed operation PrivateEndpointsOperations.begin_delete
info	[Changelog]   - Removed operation OutputsOperations.begin_test
info	[Changelog]   - Removed operation ClustersOperations.begin_create_or_update
info	[Changelog]   - Removed operation ClustersOperations.begin_update
info	[Changelog]   - Removed operation ClustersOperations.begin_delete
info	[Changelog]   - Removed operation InputsOperations.begin_test
info	[Changelog]   - Removed operation StreamingJobsOperations.begin_delete
info	[Changelog]   - Removed operation StreamingJobsOperations.begin_stop
info	[Changelog]   - Removed operation StreamingJobsOperations.begin_create_or_replace
info	[Changelog]   - Removed operation StreamingJobsOperations.begin_start

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from 2493fb5. 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]  WARN read-shrinkwrap This version of npm is compatible with lockfileVersion@1, but package-lock.json was generated for lockfileVersion@2. I'll try to do my best with it!
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
warn	No file changes detected after generation

️✔️streamanalytics [View full logs] [Release Schema Changes]

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

⚠️Warning [Logs]Release - Generate from 2493fb5. 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.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json

️✔️track2_azure-mgmt-streamanalytics [View full logs] [Release SDK Changes]
- azure-mgmt-streamanalytics-1.0.0rc1.zip
- azure_mgmt_streamanalytics-1.0.0rc1-py2.py3-none-any.whl
```
info	[Changelog]
```

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

_{Posted by Swagger Pipeline | How to fix these errors?}

refine readme.go.md

2cdcf09

chenjianfei2017 requested a review from ArcturusZhang as a code owner April 13, 2021 05:49

openapi-assignment-bot bot assigned raych1 Apr 13, 2021

chenjianfei2017 requested a review from zhenglaizhang April 13, 2021 05:49

This was referenced Apr 13, 2021

[AutoPR streamanalytics] refine readme.go.md AzureSDKAutomation/azure-resource-manager-schemas#2447

Closed

[AutoPR azure-mgmt-streamanalytics] refine readme.go.md AzureSDKAutomation/azure-sdk-for-python#5094

Draft

openapi-pipeline-app bot added the CI-BreakingChange-Python label Apr 13, 2021

This was referenced Apr 13, 2021

[AutoPR track2_azure-mgmt-streamanalytics] refine readme.go.md AzureSDKAutomation/azure-sdk-for-python#5095

Closed

[AutoPR Microsoft.Azure.Management.StreamAnalytics] refine readme.go.md AzureSDKAutomation/azure-sdk-for-net#3886

Closed

raych1 assigned zhenglaizhang and unassigned raych1 Apr 14, 2021

zhenglaizhang approved these changes Apr 14, 2021

View reviewed changes

zhenglaizhang merged commit 2493fb5 into master Apr 14, 2021

JackTn deleted the stream branch August 17, 2021 06:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

refine readme.go.md #13906

refine readme.go.md #13906

Uh oh!

chenjianfei2017 commented Apr 13, 2021

Uh oh!

openapi-workflow-bot bot commented Apr 13, 2021

Uh oh!

openapi-pipeline-app bot commented Apr 13, 2021 •

edited

Loading

Uh oh!

openapi-workflow-bot bot commented Apr 13, 2021

Uh oh!

openapi-pipeline-app bot commented Apr 13, 2021 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

refine readme.go.md #13906

refine readme.go.md #13906

Uh oh!

Conversation

chenjianfei2017 commented Apr 13, 2021

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot bot commented Apr 13, 2021

Uh oh!

openapi-pipeline-app bot commented Apr 13, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-workflow-bot bot commented Apr 13, 2021

Uh oh!

openapi-pipeline-app bot commented Apr 13, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

openapi-pipeline-app bot commented Apr 13, 2021 •

edited

Loading

openapi-pipeline-app bot commented Apr 13, 2021 •

edited

Loading