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

[Hub Generated] Review request for Microsoft.Communication to add version preview/2023-06-01-preview #26638

Conversation

matthohn-msft
Copy link
Member

@matthohn-msft matthohn-msft commented Nov 9, 2023

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

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).
  • 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:
    • Updating default version in the readme.md file for SDK generation.

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.

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
Swagger-Suppression-Process
to get approval.

Getting help

Copy link

openapi-pipeline-app bot commented Nov 9, 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).

Copy link

openapi-pipeline-app bot commented Nov 9, 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.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
compared tags (via openapi-validator v2.1.6) new version base version
default default(f9dca77) default(main)
️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
Rule Message
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /providers/Microsoft.Communication/locations/{}/operationStatuses/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/communication/resource-manager/readme.md
json: Microsoft.Communication/preview/2020-08-20-preview/CommunicationService.json
️️✔️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?

Copy link

openapi-pipeline-app bot commented Nov 9, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]
️❌SDK Breaking Change Tracking failed [Detail]

Breaking Changes Tracking


azure-sdk-for-go - sdk/resourcemanager/communication/armcommunication - Approved - 2.1.0-beta.2
+	Function `*timeRFC3339.Parse` has been removed
+	Function `*timeRFC3339.UnmarshalText` has been removed
+	Function `timeRFC3339.MarshalText` has been removed

️❌ azure-sdk-for-net-track2 failed [Detail]
  • Failed [Logs]Release - Generate from ed825a1. SDK Automation 14.0.0
    command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
    command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 714 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk. exit code: False
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:807
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 807 | �[0m … rtifacts += �[36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mCannot find path
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1mit does not exist.
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:714
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 714 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk artifact
    cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
  • Azure.ResourceManager.Communication [View full logs]  [Release SDK Changes]
    info	[Changelog]
️⚠️ azure-sdk-for-python-track2 warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from ed825a1. 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] npm notice
    cmderr	[automation_generate.sh] npm notice New major version of npm available! 9.8.1 -> 10.2.3
    cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v10.2.3>
    cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@10.2.3` to update!
    cmderr	[automation_generate.sh] npm notice
  • ️✔️track2_azure-mgmt-communication [View full logs]  [Release SDK Changes]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog]   - Added operation group SuppressionListAddressesOperations
    info	[Changelog]   - Added operation group SuppressionListsOperations
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from ed825a1. 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/communication/armcommunication [View full logs]  [Release SDK Changes] Breaking Change Detected
    info	[Changelog] ### Breaking Changes
    info	[Changelog]
    info	[Changelog] - Function `timeRFC3339.MarshalText` has been removed
    info	[Changelog] - Function `*timeRFC3339.Parse` has been removed
    info	[Changelog] - Function `*timeRFC3339.UnmarshalText` has been removed
    info	[Changelog]
    info	[Changelog] ### Features Added
    info	[Changelog]
    info	[Changelog] - New function `*ClientFactory.NewSuppressionListAddressesClient() *SuppressionListAddressesClient`
    info	[Changelog] - New function `*ClientFactory.NewSuppressionListsClient() *SuppressionListsClient`
    info	[Changelog] - New function `NewSuppressionListAddressesClient(string, azcore.TokenCredential, *arm.ClientOptions) (*SuppressionListAddressesClient, error)`
    info	[Changelog] - New function `*SuppressionListAddressesClient.CreateOrUpdate(context.Context, string, string, string, string, string, SuppressionListAddressResource, *SuppressionListAddressesClientCreateOrUpdateOptions) (SuppressionListAddressesClientCreateOrUpdateResponse, error)`
    info	[Changelog] - New function `*SuppressionListAddressesClient.Delete(context.Context, string, string, string, string, string, *SuppressionListAddressesClientDeleteOptions) (SuppressionListAddressesClientDeleteResponse, error)`
    info	[Changelog] - New function `*SuppressionListAddressesClient.Get(context.Context, string, string, string, string, string, *SuppressionListAddressesClientGetOptions) (SuppressionListAddressesClientGetResponse, error)`
    info	[Changelog] - New function `*SuppressionListAddressesClient.NewListPager(string, string, string, string, *SuppressionListAddressesClientListOptions) *runtime.Pager[SuppressionListAddressesClientListResponse]`
    info	[Changelog] - New function `NewSuppressionListsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*SuppressionListsClient, error)`
    info	[Changelog] - New function `*SuppressionListsClient.CreateOrUpdate(context.Context, string, string, string, string, SuppressionListResource, *SuppressionListsClientCreateOrUpdateOptions) (SuppressionListsClientCreateOrUpdateResponse, error)`
    info	[Changelog] - New function `*SuppressionListsClient.Delete(context.Context, string, string, string, string, *SuppressionListsClientDeleteOptions) (SuppressionListsClientDeleteResponse, error)`
    info	[Changelog] - New function `*SuppressionListsClient.Get(context.Context, string, string, string, string, *SuppressionListsClientGetOptions) (SuppressionListsClientGetResponse, error)`
    info	[Changelog] - New function `*SuppressionListsClient.NewListByDomainPager(string, string, string, *SuppressionListsClientListByDomainOptions) *runtime.Pager[SuppressionListsClientListByDomainResponse]`
    info	[Changelog] - New function `dateTimeRFC3339.MarshalText() ([]byte, error)`
    info	[Changelog] - New function `*dateTimeRFC3339.Parse(string) error`
    info	[Changelog] - New function `*dateTimeRFC3339.UnmarshalText([]byte) error`
    info	[Changelog] - New struct `SuppressionListAddressProperties`
    info	[Changelog] - New struct `SuppressionListAddressResource`
    info	[Changelog] - New struct `SuppressionListAddressResourceCollection`
    info	[Changelog] - New struct `SuppressionListProperties`
    info	[Changelog] - New struct `SuppressionListResource`
    info	[Changelog] - New struct `SuppressionListResourceCollection`
    info	[Changelog]
    info	[Changelog] Total 3 breaking change(s), 27 additive change(s).
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded [Logs]Release - Generate from ed825a1. 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-communication [View full logs]  [Release SDK Changes]
    info	[Changelog] **Features**
    info	[Changelog]
    info	[Changelog]   - Added operation group SuppressionListAddresses
    info	[Changelog]   - Added operation group SuppressionLists
    info	[Changelog]   - Added Interface ManagedServiceIdentity
    info	[Changelog]   - Added Interface SuppressionListAddressesCreateOrUpdateOptionalParams
    info	[Changelog]   - Added Interface SuppressionListAddressesDeleteOptionalParams
    info	[Changelog]   - Added Interface SuppressionListAddressesGetOptionalParams
    info	[Changelog]   - Added Interface SuppressionListAddressesListNextOptionalParams
    info	[Changelog]   - Added Interface SuppressionListAddressesListOptionalParams
    info	[Changelog]   - Added Interface SuppressionListAddressResource
    info	[Changelog]   - Added Interface SuppressionListAddressResourceCollection
    info	[Changelog]   - Added Interface SuppressionListResource
    info	[Changelog]   - Added Interface SuppressionListResourceCollection
    info	[Changelog]   - Added Interface SuppressionListsCreateOrUpdateOptionalParams
    info	[Changelog]   - Added Interface SuppressionListsDeleteOptionalParams
    info	[Changelog]   - Added Interface SuppressionListsGetOptionalParams
    info	[Changelog]   - Added Interface SuppressionListsListByDomainNextOptionalParams
    info	[Changelog]   - Added Interface SuppressionListsListByDomainOptionalParams
    info	[Changelog]   - Added Interface UserAssignedIdentity
    info	[Changelog]   - Added Type Alias ManagedServiceIdentityType
    info	[Changelog]   - Added Type Alias SuppressionListAddressesCreateOrUpdateResponse
    info	[Changelog]   - Added Type Alias SuppressionListAddressesGetResponse
    info	[Changelog]   - Added Type Alias SuppressionListAddressesListNextResponse
    info	[Changelog]   - Added Type Alias SuppressionListAddressesListResponse
    info	[Changelog]   - Added Type Alias SuppressionListsCreateOrUpdateResponse
    info	[Changelog]   - Added Type Alias SuppressionListsGetResponse
    info	[Changelog]   - Added Type Alias SuppressionListsListByDomainNextResponse
    info	[Changelog]   - Added Type Alias SuppressionListsListByDomainResponse
    info	[Changelog]   - Interface CommunicationServiceResource has a new optional parameter identity
    info	[Changelog]   - Interface CommunicationServiceResourceUpdate has a new optional parameter identity
    info	[Changelog]   - Added Enum KnownManagedServiceIdentityType
️⚠️ azure-sdk-for-java warning [Detail]
  • ⚠️Warning [Logs]Release - Generate from ed825a1. 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 -> 23.3.1
    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 -> 23.3.1
    cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-communication [View full logs]  [Release SDK Changes]
️❌ azure-powershell failed [Detail]
  • Pipeline Framework Failed [Logs]Release - Generate from ed825a1. 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.communication.DefaultTag [View full logs
    error	Fatal error: SSL error: syscall failure: Broken pipe
    error	The following packages are still pending:
    error		Az.communication.DefaultTag
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Nov 9, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/communication/armcommunication https://apiview.dev/Assemblies/Review/271612bc207649c2a2a771a6b8bb038c
Java azure-resourcemanager-communication https://apiview.dev/Assemblies/Review/0359d13faf8545459bb93fd896d6e3cd
JavaScript @azure/arm-communication https://apiview.dev/Assemblies/Review/9f65b474c58b4cb49ac9725eae0ecfdd

@matthohn-msft matthohn-msft marked this pull request as ready for review November 9, 2023 22:18
@AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Nov 9, 2023
@zizw123 zizw123 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Nov 10, 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 Nov 10, 2023
@ChenxiJiang333
Copy link
Member

Update global tag for SDK generation.

@Alancere Alancere added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Nov 14, 2023
@ChenxiJiang333 ChenxiJiang333 merged commit ed825a1 into main Nov 15, 2023
27 of 31 checks passed
@ChenxiJiang333 ChenxiJiang333 deleted the matthohn-msft-communication-Microsoft.Communication-2023-06-01-preview-readme branch November 15, 2023 08:45
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go resource-manager RPaaS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants