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 2023-02-01 #22695

Merged
merged 4 commits into from
Mar 3, 2023

Conversation

juniwang
Copy link
Contributor

@juniwang juniwang commented Feb 17, 2023

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. 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
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
  • 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @juniwang Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 17, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.10.4)] new version base version
    signalr.json 2023-02-01(5e89402) 2022-02-01(main)
    signalr.json 2023-02-01(5e89402) 2022-08-01-preview(main)
    webpubsub.json 2023-02-01(5e89402) 2021-10-01(main)
    webpubsub.json 2023-02-01(5e89402) 2022-08-01-preview(main)
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2023-02-01 package-2023-02-01(5e89402) default(main)
    package-2023-02-01 package-2023-02-01(5e89402) 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
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L239
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L283
    CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L328
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L328
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L369
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property name.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L402
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property type.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L402
    UnSupportedPatchProperties The patch operation body parameter schema should not contains property location.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L402
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L431
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L449
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L497
    ResourceNameRestriction The resource name parameter 'certificateName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L497
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L548
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L666
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L714
    CreateOperationAsyncResponseValidation An async PUT operation must set long running operation options 'x-ms-long-running-operation-options'
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L765
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L860
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L884
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L929
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L977
    ResourceNameRestriction The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L977
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L1118
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L1142
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L1190
    PostOperationAsyncResponseValidation An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options'
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L1191
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L1224
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L1248
    PostOperationAsyncResponseValidation An async POST operation is tracked via Azure-AsyncOperation header. Set 'final-state-via' property to 'location' on 'x-ms-long-running-operation-options'
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L1249
    LroLocationHeader A 202 response should include an Location response header.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L1270
    ResourceNameRestriction The resource name parameter 'resourceName' should be defined with a 'pattern' restriction.
    Location: Microsoft.SignalRService/stable/2023-02-01/signalr.json#L1294
    ️❌Avocado: 4 Errors, 0 Warnings failed [Detail]
    Rule Message
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.SignalRService/SignalR is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/signalr/resource-manager/readme.md
    json: Microsoft.SignalRService/stable/2018-10-01/signalr.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.SignalRService/SignalR is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/signalr/resource-manager/readme.md
    json: Microsoft.SignalRService/stable/2018-10-01/signalr.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.SignalRService/SignalR/{}/listKeys is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/signalr/resource-manager/readme.md
    json: Microsoft.SignalRService/stable/2018-10-01/signalr.json
    MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.SignalRService/SignalR/{}/regenerateKey is not in the default tag. Please make sure the missing API swaggers are in the default tag.
    readme: specification/signalr/resource-manager/readme.md
    json: Microsoft.SignalRService/stable/2018-10-01/signalr.json
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️❌~[Staging] ServiceAPIReadinessTest: 4 Errors, 0 Warnings failed [Detail]

    Tag package-2023-02-01; Prod region: Deployed

    Test run on region: westcentralus; Operation coverage: total: 30, untested: 0, failed: 4, passed: 26

    Service API Readiness Test failed. Check pipeline artifact for detail report.

    Rule Message
    CLIENT_ERROR statusCode: 404,
    errorCode: NotFound,
    errorMessage: Private endpoint connection not found
    Source: runtime
    OperationId: SignalRPrivateEndpointConnections_Update
    CLIENT_ERROR statusCode: 404,
    errorCode: NotFound,
    errorMessage: Private endpoint connection not found
    Source: runtime
    OperationId: SignalRPrivateEndpointConnections_Get
    CLIENT_ERROR statusCode: 400,
    errorCode: BadArgument,
    errorMessage: Referenced custom certificate "myCert" does not exist.
    Source: runtime
    OperationId: SignalRCustomDomains_CreateOrUpdate
    CLIENT_ERROR statusCode: 404,
    errorCode: NotFound,
    errorMessage: The resource is not found
    Source: runtime
    OperationId: SignalRCustomDomains_Get
    ️️✔️SwaggerAPIView succeeded [Detail] [Expand]
    ️️✔️CadlAPIView 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).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 17, 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=349972&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
    "detail":"Run.ps1 failed with exit code 1 "
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking







    ️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from b92e9b3. 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] npm notice
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.3.1 -> 9.6.0
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.0>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-signalr [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Model SignalRResource has a new parameter serverless
    • ️✔️track2_azure-mgmt-webpubsub [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation group WebPubSubCustomCertificatesOperations
      info	[Changelog]   - Added operation group WebPubSubCustomDomainsOperations
      info	[Changelog]   - Model WebPubSubHubProperties has a new parameter event_listeners
    ️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from b92e9b3. 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]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added Interface CustomCertificate
      info	[Changelog]   - Added Interface CustomDomain
      info	[Changelog]   - Added Interface PrivateEndpointACL
      info	[Changelog]   - Added Interface PrivateEndpointConnection
      info	[Changelog]   - Added Interface PrivateLinkResource
      info	[Changelog]   - Added Interface ProxyResource
      info	[Changelog]   - Added Interface ServerlessSettings
      info	[Changelog]   - Added Interface SharedPrivateLinkResource
      info	[Changelog]   - Added Interface SignalRResource
      info	[Changelog]   - Added Interface TrackedResource
      info	[Changelog]   - Added function getContinuationToken
    • ️✔️@azure/arm-webpubsub [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation group WebPubSubCustomCertificates
      info	[Changelog]   - Added operation group WebPubSubCustomDomains
      info	[Changelog]   - Added Interface CustomCertificate
      info	[Changelog]   - Added Interface CustomCertificateList
      info	[Changelog]   - Added Interface CustomDomain
      info	[Changelog]   - Added Interface CustomDomainList
      info	[Changelog]   - Added Interface EventHubEndpoint
      info	[Changelog]   - Added Interface EventListener_2
      info	[Changelog]   - Added Interface EventListenerEndpoint
      info	[Changelog]   - Added Interface EventListenerFilter
      info	[Changelog]   - Added Interface EventNameFilter
      info	[Changelog]   - Added Interface PrivateEndpointACL
      info	[Changelog]   - Added Interface PrivateEndpointConnection
      info	[Changelog]   - Added Interface PrivateLinkResource
      info	[Changelog]   - Added Interface ProxyResource
      info	[Changelog]   - Added Interface ResourceReference
      info	[Changelog]   - Added Interface SharedPrivateLinkResource
      info	[Changelog]   - Added Interface TrackedResource
      info	[Changelog]   - Added Interface WebPubSubCustomCertificatesCreateOrUpdateOptionalParams
      info	[Changelog]   - Added Interface WebPubSubCustomCertificatesDeleteOptionalParams
      info	[Changelog]   - Added Interface WebPubSubCustomCertificatesGetOptionalParams
      info	[Changelog]   - Added Interface WebPubSubCustomCertificatesListNextOptionalParams
      info	[Changelog]   - Added Interface WebPubSubCustomCertificatesListOptionalParams
      info	[Changelog]   - Added Interface WebPubSubCustomDomainsCreateOrUpdateOptionalParams
      info	[Changelog]   - Added Interface WebPubSubCustomDomainsDeleteOptionalParams
      info	[Changelog]   - Added Interface WebPubSubCustomDomainsGetOptionalParams
      info	[Changelog]   - Added Interface WebPubSubCustomDomainsListNextOptionalParams
      info	[Changelog]   - Added Interface WebPubSubCustomDomainsListOptionalParams
      info	[Changelog]   - Added Interface WebPubSubHub
      info	[Changelog]   - Added Interface WebPubSubResource
      info	[Changelog]   - Added Type Alias EventListenerEndpointDiscriminator
      info	[Changelog]   - Added Type Alias EventListenerEndpointUnion
      info	[Changelog]   - Added Type Alias EventListenerFilterDiscriminator
      info	[Changelog]   - Added Type Alias EventListenerFilterUnion
      info	[Changelog]   - Added Type Alias WebPubSubCustomCertificatesCreateOrUpdateResponse
      info	[Changelog]   - Added Type Alias WebPubSubCustomCertificatesGetResponse
      info	[Changelog]   - Added Type Alias WebPubSubCustomCertificatesListNextResponse
      info	[Changelog]   - Added Type Alias WebPubSubCustomCertificatesListResponse
      info	[Changelog]   - Added Type Alias WebPubSubCustomDomainsCreateOrUpdateResponse
      info	[Changelog]   - Added Type Alias WebPubSubCustomDomainsGetResponse
      info	[Changelog]   - Added Type Alias WebPubSubCustomDomainsListNextResponse
      info	[Changelog]   - Added Type Alias WebPubSubCustomDomainsListResponse
      info	[Changelog]   - Interface WebPubSubHubProperties has a new optional parameter eventListeners
      info	[Changelog]   - Added Enum KnownEventListenerEndpointDiscriminator
      info	[Changelog]   - Added Enum KnownEventListenerFilterDiscriminator
      info	[Changelog]   - Added function getContinuationToken
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from b92e9b3. 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 struct `ServerlessSettings`
      info	[Changelog] - New field `Serverless` in struct `Properties`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 3 additive change(s).
    • ️✔️sdk/resourcemanager/webpubsub/armwebpubsub [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New type alias `EventListenerEndpointDiscriminator` with values `EventListenerEndpointDiscriminatorEventHub`
      info	[Changelog] - New type alias `EventListenerFilterDiscriminator` with values `EventListenerFilterDiscriminatorEventName`
      info	[Changelog] - New function `NewCustomCertificatesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*CustomCertificatesClient, error)`
      info	[Changelog] - New function `*CustomCertificatesClient.BeginCreateOrUpdate(context.Context, string, string, string, CustomCertificate, *CustomCertificatesClientBeginCreateOrUpdateOptions) (*runtime.Poller[CustomCertificatesClientCreateOrUpdateResponse], error)`
      info	[Changelog] - New function `*CustomCertificatesClient.Delete(context.Context, string, string, string, *CustomCertificatesClientDeleteOptions) (CustomCertificatesClientDeleteResponse, error)`
      info	[Changelog] - New function `*CustomCertificatesClient.Get(context.Context, string, string, string, *CustomCertificatesClientGetOptions) (CustomCertificatesClientGetResponse, error)`
      info	[Changelog] - New function `*CustomCertificatesClient.NewListPager(string, string, *CustomCertificatesClientListOptions) *runtime.Pager[CustomCertificatesClientListResponse]`
      info	[Changelog] - New function `NewCustomDomainsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*CustomDomainsClient, error)`
      info	[Changelog] - New function `*CustomDomainsClient.BeginCreateOrUpdate(context.Context, string, string, string, CustomDomain, *CustomDomainsClientBeginCreateOrUpdateOptions) (*runtime.Poller[CustomDomainsClientCreateOrUpdateResponse], error)`
      info	[Changelog] - New function `*CustomDomainsClient.BeginDelete(context.Context, string, string, string, *CustomDomainsClientBeginDeleteOptions) (*runtime.Poller[CustomDomainsClientDeleteResponse], error)`
      info	[Changelog] - New function `*CustomDomainsClient.Get(context.Context, string, string, string, *CustomDomainsClientGetOptions) (CustomDomainsClientGetResponse, error)`
      info	[Changelog] - New function `*CustomDomainsClient.NewListPager(string, string, *CustomDomainsClientListOptions) *runtime.Pager[CustomDomainsClientListResponse]`
      info	[Changelog] - New function `*EventHubEndpoint.GetEventListenerEndpoint() *EventListenerEndpoint`
      info	[Changelog] - New function `*EventListenerEndpoint.GetEventListenerEndpoint() *EventListenerEndpoint`
      info	[Changelog] - New function `*EventListenerFilter.GetEventListenerFilter() *EventListenerFilter`
      info	[Changelog] - New function `*EventNameFilter.GetEventListenerFilter() *EventListenerFilter`
      info	[Changelog] - New struct `CustomCertificate`
      info	[Changelog] - New struct `CustomCertificateList`
      info	[Changelog] - New struct `CustomCertificateProperties`
      info	[Changelog] - New struct `CustomCertificatesClient`
      info	[Changelog] - New struct `CustomDomain`
      info	[Changelog] - New struct `CustomDomainList`
      info	[Changelog] - New struct `CustomDomainProperties`
      info	[Changelog] - New struct `CustomDomainsClient`
      info	[Changelog] - New struct `EventHubEndpoint`
      info	[Changelog] - New struct `EventListener`
      info	[Changelog] - New struct `EventNameFilter`
      info	[Changelog] - New struct `ResourceReference`
      info	[Changelog] - New field `EventListeners` in struct `HubProperties`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 45 additive change(s).
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from b92e9b3. 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
    • ️✔️signalr [View full logs]  [Release Schema Changes]
    • ️✔️webpubsub [View full logs]  [Release Schema Changes]
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 17, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/signalr/armsignalr https://apiview.dev/Assemblies/Review/9de627891e0d44fbadc8de9febce511e
    Go sdk/resourcemanager/webpubsub/armwebpubsub https://apiview.dev/Assemblies/Review/4942bee9464d4066aa41cc430c0a39f4
    Java azure-resourcemanager-signalr https://apiview.dev/Assemblies/Review/349c4d26fc8b4e299c2b091ddebc44e2
    Java azure-resourcemanager-webpubsub https://apiview.dev/Assemblies/Review/2ced306aaf78401ca36501173f01df58
    .Net Azure.ResourceManager.SignalR https://apiview.dev/Assemblies/Review/03bff988046743079e641355c81e08ba
    .Net Azure.ResourceManager.WebPubSub There is no API change compared with the previous version
    JavaScript @azure/arm-signalr There is no API change compared with the previous version
    JavaScript @azure/arm-webpubsub There is no API change compared with the previous version

    @openapi-workflow-bot
    Copy link

    Hi @juniwang, 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.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @openapi-workflow-bot
    Copy link

    Hi @juniwang, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @openapi-workflow-bot
    Copy link

    Hi, @juniwang, 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. Or you could onboard API spec pipeline

    @leniatgh
    Copy link
    Contributor

    @ruowan please help check if the MISSING_APIS_IN_DEFAULT_TAG errors can be ignored, as it seems caused by changing signalR cases in path.

    @juniwang juniwang removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 21, 2023
    @juniwang
    Copy link
    Contributor Author

    Hi, do we need to fix the Swagger ApiDocPreview failure? Looks like it's not Required.

    @juniwang
    Copy link
    Contributor Author

    juniwang commented Mar 1, 2023

    can one of the admins approve the request?

    @leniatgh leniatgh added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label Mar 1, 2023
    @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 1, 2023
    @openapi-workflow-bot
    Copy link

    Hi, @juniwang your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).

    @pilor pilor 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 2, 2023
    @leniatgh
    Copy link
    Contributor

    leniatgh commented Mar 3, 2023

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @leniatgh leniatgh added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label Mar 3, 2023
    @leniatgh leniatgh merged commit b92e9b3 into Azure:main Mar 3, 2023
    This was referenced Mar 3, 2023
    aviyerMSFT pushed a commit to aviyerMSFT/azure-rest-api-specs that referenced this pull request Mar 22, 2023
    * copy from existing api-version before adding new one
    
    * add new api-version 2023-02-01
    
    * remove minLength
    
    * add back minLength
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-Avocado Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-FixRequiredOnFailure 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.

    5 participants