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

Signalr 2023-08-01-preview #25378

Merged
merged 2 commits into from
Sep 12, 2023
Merged

Conversation

bjqian
Copy link
Contributor

@bjqian bjqian commented Aug 18, 2023

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix swagger quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

Getting help

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 18, 2023

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 18, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 167 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
signalr.json 2023-08-01-preview(658fb5c) 2023-02-01(main)
signalr.json 2023-08-01-preview(658fb5c) 2023-06-01-preview(main)
webpubsub.json 2023-08-01-preview(658fb5c) 2023-02-01(main)
webpubsub.json 2023-08-01-preview(658fb5c) 2023-06-01-preview(main)

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

Only 30 items are listed, please refer to log for more details.

Rule Message
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ResourceGroupParameter' removed or renamed?
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L3480:3
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L3064:3
1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'ResourceGroupParameter' removed or renamed?
New: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L3771:3
Old: Microsoft.SignalRService/stable/2023-02-01/webpubsub.json#L3337:3
1011 - AddingResponseCode The new version adds a response code '200'.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L1229:11
1011 - AddingResponseCode The new version adds a response code '200'.
New: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L1452:11
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L58:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L58:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L113:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L113:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L162:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L162:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: common-types/resource-management/v5/types.json#L14:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L2266:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: common-types/resource-management/v5/types.json#L14:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L2266:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: common-types/resource-management/v5/types.json#L14:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L2266:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L204:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L204:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L249:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L249:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L292:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L292:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L354:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L351:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L404:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L401:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L470:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L459:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: common-types/resource-management/v5/types.json#L14:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L2266:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L518:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L507:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L572:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L561:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L638:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L624:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L690:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L676:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: common-types/resource-management/v5/types.json#L14:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L2266:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L738:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L724:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L792:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L778:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L852:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L835:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L911:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L894:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L956:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L939:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L1004:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L987:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L1050:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L1037:9
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L1102:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L1093:9
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.4) new version base version
package-2023-08-01-preview package-2023-08-01-preview(658fb5c) default(main)
package-2023-08-01-preview package-2023-08-01-preview(658fb5c) default(main)

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule Message
OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L28
PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L315
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L328
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L372
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:location.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L410
ResourceNameRestriction The resource name parameter 'certificateName' should be defined with a 'pattern' restriction.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L508
PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L602
ProvisioningStateSpecifiedForLROPut 200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L779
PutResponseSchemaDescription Any Put MUST contain 200 and 201 return codes.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L822
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L877
ResourceNameRestriction The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L994
PutResponseSchemaDescription Any Put MUST contain 200 and 201 return codes.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L1076
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L1123
LroPostReturn 202 response for a LRO POST operation must not have a response schema specified.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L1196
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:location.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L1505
LroPostReturn A LRO POST operation must have both 200 & 202 return codes.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L1547
LroPostReturn A LRO POST operation must have both 200 & 202 return codes.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L1649
ResourceNameRestriction The resource name parameter 'sharedPrivateLinkResourceName' should be defined with a 'pattern' restriction.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L1747
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L1898
OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L28
PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L315
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L328
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L372
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:location.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L410
ResourceNameRestriction The resource name parameter 'certificateName' should be defined with a 'pattern' restriction.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L508
PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L602
ProvisioningStateSpecifiedForLROPut 200 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L779
PutResponseSchemaDescription Any Put MUST contain 200 and 201 return codes.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L822
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L877
ResourceNameRestriction The resource name parameter 'hubName' should be defined with a 'pattern' restriction.
Location: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L949
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 18, 2023

Swagger Generation Artifacts

️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
Rule Message
RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=380821&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
"detail":"Run.ps1 failed with exit code 1 "
️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking




azure-sdk-for-js - @azure/arm-webpubsub - Approved - 2.0.0-beta.2
+	Interface CustomCertificate no longer has parameter systemData
+	Interface CustomDomain no longer has parameter systemData
+	Interface PrivateEndpointConnection no longer has parameter systemData
+	Interface SharedPrivateLinkResource no longer has parameter systemData
+	Interface WebPubSubHub no longer has parameter systemData
+	Interface WebPubSubResource no longer has parameter systemData
+	Parameter location of interface TrackedResource is now required
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 4ae85dc. 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
    cmderr	[automation_generate.sh]  notice
    cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.6.7 -> 10.1.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.1.0` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-signalr [View full logs]  [Release SDK Changes] Breaking Change Detected
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Added operation SignalROperations.list_replica_skus
    info	[Changelog]   - Added operation group SignalRReplicasOperations
    info	[Changelog]   - Model PrivateLinkResource has a new parameter system_data
    info	[Changelog]   - Model ProxyResource has a new parameter system_data
    info	[Changelog]   - Model Resource has a new parameter system_data
    info	[Changelog]   - Model SignalRNetworkACLs has a new parameter ip_rules
    info	[Changelog]   - Model SignalRResource has a new parameter region_endpoint_enabled
    info	[Changelog]   - Model SignalRResource has a new parameter resource_stopped
    info	[Changelog]   - Model TrackedResource has a new parameter system_data
    info	[Changelog]
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog]   - Parameter location of model SignalRResource is now required
    info	[Changelog]   - Parameter location of model TrackedResource is now required
  • ️✔️track2_azure-mgmt-webpubsub [View full logs]  [Release SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Model Replica has a new parameter region_endpoint_enabled
    info	[Changelog]   - Model Replica has a new parameter resource_stopped
    info	[Changelog]   - Model WebPubSubNetworkACLs has a new parameter ip_rules
    info	[Changelog]   - Model WebPubSubResource has a new parameter region_endpoint_enabled
    info	[Changelog]   - Model WebPubSubResource has a new parameter resource_stopped
️⚠️ azure-sdk-for-java warning [Detail]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 4ae85dc. SDK Automation 14.0.0
    command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
    warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
  • ️✔️@azure/arm-signalr [View full logs]  [Release SDK Changes] Breaking Change Detected
    info	[Changelog] **Features**
    info	[Changelog]
    info	[Changelog]   - Added operation group SignalRReplicas
    info	[Changelog]   - Added operation SignalR.listReplicaSkus
    info	[Changelog]   - Added Interface IPRule
    info	[Changelog]   - Added Interface Replica
    info	[Changelog]   - Added Interface ReplicaList
    info	[Changelog]   - Added Interface SignalRListReplicaSkusOptionalParams
    info	[Changelog]   - Added Interface SignalRRegenerateKeyHeaders
    info	[Changelog]   - Added Interface SignalRReplicasCreateOrUpdateOptionalParams
    info	[Changelog]   - Added Interface SignalRReplicasDeleteOptionalParams
    info	[Changelog]   - Added Interface SignalRReplicasGetOptionalParams
    info	[Changelog]   - Added Interface SignalRReplicasListNextOptionalParams
    info	[Changelog]   - Added Interface SignalRReplicasListOptionalParams
    info	[Changelog]   - Added Interface SignalRReplicasRestartHeaders
    info	[Changelog]   - Added Interface SignalRReplicasRestartOptionalParams
    info	[Changelog]   - Added Interface SignalRReplicasUpdateHeaders
    info	[Changelog]   - Added Interface SignalRReplicasUpdateOptionalParams
    info	[Changelog]   - Added Interface SignalRRestartHeaders
    info	[Changelog]   - Added Interface SignalRUpdateHeaders
    info	[Changelog]   - Added Type Alias SignalRListReplicaSkusResponse
    info	[Changelog]   - Added Type Alias SignalRReplicasCreateOrUpdateResponse
    info	[Changelog]   - Added Type Alias SignalRReplicasGetResponse
    info	[Changelog]   - Added Type Alias SignalRReplicasListNextResponse
    info	[Changelog]   - Added Type Alias SignalRReplicasListResponse
    info	[Changelog]   - Added Type Alias SignalRReplicasRestartResponse
    info	[Changelog]   - Added Type Alias SignalRReplicasUpdateResponse
    info	[Changelog]   - Added Type Alias SignalRRestartResponse
    info	[Changelog]   - Interface Resource has a new optional parameter systemData
    info	[Changelog]   - Interface SignalRNetworkACLs has a new optional parameter ipRules
    info	[Changelog]   - Interface SignalRResource has a new optional parameter regionEndpointEnabled
    info	[Changelog]   - Interface SignalRResource has a new optional parameter resourceStopped
    info	[Changelog]
    info	[Changelog] **Breaking Changes**
    info	[Changelog]
    info	[Changelog]   - Interface CustomCertificate no longer has parameter systemData
    info	[Changelog]   - Interface CustomDomain no longer has parameter systemData
    info	[Changelog]   - Interface PrivateEndpointConnection no longer has parameter systemData
    info	[Changelog]   - Interface SharedPrivateLinkResource no longer has parameter systemData
    info	[Changelog]   - Interface SignalRResource no longer has parameter systemData
    info	[Changelog]   - Parameter location of interface TrackedResource is now required
  • ️✔️@azure/arm-webpubsub [View full logs]  [Release SDK Changes] Breaking Change Detected
    info	[Changelog] **Features**
    info	[Changelog]
    info	[Changelog]   - Added operation group WebPubSubReplicas
    info	[Changelog]   - Added operation WebPubSub.listReplicaSkus
    info	[Changelog]   - Added Interface IPRule
    info	[Changelog]   - Added Interface Replica
    info	[Changelog]   - Added Interface ReplicaList
    info	[Changelog]   - Added Interface WebPubSubListReplicaSkusOptionalParams
    info	[Changelog]   - Added Interface WebPubSubRegenerateKeyHeaders
    info	[Changelog]   - Added Interface WebPubSubReplicasCreateOrUpdateOptionalParams
    info	[Changelog]   - Added Interface WebPubSubReplicasDeleteOptionalParams
    info	[Changelog]   - Added Interface WebPubSubReplicasGetOptionalParams
    info	[Changelog]   - Added Interface WebPubSubReplicasListNextOptionalParams
    info	[Changelog]   - Added Interface WebPubSubReplicasListOptionalParams
    info	[Changelog]   - Added Interface WebPubSubReplicasRestartHeaders
    info	[Changelog]   - Added Interface WebPubSubReplicasRestartOptionalParams
    info	[Changelog]   - Added Interface WebPubSubReplicasUpdateHeaders
    info	[Changelog]   - Added Interface WebPubSubReplicasUpdateOptionalParams
    info	[Changelog]   - Added Interface WebPubSubRestartHeaders
    info	[Changelog]   - Added Interface WebPubSubUpdateHeaders
    info	[Changelog]   - Added Type Alias ServiceKind
    info	[Changelog]   - Added Type Alias WebPubSubListReplicaSkusResponse
    info	[Changelog]   - Added Type Alias WebPubSubReplicasCreateOrUpdateResponse
    info	[Changelog]   - Added Type Alias WebPubSubReplicasGetResponse
    info	[Changelog]   - Added Type Alias WebPubSubReplicasListNextResponse
    info	[Changelog]   - Added Type Alias WebPubSubReplicasListResponse
    info	[Changelog]   - Added Type Alias WebPubSubReplicasRestartResponse
    info	[Changelog]   - Added Type Alias WebPubSubReplicasUpdateResponse
    info	[Changelog]   - Added Type Alias WebPubSubRestartResponse
    info	[Changelog]   - Interface Resource has a new optional parameter systemData
    info	[Changelog]   - Interface WebPubSubNetworkACLs has a new optional parameter ipRules
    info	[Changelog]   - Interface WebPubSubResource has a new optional parameter kind
    info	[Changelog]   - Interface WebPubSubResource has a new optional parameter regionEndpointEnabled
    info	[Changelog]   - Interface WebPubSubResource has a new optional parameter resourceStopped
    info	[Changelog]   - Added Enum KnownServiceKind
    info	[Changelog]
    info	[Changelog] **Breaking Changes**
    info	[Changelog]
    info	[Changelog]   - Interface CustomCertificate no longer has parameter systemData
    info	[Changelog]   - Interface CustomDomain no longer has parameter systemData
    info	[Changelog]   - Interface PrivateEndpointConnection no longer has parameter systemData
    info	[Changelog]   - Interface SharedPrivateLinkResource no longer has parameter systemData
    info	[Changelog]   - Interface WebPubSubHub no longer has parameter systemData
    info	[Changelog]   - Interface WebPubSubResource no longer has parameter systemData
    info	[Changelog]   - Parameter location of interface TrackedResource is now required
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from 4ae85dc. SDK Automation 14.0.0
    command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️sdk/resourcemanager/signalr/armsignalr [View full logs]  [Release SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New function `*Client.ListReplicaSKUs(context.Context, string, string, string, *ClientListReplicaSKUsOptions) (ClientListReplicaSKUsResponse, error)`
    info	[Changelog] - New function `*ClientFactory.NewReplicasClient() *ReplicasClient`
    info	[Changelog] - New function `NewReplicasClient(string, azcore.TokenCredential, *arm.ClientOptions) (*ReplicasClient, error)`
    info	[Changelog] - New function `*ReplicasClient.BeginCreateOrUpdate(context.Context, string, string, string, Replica, *ReplicasClientBeginCreateOrUpdateOptions) (*runtime.Poller[ReplicasClientCreateOrUpdateResponse], error)`
    info	[Changelog] - New function `*ReplicasClient.Delete(context.Context, string, string, string, *ReplicasClientDeleteOptions) (ReplicasClientDeleteResponse, error)`
    info	[Changelog] - New function `*ReplicasClient.Get(context.Context, string, string, string, *ReplicasClientGetOptions) (ReplicasClientGetResponse, error)`
    info	[Changelog] - New function `*ReplicasClient.NewListPager(string, string, *ReplicasClientListOptions) *runtime.Pager[ReplicasClientListResponse]`
    info	[Changelog] - New function `*ReplicasClient.BeginRestart(context.Context, string, string, string, *ReplicasClientBeginRestartOptions) (*runtime.Poller[ReplicasClientRestartResponse], error)`
    info	[Changelog] - New function `*ReplicasClient.BeginUpdate(context.Context, string, string, string, Replica, *ReplicasClientBeginUpdateOptions) (*runtime.Poller[ReplicasClientUpdateResponse], error)`
    info	[Changelog] - New struct `IPRule`
    info	[Changelog] - New struct `Replica`
    info	[Changelog] - New struct `ReplicaList`
    info	[Changelog] - New struct `ReplicaProperties`
    info	[Changelog] - New field `IPRules` in struct `NetworkACLs`
    info	[Changelog] - New field `SystemData` in struct `PrivateLinkResource`
    info	[Changelog] - New field `RegionEndpointEnabled`, `ResourceStopped` in struct `Properties`
    info	[Changelog] - New field `SystemData` in struct `ProxyResource`
    info	[Changelog] - New field `SystemData` in struct `Resource`
    info	[Changelog] - New field `SystemData` in struct `TrackedResource`
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 23 additive change(s).
  • ️✔️sdk/resourcemanager/webpubsub/armwebpubsub [View full logs]  [Release SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New struct `IPRule`
    info	[Changelog] - New field `IPRules` in struct `NetworkACLs`
    info	[Changelog] - New field `RegionEndpointEnabled`, `ResourceStopped` in struct `Properties`
    info	[Changelog] - New field `RegionEndpointEnabled`, `ResourceStopped` in struct `ReplicaProperties`
    info	[Changelog]
    info	[Changelog] Total 0 breaking change(s), 5 additive change(s).
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from 4ae85dc. 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] npm notice
    cmderr	[initScript.sh] npm notice New major version of npm available! 8.19.4 -> 10.1.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.1.0>
    cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.1.0` to update!
    cmderr	[initScript.sh] npm notice
    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
  • ️✔️signalr [View full logs]  [Release Schema Changes]
  • ️✔️webpubsub [View full logs]  [Release Schema Changes]
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs]Release - Generate from 4ae85dc. SDK Automation 14.0.0
    command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
    command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    SSL error: syscall failure: Broken pipe
    Error: SSL error: syscall failure: Broken pipe
  • ⚠️Az.signalr.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.signalr.DefaultTag
    error		Az.webpubsub.DefaultTag
  • ⚠️Az.webpubsub.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 18, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/signalr/armsignalr https://apiview.dev/Assemblies/Review/886fa71b4e2e4606b2ee9e5f070a9d30
Go sdk/resourcemanager/webpubsub/armwebpubsub https://apiview.dev/Assemblies/Review/6e0567b6af9b4171a5892ed1c1076d02
Java azure-resourcemanager-signalr https://apiview.dev/Assemblies/Review/f4b2f51bec404691a6a992149051403b
Java azure-resourcemanager-webpubsub https://apiview.dev/Assemblies/Review/ac1770075acf48578214023803c53824
JavaScript @azure/arm-signalr https://apiview.dev/Assemblies/Review/1f0e7c8e248a41c9be2b89de3be2ee43
JavaScript @azure/arm-webpubsub https://apiview.dev/Assemblies/Review/e21ddc9349e44ca48d6d7c14f333e9f0
.Net Azure.ResourceManager.SignalR https://apiview.dev/Assemblies/Review/231670cd2bc143449b5c371f552118f8
.Net Azure.ResourceManager.WebPubSub There is no API change compared with the previous version

@openapi-workflow-bot
Copy link

Please address or respond to feedback from the ARM API reviewer.
When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
This will notify the reviewer to have another look.
If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

@openapi-workflow-bot
Copy link

Hi @bjqian! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 18, 2023

Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

@bjqian
Copy link
Contributor Author

bjqian commented Sep 2, 2023

Looks we skipped step 1 and completed step 2. So I added back the label "WaitforArmFeedBack" to put it into the Arm review queue. Then the bot removes the "ArmSignOff" 😂 . We need to wait again..
The breaking changes have been approved before and we hope to get a quick approvol for that.

@bjqian bjqian changed the title Signalr 2023 08 01 preview Signalr 2023-08-01-preview Sep 2, 2023
@sjanamma sjanamma added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Sep 5, 2023
@openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Sep 5, 2023
@rkmanda rkmanda added Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 and removed Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 labels Sep 5, 2023
@JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Sep 6, 2023
@raych1 raych1 added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Sep 8, 2023
@bjqian
Copy link
Contributor Author

bjqian commented Sep 11, 2023

/prRequestMerge

@bjqian
Copy link
Contributor Author

bjqian commented Sep 11, 2023

/pr RequestMerge

@rkmanda rkmanda merged commit 4ae85dc into Azure:main Sep 12, 2023
28 of 30 checks passed
@openapi-pipeline-app
Copy link

Swagger pipeline restarted successfully, please wait for status update in this comment.

jnlycklama pushed a commit that referenced this pull request Nov 8, 2023
* init 2023-08-01-preview

* update to 2023-08-01-preview
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-JavaScript ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-BreakingChange-JavaScript CI-MissingBaseCommit new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants