Update webpubsub.json #15048

vicancy · 2021-07-01T03:15:42Z

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-07-01T03:15:44Z

Hi, @vicancy 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-pipeline-app · 2021-07-01T03:15:45Z

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]

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

Rule	Message
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'WebPubSub_CloseClientConnection' to 'WebPubSub_CloseConnection'. This will impact generated code. New: WebPubSub/preview/2021-05-01-preview/webpubsub.json#L140:7 Old: WebPubSub/preview/2021-05-01-preview/webpubsub.json#L140:7

️⚠️LintDiff: 0 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
- webpubsub/data-plane/readme.md tag:package-2021-05-01-preview
Linted configuring files (Based on target branch, openapi-validator v1.10.0 , classic-openapi-validator v1.1.8 )
- webpubsub/data-plane/readme.md tag:package-2021-05-01-preview

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'WebPubSub_SendToAll' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: WebPubSub/preview/2021-05-01-preview/webpubsub.json#L36
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'WebPubSub_SendToConnection' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: WebPubSub/preview/2021-05-01-preview/webpubsub.json#L189
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'WebPubSub_SendToGroup' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: WebPubSub/preview/2021-05-01-preview/webpubsub.json#L294
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'WebPubSub_SendToUser' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: WebPubSub/preview/2021-05-01-preview/webpubsub.json#L514

️️✔️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 tags are being changed in this PR

webpubsub/data-plane/readme.md#package-2021-05-01-preview

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"webpubsub/data-plane/readme.md",
"tag":"package-2021-05-01-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"webpubsub/data-plane/readme.md",
"tag":"package-2021-05-01-preview",
"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":"webpubsub/data-plane/readme.md",
"tag":"package-2021-05-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-workflow-bot · 2021-07-01T03:15:45Z

[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-07-01T03:15:45Z

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 warning [Detail]

⚠️Warning [Logs]Release - Generate from 529ea79. 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.3.0 requires azure-core<2.0.0,>=1.15.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.3.0 requires azure-core<2.0.0,>=1.15.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

️✔️azure-messaging-webpubsubservice [View full logs] [Release SDK Changes]
- azure_messaging_webpubsubservice-1.0.0b1-py2.py3-none-any.whl
- azure-messaging-webpubsubservice-1.0.0b1.zip
```
info	[Changelog] data-plan skip changelog generation temporarily
```

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

️✔️Succeeded [Logs]Release - Generate from 529ea79. 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/data-plane/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

️✔️Azure.Messaging.WebPubSub [View full logs] [Release SDK Changes]
```
warn	Skip artifact folder because it doesn't exist: artifacts/packages
```

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

openapi-workflow-bot · 2021-07-01T04:51:28Z

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

vicancy · 2021-07-01T05:26:18Z

Hi @anuchandy , this is the data-plane swagger for the preview service Web PubSub, and we'd like to update the SDK's API name according to the comment here: https://apiview.dev/Assemblies/Review/692173e2557442a5bd080a6260cbd761?doc=False

Since it is still in preview, I assume breaking changes are allowed. Please let me know if there are any follow-ups to take.

Thanks!

vicancy · 2021-07-02T01:54:11Z

Adding @johanste since Python SDK uses LLC

msyyc · 2021-07-15T06:24:43Z

/azp run

azure-pipelines · 2021-07-15T06:24:53Z

Azure Pipelines successfully started running 1 pipeline(s).

msyyc · 2021-07-15T06:44:38Z

/azp run

azure-pipelines · 2021-07-15T06:44:47Z

Azure Pipelines successfully started running 1 pipeline(s).

Since the SDK does not rely on that

Update webpubsub.json

8d5fe31

openapi-assignment-bot bot assigned anuchandy Jul 1, 2021

openapi-sdkautomation bot mentioned this pull request Jul 1, 2021

[AutoPR Azure.Messaging.WebPubSub] Update webpubsub.json AzureSDKAutomation/azure-sdk-for-net#4674

Closed

openapi-pipeline-app bot added the BreakingChangeReviewRequired label Jul 1, 2021

KrzysztofCwalina approved these changes Jul 1, 2021

View reviewed changes

vicancy requested a review from johanste July 2, 2021 01:54

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

openapi-sdkautomation bot mentioned this pull request Jul 15, 2021

[AutoPR azure-messaging-webpubsubservice] Update webpubsub.json AzureSDKAutomation/azure-sdk-for-python#6512

Closed

Remove JS/Java autorest

15238cf

Since the SDK does not rely on that

anuchandy approved these changes Jul 20, 2021

View reviewed changes

anuchandy merged commit 529ea79 into master Jul 20, 2021

This was referenced Jul 20, 2021

[ReleasePR azure-messaging-webpubsubservice] For Add cases, 404 should be error response Azure/azure-sdk-for-python#18351

Closed

[ReleasePR Azure.Messaging.WebPubSub] For Add cases, 404 should be error response Azure/azure-sdk-for-net#22733

Closed

vicancy deleted the vicancy-patch-1 branch July 20, 2021 03:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update webpubsub.json #15048

Update webpubsub.json #15048

vicancy commented Jul 1, 2021 •

edited

Loading

openapi-workflow-bot bot commented Jul 1, 2021

openapi-pipeline-app bot commented Jul 1, 2021 •

edited

Loading

openapi-workflow-bot bot commented Jul 1, 2021

openapi-pipeline-app bot commented Jul 1, 2021 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented Jul 1, 2021

vicancy commented Jul 1, 2021

vicancy commented Jul 2, 2021

msyyc commented Jul 15, 2021

azure-pipelines bot commented Jul 15, 2021

msyyc commented Jul 15, 2021

azure-pipelines bot commented Jul 15, 2021

Update webpubsub.json #15048

Update webpubsub.json #15048

Conversation

vicancy commented Jul 1, 2021 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jul 1, 2021

openapi-pipeline-app bot commented Jul 1, 2021 • edited Loading

Swagger Validation Report

openapi-workflow-bot bot commented Jul 1, 2021

openapi-pipeline-app bot commented Jul 1, 2021 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented Jul 1, 2021

vicancy commented Jul 1, 2021

vicancy commented Jul 2, 2021

msyyc commented Jul 15, 2021

azure-pipelines bot commented Jul 15, 2021

msyyc commented Jul 15, 2021

azure-pipelines bot commented Jul 15, 2021

vicancy commented Jul 1, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jul 1, 2021 •

edited

Loading

openapi-pipeline-app bot commented Jul 1, 2021 •

edited

Loading