Webpubsub 2021-06-01-preview #14868

bjqian · 2021-06-17T07:04:53Z

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.
2021.6
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
2021.6
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-06-17T07:04:55Z

Hi, @bjqian 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 · 2021-06-17T07:04:56Z

[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-06-17T07:04:56Z

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.10.0 , classic-openapi-validator v1.1.8 )
- webpubsub/resource-manager/readme.md tag:package-2021-06-01-preview
Linted configuring files (Based on target branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
- webpubsub/resource-manager/readme.md tag:default

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: disableLocalAuth Location: Microsoft.SignalRService/preview/2021-06-01-preview/webpubsub.json#L2048
⚠️ R3018 - EnumInsteadOfBoolean	Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableAadAuth Location: Microsoft.SignalRService/preview/2021-06-01-preview/webpubsub.json#L2053

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R4014 - AllResourcesMustHaveGetOperation	The resource 'PrivateLinkResource' does not have get operation, please add it. Location: Microsoft.SignalRService/preview/2021-06-01-preview/webpubsub.json#L1458

️️✔️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: 1 Errors, 0 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.8.11)
- current:preview/2021-06-01-preview/webpubsub.json compared with base:preview/2021-04-01-preview/webpubsub.json

The following breaking changes are detected by comparison with latest preview version:

Rule	Message
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'features' renamed or removed? New: Microsoft.SignalRService/preview/2021-06-01-preview/webpubsub.json#L1978:7 Old: Microsoft.SignalRService/preview/2021-04-01-preview/webpubsub.json#L1984:7

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]

Validation passes for SDKTrack2Validation

The following tags are being changed in this PR

webpubsub/resource-manager/readme.md#package-2021-06-01-preview

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"webpubsub/resource-manager/readme.md",
"tag":"package-2021-06-01-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"webpubsub/resource-manager/readme.md",
"tag":"package-2021-06-01-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"webpubsub/resource-manager/readme.md",
"tag":"package-2021-06-01-preview",
"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 · 2021-06-17T07:04:57Z

Swagger Generation Artifacts

️🔄[Staging] ApiDocPreview inProgress [Detail]

️❌[Staging] SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking

️✔️azure-sdk-for-go - preview/webpubsub/mgmt/2021-06-01-preview/webpubsub - v55.3.0
️✔️azure-sdk-for-go - preview/webpubsub/mgmt/2021-04-01-preview/webpubsub - v55.3.0
❌azure-sdk-for-python-track2 - track2_azure-mgmt-webpubsub - 1.0.0b1

+	Model WebPubSubResource no longer has parameter features

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

️✔️Succeeded [Logs]Release - Generate from 0c05756. 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/webpubsub/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.WebPubSub [View full logs] [Release SDK Changes]
```
warn	Skip artifact folder because it doesn't exist: artifacts/packages
```

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

⚠️Warning [Logs]Release - Generate from 0c05756. 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-webpubsub [View full logs] [Release SDK Changes] Breaking Change Detected

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Model WebPubSubResource has a new parameter disable_local_auth
info	[Changelog]   - Model WebPubSubResource has a new parameter diagnostic_configuration
info	[Changelog]   - Model WebPubSubResource has a new parameter disable_aad_auth
info	[Changelog]
info	[Changelog] **Breaking changes**
info	[Changelog]
info	[Changelog]   - Model WebPubSubResource no longer has parameter features

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

⚠️Warning [Logs]Release - Generate from 0c05756. 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-06-21 02:56:02 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-webpubsub"
cmderr	[generate.py] 2021-06-21 02:56:02 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-06-21 02:56:02 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.30 --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/webpubsub/azure-resourcemanager-webpubsub --java.namespace=com.azure.resourcemanager.webpubsub   --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/webpubsub/resource-manager/readme.md
cmderr	[generate.py] 2021-06-21 02:56:39 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-06-21 02:56:39 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-06-21 02:56:39 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-06-21 02:56:39 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-06-21 02:56:39 INFO [POM][Skip] pom already has module sdk/webpubsub
cmderr	[generate.py] 2021-06-21 02:56:39 INFO [POM][Success] Write to root pom

️✔️azure-resourcemanager-webpubsub [View full logs] [Release SDK Changes]

cmderr	[Inst] 2021-06-21 02:59:17 DEBUG Got artifact_id: azure-resourcemanager-webpubsub
cmderr	[Inst] 2021-06-21 02:59:17 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-06-21 02:59:17 DEBUG Got artifact: azure-resourcemanager-webpubsub-1.0.0-beta.1-sources.jar
cmderr	[Inst] 2021-06-21 02:59:17 DEBUG Got artifact: azure-resourcemanager-webpubsub-1.0.0-beta.1-javadoc.jar
cmderr	[Inst] 2021-06-21 02:59:17 DEBUG Got artifact: azure-resourcemanager-webpubsub-1.0.0-beta.1.jar
cmderr	[Inst] 2021-06-21 02:59:17 DEBUG Match jar package: azure-resourcemanager-webpubsub-1.0.0-beta.1.jar
cmderr	[Inst] 2021-06-21 02:59:17 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14868/azure-sdk-for-java/azure-resourcemanager-webpubsub/azure-resourcemanager-webpubsub-1.0.0-beta.1.jar\" -o azure-resourcemanager-webpubsub-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-webpubsub -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-webpubsub-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
```"}

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

️✔️Succeeded [Logs]Release - Generate from 0c05756. 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.7.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/webpubsub/resource-manager/readme.md

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

azure-arm-webpubsub-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/webPubSubManagementClient.js → ./dist/arm-webpubsub.js...
cmderr	[npmPack] created ./dist/arm-webpubsub.js in 368ms

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

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

️✔️preview/webpubsub/mgmt/2021-06-01-preview/webpubsub [View full logs] [Release SDK Changes]
```
info	[Changelog] This is a new package
```
️✔️preview/webpubsub/mgmt/2021-04-01-preview/webpubsub [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```

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

⚠️Warning [Logs]Release - Generate from 0c05756. 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 old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
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
warn	Skip detect changed packages

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

openapi-workflow-bot · 2021-06-17T07:04:57Z

Hi, @bjqian your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

bjqian · 2021-06-17T07:22:28Z

This new API version removed a property: SignalRFeatureFlags. So it should be a breaking change.
The Webpubsub is not GA yet. The removal of this property is to fix the violation in the open API spec.

msyyc · 2021-06-21T02:49:51Z

For python, the breaking change is permitted.

* init api version 2021-06-01-preview for from 2021-04-01-preview * update example * update readme * update swagger file Co-authored-by: Binjie Qian <biqian@microsoft.com>

bjqian added 3 commits June 17, 2021 15:01

init api version 2021-06-01-preview for from 2021-04-01-preview

be9f710

update example

747223c

update readme

53b0e45

bjqian requested a review from ArcturusZhang as a code owner June 17, 2021 07:04

openapi-assignment-bot bot assigned ArcturusZhang Jun 17, 2021

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 17, 2021

openapi-sdkautomation bot mentioned this pull request Jun 17, 2021

[AutoPR @azure/arm-webpubsub] Webpubsub 2021-06-01-preview AzureSDKAutomation/azure-sdk-for-js#5092

Closed

update swagger file

77b175c

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label Jun 17, 2021

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

JeffreyRichter approved these changes Jun 17, 2021

View reviewed changes

chiragg4u mentioned this pull request Jun 18, 2021

Webpubsub 2021-06-01-preview #14867

Closed

26 tasks

chiragg4u 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 Jun 18, 2021

ArcturusZhang approved these changes Jun 21, 2021

View reviewed changes

ArcturusZhang merged commit 0c05756 into Azure:master Jun 21, 2021

This was referenced Jun 21, 2021

[ReleasePR Microsoft.Azure.Management.WebPubSub] update readme Azure/azure-sdk-for-net#21993

Closed

[ReleasePR azure-resourcemanager-webpubsub] update readme Azure/azure-sdk-for-java#22405

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Webpubsub 2021-06-01-preview #14868

Webpubsub 2021-06-01-preview #14868

bjqian commented Jun 17, 2021

openapi-workflow-bot bot commented Jun 17, 2021

openapi-workflow-bot bot commented Jun 17, 2021

openapi-pipeline-app bot commented Jun 17, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jun 17, 2021 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented Jun 17, 2021

bjqian commented Jun 17, 2021

msyyc commented Jun 21, 2021

Webpubsub 2021-06-01-preview #14868

Webpubsub 2021-06-01-preview #14868

Conversation

bjqian commented Jun 17, 2021

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jun 17, 2021

openapi-workflow-bot bot commented Jun 17, 2021

openapi-pipeline-app bot commented Jun 17, 2021 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jun 17, 2021 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented Jun 17, 2021

bjqian commented Jun 17, 2021

msyyc commented Jun 21, 2021

openapi-pipeline-app bot commented Jun 17, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jun 17, 2021 •

edited

Loading