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

Azure SignalR - Adding new api-version 2024-01-01-preview #28259

Merged
merged 4 commits into from
Mar 25, 2024

Conversation

bjqian
Copy link
Contributor

@bjqian bjqian commented Mar 14, 2024

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

Note

As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.

PR review workflow diagram

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

diagram

Click here to see the details of Step 1, Breaking Changes review

If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.

Click here to see the details of Step 2, ARM review

See https://aka.ms/azsdk/pr-arm-review.

Click here to see the diagram footnotes

Diagram footnotes

[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been generated using OpenAPI Hub).
  • 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 OpenAPI spec 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:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with PR workflow diagram Step 2 (ARM review), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

@bjqian bjqian requested a review from tadelesh as a code owner March 14, 2024 06:47
Copy link

openapi-pipeline-app bot commented Mar 14, 2024

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see https://aka.ms/azsdk/specreview/merge.

Copy link

openapi-pipeline-app bot commented Mar 14, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 185 Errors, 20 Warnings failed [Detail]
Compared specs (v0.10.5) new version base version
signalr.json 2024-01-01-preview(bca9ac1) 2023-02-01(main)
signalr.json 2024-01-01-preview(bca9ac1) 2023-08-01-preview(main)
webpubsub.json 2024-01-01-preview(bca9ac1) 2023-02-01(main)
webpubsub.json 2024-01-01-preview(bca9ac1) 2023-08-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/2024-01-01-preview/signalr.json#L3643: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/2024-01-01-preview/webpubsub.json#L3955: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/2024-01-01-preview/signalr.json#L1229:11
1011 - AddingResponseCode The new version adds a response code '200'.
New: Microsoft.SignalRService/preview/2024-01-01-preview/webpubsub.json#L1452:11
1023 - TypeFormatChanged The new version has a different format than the previous one.
New: Microsoft.SignalRService/preview/2024-01-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/2024-01-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/2024-01-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/2024-01-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/2024-01-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/2024-01-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/2024-01-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/2024-01-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/2024-01-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/2024-01-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/2024-01-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/2024-01-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/2024-01-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/2024-01-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/2024-01-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/2024-01-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/2024-01-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/2024-01-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/2024-01-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/2024-01-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/2024-01-01-preview/signalr.json#L1102:9
Old: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L1093:9


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

Rule Message
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L3239:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L3076:9
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L2677:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L2515:9
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L3109:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L2946:9
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L2187:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L2025:9
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L2261:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L2099:9
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L2862:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L2699:9
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L2796:5
Old: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L2634:5
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: Microsoft.SignalRService/preview/2024-01-01-preview/webpubsub.json#L3763:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L3592:9
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: Microsoft.SignalRService/preview/2024-01-01-preview/webpubsub.json#L3018:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L2856:9
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: Microsoft.SignalRService/preview/2024-01-01-preview/webpubsub.json#L3422:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L3259:9
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: Microsoft.SignalRService/preview/2024-01-01-preview/webpubsub.json#L2410:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L2248:9
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: Microsoft.SignalRService/preview/2024-01-01-preview/webpubsub.json#L2484:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L2322:9
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: Microsoft.SignalRService/preview/2024-01-01-preview/webpubsub.json#L3203:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L3040:9
⚠️ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: Microsoft.SignalRService/preview/2024-01-01-preview/webpubsub.json#L3137:5
Old: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L2975:5
⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L1931:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L1758:11
⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L1977:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L1808:11
⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L2039:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/signalr.json#L1874:11
⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.SignalRService/preview/2024-01-01-preview/webpubsub.json#L2154:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L1981:11
⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.SignalRService/preview/2024-01-01-preview/webpubsub.json#L2200:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L2031:11
⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.SignalRService/preview/2024-01-01-preview/webpubsub.json#L2262:9
Old: Microsoft.SignalRService/preview/2023-08-01-preview/webpubsub.json#L2097:11
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 4 Warnings warning [Detail]
Compared specs (v2.2.0) new version base version
package-2024-01-01-preview package-2024-01-01-preview(bca9ac1) default(main)
package-2024-01-01-preview package-2024-01-01-preview(bca9ac1) default(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
⚠️ NonApplicationJsonType Only content-type 'application/json' is supported by ARM
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L1709
⚠️ AllProxyResourcesShouldHaveDelete The resource SharedPrivateLinkResource does not have a corresponding delete operation.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L3060
RPC-Delete-V1-05
⚠️ NonApplicationJsonType Only content-type 'application/json' is supported by ARM
Location: Microsoft.SignalRService/preview/2024-01-01-preview/webpubsub.json#L1932
⚠️ AllProxyResourcesShouldHaveDelete The resource SharedPrivateLinkResource does not have a corresponding delete operation.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/webpubsub.json#L3373
RPC-Delete-V1-05


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/2024-01-01-preview/signalr.json#L28
PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L283
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L328
DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L348
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L372
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:location.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L410
PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:enabled.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L410
PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:connectionTimeoutInSeconds.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L410
PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:publicNetworkAccess.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L410
PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:regionEndpointEnabled.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L410
PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:resourceStopped.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L410
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:name.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L410
ResourceNameRestriction The resource name parameter 'certificateName' should be defined with a 'pattern' restriction.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L508
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/2024-01-01-preview/signalr.json#L779
PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L779
DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L846
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L877
PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L1041
DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L1096
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L1123
PostResponseCodes 202 response for a LRO POST operation must not have a response schema specified.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L1196
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:location.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L1505
PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:regionEndpointEnabled.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L1505
PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:resourceStopped.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L1505
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:name.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L1505
PostResponseCodes Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L1547
XmsPageableForListCalls x-ms-pageable extension must be specified for LIST APIs.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L1775
PostResponseCodes Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L1823
DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L2033
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.SignalRService/preview/2024-01-01-preview/signalr.json#L2060
️️✔️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.
️️✔️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?

Copy link

openapi-pipeline-app bot commented Mar 14, 2024

Swagger Generation Artifacts

️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
Rule Message
RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=419262&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-signalr - 6.0.0-beta.3
+	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 SignalRResource no longer has parameter systemData
+	Parameter location of interface TrackedResource is now required
azure-sdk-for-js - @azure/arm-webpubsub - 2.0.0-beta.3
+	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] Generate from c3985feb70215da9f7fcac44b2a2b6bb5b8d0171. 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: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    cmderr	[automation_init.sh] WARNING: azure-devtools 1.2.1 does not provide the extra 'ci-tools'
    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]
    cmderr	[automation_generate.sh] npm notice New minor version of npm available! 10.2.4 -> 10.5.0
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.5.0` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-signalr [View full logs]  [Preview SDK Changes]
  • ️✔️track2_azure-mgmt-webpubsub [View full logs]  [Preview SDK Changes]
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs] Generate from c3985feb70215da9f7fcac44b2a2b6bb5b8d0171. 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
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh] [notice] A new release of pip is available: 23.0.1 -> 24.0
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    cmderr	[init.sh] ent
    cmderr	[init.sh]                                  Dload  Upload   Total   Spent    Left  Speed
    cmderr	[init.sh] 
      0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0- 1110k
    cmderr	[init.sh] npm notice
    cmderr	[init.sh] npm notice New minor version of npm available! 10.2.4 -> 10.5.0
    cmderr	[init.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0>
    cmderr	[init.sh] npm notice Run `npm install -g npm@10.5.0` to update!
    cmderr	[init.sh] npm notice
    cmderr	[init.sh] Downloading https://nodejs.org/dist/v18.15.0/node-v18.15.0-linux-x64.tar.xz...
    cmderr	[init.sh] Computing checksum with sha256sum
    cmderr	[init.sh] Checksums matched!
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-signalr [View full logs]  [Preview SDK Changes]
  • ️✔️azure-resourcemanager-webpubsub [View full logs]  [Preview SDK Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs] Generate from c3985feb70215da9f7fcac44b2a2b6bb5b8d0171. 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]  [Preview SDK Changes]
  • ️✔️sdk/resourcemanager/webpubsub/armwebpubsub [View full logs]  [Preview SDK Changes]
️⚠️ azure-resource-manager-schemas warning [Detail]
  • ⚠️Warning [Logs] Generate from c3985feb70215da9f7fcac44b2a2b6bb5b8d0171. 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]
    cmderr	[initScript.sh] npm notice New minor version of npm available! 10.2.4 -> 10.5.0
    cmderr	[initScript.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.5.0>
    cmderr	[initScript.sh] npm notice Run `npm install -g npm@10.5.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]  [Preview Schema Changes]
  • ️✔️webpubsub [View full logs]  [Preview Schema Changes]
️⚠️ azure-powershell warning [Detail]
  • ⚠️Warning [Logs] Generate from c3985feb70215da9f7fcac44b2a2b6bb5b8d0171. 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
  • ⚠️Az.signalr.DefaultTag [View full logs]  [Preview SDK Changes]
  • ⚠️Az.webpubsub.DefaultTag [View full logs]  [Preview SDK Changes]
Posted by Swagger Pipeline | How to fix these errors?

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.

@AzureRestAPISpecReview AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Mar 14, 2024
@bjqian
Copy link
Contributor Author

bjqian commented Mar 14, 2024

The breaking change compares to the previous stable version has been approved in this PR. It is actually a false alarm when we switched to common models

@mikekistler
Copy link
Member

Breaking changes previously reviewed and approved in #22948

@mikekistler mikekistler added the BreakingChange-Approved-Previously Changes were reviewed and approved in a previous PR label Mar 19, 2024
@bjqian bjqian removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 20, 2024
@openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 20, 2024
@bjqian
Copy link
Contributor Author

bjqian commented Mar 20, 2024

Looks not reviewed by ARM API reviewer. Thus remove the ArmReviewRequested label

@ms-zhenhua
Copy link
Contributor

/azp run

Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@ms-zhenhua ms-zhenhua added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 20, 2024
@bjqian bjqian removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 21, 2024
@openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 21, 2024
@ms-zhenhua ms-zhenhua added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 21, 2024
@bjqian bjqian removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Mar 22, 2024
@openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 22, 2024
@ms-zhenhua ms-zhenhua 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 Mar 22, 2024
@bjqian
Copy link
Contributor Author

bjqian commented Mar 25, 2024

/pr RequestMerge

@ms-henglu ms-henglu merged commit 07f6af5 into Azure:main Mar 25, 2024
31 of 33 checks passed
vxfield pushed a commit that referenced this pull request Mar 28, 2024
* Copy api version 2024-01-01-preview from 2023-08-01-preview for azure signarl and webpubsub

* Update to 2024-01-01-preview

* Make provisioning state readonly

* Trivial change : adjust readonly position
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Approved-Previously Changes were reviewed and approved in a previous PR BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required 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